fix: add rule documentation #91
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
macklinu
force-pushed
the
rule-documentation
branch
2 times, most recently
from
a83cde9 to
03b1872
Compare
Resolves #61
macklinu
force-pushed
the
rule-documentation
branch
from
03b1872 to
c68993c
Compare
macklinu
added a commit
to macklinu/eslint-rule-documentation
that referenced
this pull request
Feb 8, 2018
macklinu
added a commit
to macklinu/eslint-rule-documentation
that referenced
this pull request
Feb 8, 2018
Note that this is the same as saying you have ESLint installed twice, since Standard is just a wrapper around ESLint with a predefined config 😉. You can base your ESLint configuration on |
This was referenced Mar 19, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #61
First step of this PR was converting each rule to export an object instead of a function using eslint-transforms, specifically the new-format-rule transform. I ran the following command.
$ npx eslint-transforms new-rule-format rules/*.jsI edited a few rules manually to add the
meta.docs.urlobject, but after that I installed eslint-plugin-eslint-plugin and enabled the require-meta-docs-url rule in therules/directory. By runningnpm run lint -- --fixfrom the root of the repo, all rules now have a validmeta.docs.urlthat points to the proper documentation section of the README.The Travis script has been updated to run this lint command. Now that this repo has Standard and ESLint installed, there are two tools that lint the codebase. I'm wondering if down the line we use a tool like Prettier for code formatting and then rely solely on ESLint for linting the codebase. 🤔 (That's for another issue/PR.)