[ts-command-line] Support for pulling parameter values from a config file

Open
#5,876 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
35/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Quiet
Tech stack
typescript
Domain
cli

Research direction

Start by locating the ts-command-line parameter-definition and configuration-parsing entry points. Review how required CLI parameters are currently resolved, then define the configuration-file parameter name and JSONPath behavior, including precedence and completion criteria. The issue does not name specific files or tests, so those would need to be identified before implementation.

Written by the indexing model from the issue text.

Description

Summary

For CLI tools with a lot of arguments, it would be useful to support reading CLI parameter values from a config file as a first-class feature (i.e. they could still be marked required but their values get ingested from the config file, if passed). The concept would be that each CLI parameter definition could additionally specify the name of a configuration file parameter from which to pull the parameter value, and a JSONPath specifier or similar to where to find the property in the parsed config.

Dominant language
TypeScript
Stars
6.5k
Forks
708
Avg merge
5d 7h
Merged PRs (30d)
44

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.

More from microsoft/rushstack

All issues in microsoft/rushstack

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.