yargs/yargs

How to use config and pkgConf to configure subcommands?

Open

#858 opened on Apr 17, 2017

View on GitHub
 (4 comments) (1 reaction) (0 assignees)JavaScript (10,829 stars) (1,053 forks)batch import
Help Wantedenhancement

Description

If I have subcommands, how would I go about getting things configured via config file and/or package.json via pkgConf?

For example, let's say I have this:

foo bar --out-file ./bar.txt
foo baz --out-file ./baz.txt

...but now I want to call my subcommands with a single config file (or via package.json) like this:

foo bar --config ./foo.json
foo baz --config ./foo.json

How do I configure the "out-file" option for each subcommand? Won't users run into "namespace" conflicts on my options (i.e. since I can only have one "out-file" key in my config)? How do i specify a separate out-file for both bar and baz without requiring the user to have two different config files (e.g. bar.config and baz.config)? How do I do this with package.json via pkgConf with only a single "foo" key in package.json?

Related issue: https://github.com/yargs/yargs/issues/464

Contributor guide

Tech stack
javascriptnodejs
Domain
cli
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
JavaScriptyargs basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
Investigate how yargs currently handles configuration via pkgConf and config files in the context of subcommands. Note the related issue #464 which may provide context. Examine the source code in yargs.js and the documentation on the yargs website to understand the current limitations. Consider proposing a feature to allow namespacing options per subcommand in the config file.