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

Consider unified option for controlling what features are required #488

Open
bmish opened this issue Oct 15, 2023 · 0 comments
Open

Consider unified option for controlling what features are required #488

bmish opened this issue Oct 15, 2023 · 0 comments
Labels
enhancement New feature or request
Milestone

Comments

@bmish
Copy link
Owner

bmish commented Oct 15, 2023

Now that we provide the following features:

  • README.md rules table
  • README.md configs table
  • Rule doc titles and notices
  • Rule doc options lists

We may need to offer an option to control which are mandatory (i.e. exit with failure if missing) or automatically-inserted when missing.

And we will likely want to require all or most of these features as a breaking change in a future major release.

There's an existing --rule-doc-section-options option that controls whether this section is required but doesn't control whether the auto-generated options list in it is required.

@bmish bmish added the enhancement New feature or request label Oct 15, 2023
@bmish bmish added this to the v2.0.0 milestone Nov 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant