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.

Sign up for GitHub

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

Jump to bottom

🛠 Tooling: Add unit test that every option and/or piece of tooling is mentioned in docs #1124

Open
3 tasks done
JoshuaKGoldberg opened this issue Dec 29, 2023 · 2 comments
Open
3 tasks done

🛠 Tooling: Add unit test that every option and/or piece of tooling is mentioned in docs #1124

JoshuaKGoldberg opened this issue Dec 29, 2023 · 2 comments
Labels
area: testing Improving how the repository's tests are run and/or code is tested status: accepting prs Please, send a pull request to resolve this!

Comments

@JoshuaKGoldberg
Copy link
Owner

Bug Report Checklist

  • I have tried restarting my IDE and the issue persists.
  • I have pulled the latest main branch of the repository.
  • I have searched for related issues and found none that matched my issue.

Overview

This template has options added once in a while. Each should be mentioned in docs/Options.md so users can learn about them.

But, right now, nothing enforces those options get documented in docs/Options.md. So we get bugs like #1123.

Proposal: how about a src/docs.test.ts or something like that which:

  1. Reads in the text of docs/Options.md
  2. Ensures that, for each option as described by optionsSchema.ts, there's a mention

Additional Info

No response
@JoshuaKGoldberg JoshuaKGoldberg added status: accepting prs Please, send a pull request to resolve this! area: testing Improving how the repository's tests are run and/or code is tested labels Dec 29, 2023
@JoshuaKGoldberg
Copy link
Owner Author

Now that I'm moving everything to create (#1824) this is roughly aged away. It'll be done automatically when I make a full website (#1193).

@JoshuaKGoldberg JoshuaKGoldberg closed this as not planned Won't fix, can't repro, duplicate, stale Jan 7, 2025
@JoshuaKGoldberg
Copy link
Owner Author

Or, actually, you know what, no. I'm going to do this now. Tooling.md -soon to be Presets.md has a lot of info that I'll want to keep in sync.

@JoshuaKGoldberg JoshuaKGoldberg changed the title 🛠 Tooling: Add unit test that every option is mentioned in Options.md 🛠 Tooling: Add unit test that every option and/or piece of tooling is mentioned in docs Jan 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area: testing Improving how the repository's tests are run and/or code is tested status: accepting prs Please, send a pull request to resolve this!
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@JoshuaKGoldberg