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

chore: Add documentation validation tool #531

Merged
merged 4 commits into from May 16, 2019

Conversation

Projects
None yet
2 participants
@bradzacher
Copy link
Member

commented May 15, 2019

Should wait on the rule barrel introduced in #313

Adds a script to validate:

The plugin docs:

  • ensures every rule has a doc in the docs folder.

The root readme:

  • ensures the rule table has the correct sorting
  • ensures every non-deprecated rule has a row in the table
  • ensures every row matches the rule's meta definition
@JamesHenry
Copy link
Member

left a comment

I don't see you calling this out in your description - why did your remove all the connections to TSLint rules?

@bradzacher

This comment has been minimized.

Copy link
Member Author

commented May 15, 2019

I didn't see the point in specifically tracking that within the rule metadata when we have the ROADMAP.md which comprehensively lists it all.

Also half of them weren't working correctly because they used the wrong property name (and TS ignored that)

@JamesHenry

This comment has been minimized.

Copy link
Member

commented May 15, 2019

Ok cool, because you hadn't called it out I was mainly checking you hadn't done it by accident

@bradzacher bradzacher merged commit 4edf0d7 into master May 16, 2019

8 checks passed

Semantic Pull Request ready to be squashed
Details
codecov/patch Coverage not affected when comparing c480eab...c173972
Details
codecov/project 94.23% (+0.02%) compared to c480eab
Details
typescript-eslint.typescript-eslint Build #20190516.12 succeeded
Details
typescript-eslint.typescript-eslint (Primary code validation and tests) Primary code validation and tests succeeded
Details
typescript-eslint.typescript-eslint (Run unit tests on other Node.js versions node_10_x) Run unit tests on other Node.js versions node_10_x succeeded
Details
typescript-eslint.typescript-eslint (Run unit tests on other Node.js versions node_6_x) Run unit tests on other Node.js versions node_6_x succeeded
Details
typescript-eslint.typescript-eslint (Run unit tests on other Node.js versions node_8_x) Run unit tests on other Node.js versions node_8_x succeeded
Details

@bradzacher bradzacher deleted the validate-docs branch May 16, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.