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
Merged

chore: Add documentation validation tool #531

merged 4 commits into from May 16, 2019

Conversation

bradzacher
Copy link
Member

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

@bradzacher bradzacher added enhancement New feature or request blocked by another PR PRs which are ready to go but waiting on another PR labels May 15, 2019
Copy link
Member

@JamesHenry JamesHenry left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@bradzacher
Copy link
Member Author

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
Copy link
Member

JamesHenry commented May 15, 2019

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

JamesHenry
JamesHenry previously approved these changes May 15, 2019
@bradzacher bradzacher removed the blocked by another PR PRs which are ready to go but waiting on another PR label May 16, 2019
@bradzacher bradzacher merged commit 4edf0d7 into master May 16, 2019
@bradzacher bradzacher deleted the validate-docs branch May 16, 2019 04:28
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 21, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants