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

Repo tooling: add testing to ensure each rule has a corresponding .md #903

Closed
JoshuaKGoldberg opened this issue Oct 27, 2022 · 3 comments · Fixed by #901
Closed

Repo tooling: add testing to ensure each rule has a corresponding .md #903

JoshuaKGoldberg opened this issue Oct 27, 2022 · 3 comments · Fixed by #901

Comments

@JoshuaKGoldberg
Copy link
Contributor

JoshuaKGoldberg commented Oct 27, 2022

Following the thread from #833 (comment): it'd be great to have testing make sure each rule is documented. In typescript-eslint we make sure rule docs exist at a certain path and follow a certain format (typescript-eslint > docs.test.ts).

I'm up for contributing this if you'd like it!

@ljharb
Copy link
Member

ljharb commented Oct 27, 2022

I agree, and yes that’d be great - although it’s possible that #901 might provide this already. @bmish?

@bmish
Copy link
Contributor

bmish commented Oct 27, 2022

Yes, since eslint-doc-generator checks all rule docs, it will already fail when a rule doc is missing.

@JoshuaKGoldberg
Copy link
Contributor Author

Nice, love it!

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 a pull request may close this issue.

3 participants