Docs needed for negated custom options
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 2k
- Forks
- 97
- PR merge metrics
- No merged PRs in 30d
Description
Lets say we have the following file
const { task, option, logger, argv } = require('just-task');
const { spawn } = require('child_process');
option('no-cache', { default: false });
task('sayhello', function() {
logger.info(argv());
});
and we were to run npx just sayhello --no-cache, we will got the following result
[4:17:16 PM] ■ started 'sayhello'
[4:17:16 PM] ■ { _: [ 'sayhello' ],
cache: false,
'no-cache': false,
noCache: false,
'$0': 'node_modules/.bin/just' }
[4:17:16 PM] ■ finished 'sayhello' in 0.01s
if we instead run with npx just sayhello --noCache, it will then registers
[4:20:01 PM] ■ started 'sayhello'
[4:20:01 PM] ■ { _: [ 'sayhello' ],
noCache: true,
'no-cache': true,
'$0': 'node_modules/.bin/just' }
[4:20:01 PM] ■ finished 'sayhello' in 0.01s
It seems this is coming from yargs parser on this issue https://github.com/yargs/yargs-parser/issues/92 which since have been solved in the current version.
Would there be plan to update the yargs dependency in the project to the current version?
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 by reviewing the custom option and argv documentation or entry points in just-task, then check the yargs-parser issue and dependency version referenced in the report. Done means the behavior of negated custom options is clearly documented and the requested dependency-update question is addressed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, typescript
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100