Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jr-codes/cli-rewire
Make a CLI by rewiring other CLIs
https://github.com/jr-codes/cli-rewire
args arguments binary cli clis command config configuration javascript nodejs
Last synced: about 2 months ago
JSON representation
Make a CLI by rewiring other CLIs
- Host: GitHub
- URL: https://github.com/jr-codes/cli-rewire
- Owner: jr-codes
- License: mit
- Created: 2020-04-12T19:07:55.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-25T19:33:35.000Z (2 months ago)
- Last Synced: 2024-11-06T19:07:54.744Z (2 months ago)
- Topics: args, arguments, binary, cli, clis, command, config, configuration, javascript, nodejs
- Language: JavaScript
- Homepage:
- Size: 1.24 MB
- Stars: 5
- Watchers: 2
- Forks: 1
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# cli-rewire
[](https://github.com/semantic-release/semantic-release)
[](https://www.npmjs.com/package/cli-rewire)
[](https://github.com/jr-codes/cli-rewire/actions)
[](https://github.com/jr-codes/cli-rewire/blob/master/LICENSE)
[](https://lgtm.com/projects/g/jr-codes/cli-rewire/context:javascript)
[](https://lgtm.com/projects/g/jr-codes/cli-rewire/alerts/)
Make a CLI by rewiring other CLIs.
CLI Rewire is a tool that lets you take existing CLIs, reconfigure their options, and combine them together to form new commands. Using CLI Rewire, you can create CLI wrappers and toolchains like [Create React App's react-scripts](https://github.com/facebook/create-react-app/tree/master/packages/react-scripts), [Standard](https://github.com/standard/standard), [XO](https://github.com/xojs/xo), and [kcd-scripts](https://github.com/kentcdodds/kcd-scripts).
CLI Rewire internally uses [yargs](https://github.com/yargs/yargs-parser) to reconfigure args, [cosmiconfig](https://github.com/davidtheclark/cosmiconfig) to override configs, and [execa](https://github.com/sindresorhus/execa) to run CLIs.
## 🔧 Install
```sh
npm install cli-rewire
```
## 📝 Usage
First, `npm install` each CLI you want to rewire into you project.
Then, make a script file for each CLI. For example, if you wanted to rewire [Jest](https://github.com/facebook/jest) to use a custom config by default:
```js
// jest.js
const { getConfigPath, rewire } = require('cli-rewire')
// Uses yargs-parser to rewire args; see yargs-parser docs for options
const runJest = rewire({
alias: {
// Capture -c and --config
config: 'c'
},
default: {
// If --config or -c isn't provided, find the user's Jest config.
// If not found, use /path/to/my/jest.config.js.
config: getConfigPath('jest', {}, '/path/to/my/jest.config.js'))
}
})
// Run Jest CLI
runJest()
```
After making your scripts, wire them together in your CLI's bin file.
```js
// my-cli.js
#!/usr/bin/env node
const { wire } = require('cli-rewire')
// Get script paths
const scripts = [
'./scripts/babel.js',
'./scripts/prettier.js',
'./scripts/jest.js',
'./scripts/webpack.js'
].map(require.resolve)
// Wire up the scripts together
const runCLI = wire(scripts, {
// Combine CLI commands to form your own custom commands
commands: {
format: [
'prettier --write .'
],
'test-ci': [
'prettier --check .',
'jest --ci'
]
}
})
runCLI()
```
If this were published as a `my-cli` package, these would be a few possible commands:
- `my-cli babel my-file.js`
- `my-cli prettier --check "src/**/*.js"`
- `my-cli jest --silent`
- `my-cli format`
- `my-cli test-ci --verbose`
Users of your CLI would be able to run any of the rewired tools, as well as any custom commands you specified.