1314405 - Need better README/docs for npm for eslint-plugin-mozilla

Status: RESOLVED FIXED

Description

[Peter deHaan [:pdehaan]]

Recently it looks like something changed and broke our ESLint (see https://github.com/mozilla/activity-stream/issues/1687).

Looking at the https://www.npmjs.com/package/eslint-plugin-mozilla page doesn't give any real useful information (like repo, rules, etc).

https://pageshot.net/46rrU7wdMfFiSOR3/www.npmjs.com

It'd be nice if there was a public README or something on npm so it's easier to see what's changed and what the current rules are.

Comment 1

[Ed Lee :Mardak (PTO Oct 27 - Nov 18)]

Additionally, the latest readthedocs seems to imply the rules for "components-imports" etc still exist:

http://gecko.readthedocs.io/en/latest/tools/lint/linters/eslint-plugin-mozilla.html

Comment 2

[J. Ryan Stinnett [:jryans]]

A related issue I guess is that there is no standard process for publishing update to npm.  Inside of m-c, the source is used directly as-is and npm is not used for the Mozilla plugin, but external process would (I assume) want changes via npm.

Comment 3

[Mark Banner (:standard8)]

Created attachment 8845368 [details]
Bug 1314405 - Provide a readme for eslint-plugin-mozilla, and add some more details to its package.json.

Review commit: https://reviewboard.mozilla.org/r/118570/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/118570/

Comment 4

[Mark Banner (:standard8)]

I've added a readme & package.json in the patch. In bug 1305527 I'm going to look at getting it updated, and then work out about regular updates later.

Comment 5

[Dave Townsend [:mossop] (he/him)]

Comment on attachment 8845368 [details]
Bug 1314405 - Provide a readme for eslint-plugin-mozilla, and add some more details to its package.json.

https://reviewboard.mozilla.org/r/118570/#review120612

::: tools/lint/eslint/eslint-plugin-mozilla/README.md:27
(Diff revision 1)
> +```
> +
> +Next, install `eslint-plugin-mozilla`:
> +
> +```
> +$ npm install eslint-plugin-mozilla --save-dev

Do we actually publish this to npm?

Comment 6

[Mark Banner (:standard8)]

(In reply to Dave Townsend [:mossop] from comment #5)
> ::: tools/lint/eslint/eslint-plugin-mozilla/README.md:27
> (Diff revision 1)
> > +```
> > +
> > +Next, install `eslint-plugin-mozilla`:
> > +
> > +```
> > +$ npm install eslint-plugin-mozilla --save-dev
> 
> Do we actually publish this to npm?

Yes: https://www.npmjs.com/package/eslint-plugin-mozilla

It is a little out of date, but I'm going to be updating it. Devtools uses it for a few things, and I'm looking at using it for the one-off-system-addons repo.

Comment 7

[Dave Townsend [:mossop] (he/him)]

Comment on attachment 8845368 [details]
Bug 1314405 - Provide a readme for eslint-plugin-mozilla, and add some more details to its package.json.

https://reviewboard.mozilla.org/r/118570/#review120620

Comment 8

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/00beed695243
Provide a readme for eslint-plugin-mozilla, and add some more details to its package.json. r=mossop

Comment 9

[Wes Kocher (:KWierso)]

https://hg.mozilla.org/mozilla-central/rev/00beed695243