Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: add rule documentation #91

Merged
merged 1 commit into from
Feb 8, 2018
Merged

fix: add rule documentation #91

merged 1 commit into from
Feb 8, 2018

Conversation

macklinu
Copy link
Contributor

@macklinu macklinu commented Feb 7, 2018

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/*.js

I edited a few rules manually to add the meta.docs.url object, but after that I installed eslint-plugin-eslint-plugin and enabled the require-meta-docs-url rule in the rules/ directory. By running npm run lint -- --fix from the root of the repo, all rules now have a valid meta.docs.url that 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.)

@macklinu macklinu force-pushed the rule-documentation branch 2 times, most recently from a83cde9 to 03b1872 Compare February 7, 2018 22:01
@macklinu macklinu merged commit d74d879 into master Feb 8, 2018
@macklinu macklinu deleted the rule-documentation branch February 8, 2018 15:09
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
@Arcanemagus
Copy link

Now that this repo has Standard and ESLint installed

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 eslint-config-standard to get the same effect.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Broken rule documentation links
2 participants