generator-cliify
v1.0.5
Published
CLI-ify: Command line interface (CLI) Node.js application
Downloads
4
Maintainers
Readme
Cliify, Yeoman Generator
Usage
npm install -g yo generator-cliify
yo cliify
cd my-project
npm install
npm test
Features
- Hierarchical configuration with files, environment variables, command-line arguments, and atomic object merging; nconf
- Prompt for missing/sensitive arguments; Inquirer.js
- ES5 + ES6 source; Babel
- Unit testing, integration testing, mocking, code coverage; Mocha, Chai, Sinon.JS, Istanbul
- Version controlled; Release It!
- JavaScript style enforcement; JSCS
Project Structure
└─ $ tree -I 'node_modules'
.
├── babel // transpiled source code
├── bin
│ └── job.js // executable script exposed by package.json "bin" property
├── coverage // line coverage reports
├── config
│ ├── argv.json // required/optional command line arguments
│ ├── default-config.json // default configuration options
│ └── release.json // release configuration
├── package.json // npm package information
├── src
│ └── job.js // put your business logic here
└── test
├── integration
│ └── job.spec.js // integration test
├── support
│ └── test-utils.js // test configuration
└── unit
├── job.spec.js // unit test
└── test-environment.spec.js // test environment validation
NPM Scripts
npm test
: Run style enforcer, tests, and code coverage.npm start -- --key=value
: Run the CLI tool with given key/value arguments.npm run release
: Bump thepackage.json
version, commit, tag, and publish.
Contribution
See CONTRIBUTING.md for contribution details.