yargs-command-config
Richard Wen
rrwen.dev@gmail.com
Yargs command for managing config files
Install
- Install Node.js
- Install yargs and yargs-command-config via
npm
npm install --save yargs yargs-command-config
For the latest developer version, see Developer Install.
Usage
Create a file named bin.js
with the following contents:
var yargs = ; // (config) Load command with path to config JSON file// Replace './path/to/config.json' with your config JSON filevar config = file: './path/to/config.json'; // (yargs) Add command to manage config filevar argv = yargsargv;
Display help options for bin.js
using node:
node bin.js config help
The following will be displayed:
bin config <task> [key] [value] [--config]
manage default config
<task> is one of:
* set
* delete
* view
* clear
* reset
Set option to value
> set [key] [value]
Remove default option
> delete [key]
View default options
> view
Clear default options
> clear
Reset default options
> reset
Manage other config file
> set [key] [value] --config other.json
> delete [key] --config other.json
> view --config other.json
> clear --config other.json
> reset --config other.json
Options:
--help Show help [boolean]
Default config files are managed with the commands below:
node bin.js config view
node bin.js config clear
node bin.js config reset
node bin.js config set key value
node bin.js config delete key
Other config files are managed by passing a path in the option --config
:
node bin.js config view --config config.json
node bin.js config clear --config config.json
node bin.js config reset --config config.json
node bin.js config set key value --config config.json
node bin.js config delete key --config config.json
See Documentation for more details.
Contributions
Report Contributions
Reports for issues and suggestions can be made using the issue submission interface.
When possible, ensure that your submission is:
- Descriptive: has informative title, explanations, and screenshots
- Specific: has details of environment (such as operating system and hardware) and software used
- Reproducible: has steps, code, and examples to reproduce the issue
Code Contributions
Code contributions are submitted via pull requests:
- Ensure that you pass the Tests
- Create a new pull request
- Provide an explanation of the changes
A template of the code contribution explanation is provided below:
## Purpose
The purpose can mention goals that include fixes to bugs, addition of features, and other improvements, etc.
## Description
The description is a short summary of the changes made such as improved speeds or features, and implementation details.
## Changes
The changes are a list of general edits made to the files and their respective components.
* `file_path1`:
* `function_module_etc`: changed loop to map
* `function_module_etc`: changed variable value
* `file_path2`:
* `function_module_etc`: changed loop to map
* `function_module_etc`: changed variable value
## Notes
The notes provide any additional text that do not fit into the above sections.
For more information, see Developer Install and Implementation.
Developer Notes
Developer Install
Install the latest developer version with npm
from github:
npm install git+https://github.com/rrwen/yargs-command-config
Install from git
cloned source:
- Ensure git is installed
- Clone into current path
- Install via
npm
git clone https://github.com/rrwen/yargs-command-config
cd yargs-command-config
npm install
Tests
- Clone into current path
git clone https://github.com/rrwen/yargs-command-config
- Enter into folder
cd yargs-command-config
- Ensure devDependencies are installed and available
- Run tests
- Results are saved to tests/log with each file corresponding to a version tested
npm install
npm test
Documentation
Use documentationjs to generate html documentation in the docs
folder:
npm run docs
See JSDoc style for formatting syntax.
Upload to Github
- Ensure git is installed
- Inside the
yargs-command-config
folder, add all files and commit changes - Push to github
git add .
git commit -a -m "Generic update"
git push
Upload to npm
- Update the version in
package.json
- Run tests and check for OK status
- Generate documentation
- Login to npm
- Publish to npm
npm test
npm run docs
npm login
npm publish
Implementation
The module yargs-command-config uses the following npm packages for its implementation:
npm | Purpose |
---|---|
yargs | Manage command line arguments and options |
fs | Read and write JSON config files |
yargs <-- CLI arguments
|
fs <-- JSON config files
Changes
v1.0.1
- Defaults for
options.task.file
and[--file]
are nowoptions.task.config
and[--config]
respectively
v1.0.0
- Initial release