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 (1,053 forks)batch import
Help Wantedenhancement

Repository metrics

Stars
 (10,829 stars)
PR merge metrics
 (Avg merge 113d 19h) (11 merged PRs in 30d)

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

Research direction
Investigate how yargs currently supports config file per subcommand, check documentation for pkgConf and config, look at related issue #464, and propose a solution or documentation update.
Tech stack
nodejsjavascript
Domain
cli
Issue type
Documentation
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Node.jsGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60