yargs / yargs/yargs-parser

String values in config files that contain embedded quotes are not handled correctly

Open
#385 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
JavaScript
Stars
519
Forks
129
Avg merge
1h 34m
Merged PRs (30d)
1

Description

If a config object specified via the .config option to yargs contains a value that starts and ends with quotes, yargs strips those quotes, due to this code here:

https://github.com/yargs/yargs-parser/blob/50b54ae66aed4240021ba8fed9e98fec3f8d07ef/lib/yargs-parser.ts#L608

That seems like confusing, and undesirable behavior, and makes it difficult to pass values containing embedded quotes.

For example:

console.log(require('yargs').config({a: JSON.stringify('hello')}).parse());

This prints:

{ _: [], a: 'hello', '$0': 'yargs-bug.js' }

But I would expect it to instead print:

{ _: [], a: '"hello"', '$0': 'yargs-bug.js' }

I would suggest that when parsing already-split arguments, e.g. from process.argv, or when processing a config file, quotes should never be stripped, and no additional splitting should ever occur. The only time stripping of quotes should happen is when parsing an unsplit string. In that case, the string should be parsed into an array of strings using shell-style parsing, and then parsing should proceed using the resultant array, and do no further splitting or quote handling.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review lib/yargs-parser.ts at line 608 and the .config/process.argv parsing entry points. Reproduce the JSON.stringify example, then verify that already-split values preserve embedded quotes while only unsplit strings receive shell-style quote handling.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, typescript
Domain
cli
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.