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

Process fails with --init-rule-docs when no docs need to be created #494

Open
TheSonOfThomp opened this issue Oct 27, 2023 · 1 comment
Open
Labels
bug Something isn't working

Comments

@TheSonOfThomp
Copy link

TheSonOfThomp commented Oct 27, 2023

Running eslint-doc-generator --init-rule-docs will exit with the following error if no docs need to be created. I would expect this to be skipped in the case where nothing needs to be created.

$ eslint-doc-generator --init-rule-docs
--init-rule-docs was enabled, but no rule doc file needed to be created.
error Command failed with exit code 1.

My ideal workflow would be to always pass this flag in case there's been a rule that's been missed

@TheSonOfThomp TheSonOfThomp changed the title Process fails with --init-rule-docs when no docs need to be creates Process fails with --init-rule-docs when no docs need to be created Oct 27, 2023
@bmish bmish added the bug Something isn't working label Oct 27, 2023
@bmish
Copy link
Owner

bmish commented Oct 27, 2023

This is an interesting point. I hadn't considered that one might want to leave this option in place indefinitely. The original idea was that this option would only be used only temporarily when intentionally creating a new rule doc, but I'm open to removing the exception so it can be used permanently.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants