Docs: improve document's header #142
Conversation
|
I added internal rules which are mostly same as eslint/lib/internal-rules to be consistent of rule descriptions. |
lib/rules/jsx-uses-vars.js
Outdated
| @@ -37,7 +37,7 @@ SOFTWARE. | |||
| module.exports = { | |||
| meta: { | |||
| docs: { | |||
| description: 'Prevent variables used in JSX to be marked as unused', | |||
| description: 'prevent variables used in JSX to be marked as unused.', // eslint-disable-line consistent-docs-description | |||
There was a problem hiding this comment.
Why do you disable consistent-docs-description rule on this line? Can't you remove the dot?
There was a problem hiding this comment.
Because it does not fit to descriptions which start with one of enforce, require and disallow. The consistent-docs-description rule which is cloned from eslint repo enforces the first word of the description.
lib/rules/no-duplicate-attributes.js
Outdated
| @@ -90,7 +90,7 @@ module.exports = { | |||
| create, | |||
| meta: { | |||
| docs: { | |||
| description: 'disallow duplicate attributes.', | |||
| description: 'disallow duplicate attributes', | |||
There was a problem hiding this comment.
To be consistent we should call it: disallow duplication of attributes
lib/rules/no-reservered-keys.js
Outdated
| @@ -49,7 +49,7 @@ function create (context) { | |||
| module.exports = { | |||
| meta: { | |||
| docs: { | |||
| description: 'Prevent overwrite reserved keys.', | |||
| description: 'disallow overwrite reserved keys', | |||
There was a problem hiding this comment.
disallow overwriting reserved keys
tools/update-rules.js
Outdated
| @@ -110,3 +110,21 @@ fs.writeFileSync( | |||
| recommendedRulesFile, | |||
| recommendedRulesContent | |||
| ) | |||
|
|
|||
| // Update the header of rule documents. | |||
| const headerPattern = /^#[^\n]*\n+(?:- .+\n)*\n*/ | |||
There was a problem hiding this comment.
I'd add a block comment here with example .md that matches this pattern.
|
Hey @mysticatea would you mind to update this PR? Then we could push this forward, should be quick to resolve my suggestions :) |
|
Oops, I'm sorry, I have lost this from my brain. I will do. |
# Conflicts: # README.md
This PR improves the header of rule documents.
npm run updategenerates the headers from rule's meta data.