puppetlabs / puppetlabs/puppet-strings
Warnings as Errors
Open
Nobody has claimed this yet.
feature
- Dominant language
- Ruby
- Stars
- 90
- Forks
- 90
- PR merge metrics
- No merged PRs in 30d
Description
Use Case
I'd like to make sure that I can run puppet-strings as a way to lint if we aren't correctly documenting our puppet module.
Describe the Solution You Would Like
I'd like to have a --warnings-as-errors cli option that will make puppet-strings exit with a code other than 0 when a warning happens.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Find the CLI option parser and the path that reports warnings, then inspect how the process exit status is currently chosen. Add the requested option so warning output produces a nonzero exit code when enabled, and verify both enabled and default behavior with the existing test suite.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- cli
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 50/100