rust-cli / rust-cli/env_logger
Handle hyphens internally
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 1.1k
- Forks
- 149
- Avg merge
- 2h 42m
- Merged PRs (30d)
- 4
Description
With PR #77 a note about dashes in the crate name was added in the docs. The note was of course an essential addition.
I propose going a step further and handling the dashes internally, during the parsing (parse_spec() function).
I believe this addition will save people time trying to debug the reason that the logging does not work as expected.
I myself lost some time on this, even though I had read the docs, and I had read about the need to replace the dashes.
I would also have provided a PR too, but currently I am failing to build the library (see https://github.com/env-logger-rs/env_logger/issues/190#issuecomment-812988592).
Is there a valid reason for not handling the dashes internally?
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
Start with the parse_spec() function mentioned in the issue and review the existing documentation note from PR #77 about dashes in crate names. Check the build problem referenced in issue #190 before investigating the change. Done means internally handling hyphens so users do not need to replace them manually and logging works as expected.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100