Closed Bug 1314405 Opened 9 years ago Closed 8 years ago

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

Categories

(Developer Infrastructure :: Lint and Formatting, defect)

defect
Not set
normal

Tracking

(firefox55 fixed)

RESOLVED FIXED
mozilla55
Tracking Status
firefox55 --- fixed

People

(Reporter: pdehaan, Assigned: standard8)

References

Details

Attachments

(1 file)

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.
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
Component: Developer Tools → Lint
Product: Firefox → Testing
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.
Blocks: 1305527
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.
Assignee: nobody → standard8
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?
(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 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
Attachment #8845368 - Flags: review?(dtownsend) → review+
Pushed by mbanner@mozilla.com: 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
Status: NEW → RESOLVED
Closed: 8 years ago
Resolution: --- → FIXED
Target Milestone: --- → mozilla55
Product: Testing → Firefox Build System
Product: Firefox Build System → Developer Infrastructure
You need to log in before you can comment on or make changes to this bug.

Attachment

General

Created:
Updated:
Size: