liquid-labs / liquid-labs/command-line-documentation
Implement 'usage' support
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 0
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
## Overview
We want to be able to provide 'usage' output from the same library. This would replace 'command-line-usage'. To make this work, we want to be able to support 'chalk' and 'terminal-text' style outputs.
- we watn to support terminal coloring via chalk style markups
- accept markdown and chalk text blocks (summaries and descriptions) and convert between them
- use same set format (this differs from 'command-line-usage' which requires you define the sections.
## Deliverables
- [ ] implement `commandLineUsage()`
Contributor guide
No contributing guide indexed for this repository
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 requested commandLineUsage() entry point and review how the library currently formats command-line output. Done means supporting chalk-style terminal coloring, converting markdown and chalk text blocks, using the same set format, and replacing command-line-usage.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- cli
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100