Web3Swift icon indicating copy to clipboard operation
Web3Swift copied to clipboard

Missing linter rules for prohibiting object naming ending with ER

Open abdulowork opened this issue 7 years ago • 14 comments

We should have a linter rule to prevent creating objects that end with ER. This will encourage contributors to think OODD.

abdulowork avatar Feb 21 '18 12:02 abdulowork

The job #45 assigned to @biboran/z, here is why. The budget is 30 minutes, see §4. Please, read §8 and §9. If the task is not clear, read this and this.

0crat avatar Feb 21 '18 12:02 0crat

Bug was reported, see §29: +15 points just awarded to @biboran/z, total is +120

0crat avatar Feb 21 '18 12:02 0crat

Manual assignment of issues is discouraged, see §19: -5 points just awarded to @biboran/z, total is +120

0crat avatar Feb 21 '18 12:02 0crat

It is strongly discouraged to assign jobs to their creators, see §19: -15 points just awarded to @biboran/z, total is +120

0crat avatar Feb 21 '18 12:02 0crat

So after some poking around it seems like it would be easier to specify prohibited "er" words rather than prohibit all "er" words and to specify exceptions.

I think it would be a better idea to develop a dictionary of prohibited terms.

abdulowork avatar Feb 21 '18 14:02 abdulowork

@biboran I believe that we should create a custom SwiftLint rule for that. (-ER, not that dictionary solution)

driver733 avatar Feb 21 '18 22:02 driver733

@driver733 I already tried and what comes up is there are too many words that end with ER and OR that are not problematic. For example Parameter.

Even qulice doesn't have such a rule as far as I know: https://github.com/teamed/qulice/issues/109

I see blacklist as the only solution

abdulowork avatar Feb 24 '18 10:02 abdulowork

@biboran Let's then keep it as part of the code review process.

driver733 avatar Feb 24 '18 16:02 driver733

@biboran/z this job was assigned to you 5 days ago. It will be taken away from you soon, unless you close it, see §8. Read this and this, please.

0crat avatar Feb 26 '18 12:02 0crat

@biboran/z this job was assigned to you 8 days ago. It will be taken away from you soon, unless you close it, see §8. Read this and this, please.

0crat avatar Mar 01 '18 12:03 0crat

@0crat refuse

abdulowork avatar Mar 01 '18 12:03 abdulowork

@driver733 I think we should still come up with a blacklist for class names (and maybe parameter names). It can free up a lot of the reviews time.

abdulowork avatar Mar 01 '18 12:03 abdulowork

@0crat refuse (here)

@biboran The user @biboran/z resigned from #45, please stop working. Reason for job resignation: Order was cancelled

0crat avatar Mar 01 '18 12:03 0crat

Tasks refusal is discouraged, see §6: -15 points just awarded to @biboran/z

0crat avatar Mar 01 '18 12:03 0crat