Single dash passed as positional arg disappears
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 519
- Forks
- 129
- Avg merge
- 1h 34m
- Merged PRs (30d)
- 1
Description
This is with yargs v16.0.1.
Sample code in test.js:
const yargs = require('yargs/yargs')
const {hideBin} = require('yargs/helpers');
const argv = yargs(hideBin(process.argv))
.command('$0 <foo>', 'the default command', (yargs) => {
yargs
.positional('foo', {type: 'string', required: true})
}, (argv) => {
console.log(argv)
})
.argv
Test:
$ node test.js -
{ _: [], '$0': 'test.js', foo: '' }
$ node test.js a
{ _: [], '$0': 'test.js', foo: 'a' }
This is unfortunate, as using - as a filename to mean stdin or stdout is a common convention.
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 reproduction in test.js and run both node test.js - and node test.js a to confirm the differing positional values. Trace the yargs-parser handling of a lone dash, then add a regression test showing that - remains the positional foo value and verify the existing parser tests still pass.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- cli
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100