1218425 - ESLint rule that checks for aArgs in function parameters

Status: RESOLVED FIXED

(DevTools :: General, defect)

Description

[Patrick Brosset <:pbro>]

Our coding standards [1] warns against using aArgs, but we have plenty in our code already. An EsLint rule would be really simple to write and would help prevent adding more in the future.

[1] https://wiki.mozilla.org/DevTools/CodingStandards#Code_style

Comment 1

[Patrick Brosset <:pbro>]

Attachment: Bug_1218425_-_ESLint_rule_that_warns_against_aArg_.diff

This should work nicely. Still have to do some more tests, but a first review would help confirm this rule is wanted.

Comment 2

[Mike Ratcliffe [:miker] [:mratcliffe] [:mikeratcliffe]]

Comment on attachment 8678905 [details] [diff] [review]
Bug_1218425_-_ESLint_rule_that_warns_against_aArg_.diff

Review of attachment 8678905 [details] [diff] [review]:
-----------------------------------------------------------------

r+ with nits addressed

::: testing/eslint-plugin-mozilla/lib/rules/no-aArgs.js
@@ +19,5 @@
> +
> +  function isPrefixed(name) {
> +    return name.length >= 2 &&
> +           name.substring(0, 1) === "a" &&
> +           name.substring(1, 2).toUpperCase() === name.substring(1, 2);

It would be simpler to use:
return name.length >= 2 && /^a[A-Z]/.test(name);

@@ +24,5 @@
> +  }
> +
> +  function deHungarianize(name) {
> +    return name.substring(1, 2).toLowerCase() +
> +           name.substring(2, name.length);

It would be simpler to use:
return "aHello".substring(1).toLowerCase();

Comment 3

[Patrick Brosset <:pbro>]

(In reply to Michael Ratcliffe [:miker] [:mratcliffe] from comment #2)
> ::: testing/eslint-plugin-mozilla/lib/rules/no-aArgs.js
> @@ +19,5 @@
> > +
> > +  function isPrefixed(name) {
> > +    return name.length >= 2 &&
> > +           name.substring(0, 1) === "a" &&
> > +           name.substring(1, 2).toUpperCase() === name.substring(1, 2);
> 
> It would be simpler to use:
> return name.length >= 2 && /^a[A-Z]/.test(name);
Good point, I will change this.

> @@ +24,5 @@
> > +  }
> > +
> > +  function deHungarianize(name) {
> > +    return name.substring(1, 2).toLowerCase() +
> > +           name.substring(2, name.length);
> 
> It would be simpler to use:
> return "aHello".substring(1).toLowerCase();
This would change "aCamelCasedName" to "camelcasedname" which isn't what we want. So I think I need to keep the slightly more complex form.

Comment 4

[Patrick Brosset <:pbro>]

Built on top of bug 269836, so let's depend on it.

Comment 5

[Patrick Brosset <:pbro>]

Attachment: Bug_1218425_-_ESLint_rule_that_warns_against_aArg_.diff

Comment 6

[Pulsebot]

https://hg.mozilla.org/integration/fx-team/rev/f1cef30cb767

Comment 7

[Wes Kocher (:KWierso) (Not reading bugmail; email directly if needed)]

https://hg.mozilla.org/mozilla-central/rev/f1cef30cb767