lint: fix issues

[DavidGOrtega]

I open this issue to discuss CML's coding convention change and tasks needed to perform such change.

@0x2b3bfa0 @casperdcl @shcheklein

[DavidGOrtega]

This is also very unfriendly to review

[0x2b3bfa0]

It would be nice to have a parent issue in a higher-level repository — or a Slack thread^{[1, 2]} — to discuss this with the other project teams so all we follow the same conventions. In our case, the specifics probably boil down to these three points:

1. TypeScript or JavaScript
2. dromedaryCase or snake_case
3. Formatter and linter; see lint: prettier vs eslint setup-dvc#22

[DavidGOrtega]

@0x2b3bfa0 of course but this issue is also the issue where to review what we are going to do once we agree.

[casperdcl]

2 & 3. AFAIK everyone's agreed on camelCase. I'll fix the linter issues.

I think we can discuss 1. TS vs JS in a separate issue if needed

[casperdcl]

btw this yargs/yargs#1679 is annoyingly not fixed

[0x2b3bfa0]

By the way: do we agree on the definition of camel case? 😉

[casperdcl]

Yes, but beware that the example table is not complete (e.g. it doesn't properly show rule 3b with a properNounObjectName rather than a ProperNounClassName)

[0x2b3bfa0]

Renaming should be as easy (or as difficult) as taking a look to this list and applying the conversion rules above.

npx grasp --only-matching --no-filename --no-line-number 'ident' **/* |
grep --invert-match '[A-Z]' | grep '_' |
sort --unique

Roughly like this:

npx grasp --only-matching --no-filename --no-line-number 'ident' **/* |
grep '_' | grep -v '[A-Z]' | sort --unique |
while read identifier; do
  echo "$identifier => $(sed --regexp-extended 's/_([a-z])/\U\1/g' <<< "$identifier")"
done

[casperdcl]

No, it's a fair bit more involved than that but I'll open a PR soon.

[0x2b3bfa0]

Give as descriptive a name as possible, within reason. Do not worry about saving horizontal space as it is far more important to make your code immediately understandable by a new reader. Do not use abbreviations that are ambiguous or unfamiliar to readers outside your project, and do not abbreviate by deleting letters within a word.

That fair bit looks promising. 👀

[casperdcl]

lol that's about style which isn't currently tested so for a different issue/PR. In any case it's also self-inconsistent:

1. descriptive
2. within reason
3. no saving horizontal space if it reduces understandability, e.g. no ambiguous or unfamiliar abbrevs
4. [dumb, inconsistent rule] do not abbrev by removing letters in the middle of a word at all ever

Rule 4 can get lost because it's not always (2) within reason.