Lint JSON

[ddbeck]

This PR mostly fixes #10. It adds npm run lint-json. It gives output like this (though in your terminal you'll get some highlighting):

$ npm run lint-json

> mdn-short-descriptions@0.0.1 lint-json /Users/ddbeck/Code/Mozilla/short-descriptions/ddbeck-short-descriptions
> node test/lint-json.js

descriptions/css/properties/align-content.json: First sentence may be too long. Expected ≤150; got 186
descriptions/css/properties/align-content.json: > The CSS align-content property sets how the browser distributes space between and around content items along the cross-axis of a flexbox container, and the main-axis of a grid container.
descriptions/css/properties/align-content.json: Summary is too long. Expected ≤180 characters; got 186
descriptions/css/properties/align-content.json: > The CSS align-content property sets how the browser distributes space between and around content items along the cross-axis of a flexbox container, and the main-axis of a grid container.

Checked 30 descriptions.
29 descriptions passed all checks.
1 descriptions failed one or more checks:
  descriptions/css/properties/align-content.json

Additional notes:

• Since the checks against the JSON are the same as the checks I was running against the wiki text, this PR extracts the checks shared between lint-json and lint-short-descriptions into /test/linting-rules.js. This is probably slightly easier to follow if you step through the two commits in this PR.
• The linting rules themselves have some good and bad examples along with them. You can test that these examples work as expected by running node ./test/linting-rules.js.
• One JSON file doesn't pass the linter. I left this in since I figured it was a good demonstration of what the linter does. I can add a fix for that to this PR or open a separate PR.

Let me know what you think! Thanks!

[ddbeck]

I didn't find the naming of sourceRules intuitive. jsonFormatRules, maybe?

Yep, that's a good idea.

since contentRules and sourceRules don't seem to share much code, and given that "lint-short-descriptions" only uses contentRules, consider splitting "linting-rules" into two files?

Yeah that makes sense. Or maybe just move sourceRules (future jsonFormatRules) to lint-json.js. I'll play with this a little.

I found the wiki attribute in contentRules a bit weird. That is, I think of it as the choice of the application (i.e. "lint-short-descriptions") which rules it wants to use. So encoding that in the rules themselves seems like the wrong place. Instead perhaps "lint-short-descriptions" could contain an array containing the descriptions of the rules it wants to use?

Also a good idea. I'll give each rule a short identifier (like eslint rules) on which to filter.

also naming, but "lint-short-descriptions" is a bit confusing now that "lint-json" is also linting short descriptions. Perhaps "lint-wiki-summaries" or something?

👍

To do list:

• [x] Rename sourceRules to jsonFormatRules
• [x] Rename lint-short-descriptions to lint-wiki
• [x] Fail all attributes of forbidden tags
• [x] Get rid of the wiki rule property; add rule identifiers
• [x] Split up jsonFormatRules and contentRules

[ddbeck]

OK, fixes applied. I also changed package.json such that npm test will:

1. Lint the JS source
2. Run the tests for the linting rules
3. Run the linter against the JSON