cf-package Circle CI

Cloverfield Package Scaffold

What does this do?

It scaffolds a new module with the following features:

  • ES6 with Babel
  • Lint with ESLint
  • Tape tests with coverage report
  • Dependency security audits with nsp
  • Ensure dependencies are properly declared in package.json
  • Git precommit hook enforces quality checks on commit
  • CI config (Travis, CircleCI)
  • A contributing guide
  • An assortment of useful npm scripts

Getting Started

npm install -g cf-package
mkdir project
cd project
cf-package
npm install
npm test

Input via propmt:

cf-package
> Your name: My Name
> Your email (will be publicly available, optional): my@email 
> Your GitHub public username: mygithub
> Package name: test
> Package description: Test Package
Variable Prompt
user.name > Your name:
user.email > Your email (will be publicly available, optional):
user.github > Your GitHub public username:
package.name > Package name:
package.description > Package description:

Quick input

Alternatively it is possible to input every generator variable as CLI option:

cf-package --user.name="My Name" \
  --user.email=my@email \
  --user.github=mygithub \
  --package.name=test \
  --package.description="Test Package"

Explore and enjoy! Part of the Cloverfield project.



cf-package Circle CI

Cloverfield Package Scaffold

这是做什么的?

它支持具有以下功能的新模块:

  • ES6 with Babel
  • 使用ESLint
  • 提供Lint
  • 带覆盖率报告的磁带测试
  • 使用nsp
  • 进行依赖关系安全审核
  • 确保依赖关系在package.json
  • 中正确声明
  • Git precommit hook强制执行质量检查
  • CI配置(Travis,CircleCI)
  • 贡献指南
  • 各种有用的npm脚本

入门指南

npm install -g cf-package
mkdir project
cd project
cf-package
npm install
npm test

通过propmt输入:

cf-package
> Your name: My Name
> Your email (will be publicly available, optional): my@email
> Your GitHub public username: mygithub
> Package name: test
> Package description: Test Package
Variable Prompt
user.name > Your name:
user.email > Your email (will be publicly available, optional):
user.github > Your GitHub public username:
package.name > Package name:
package.description > Package description:

快速输入

或者,可以将每个生成变量输入为CLI选项:

cf-package –user.name="My Name" 
–user.email=my@email
–user.github=mygithub
–package.name=test
–package.description="Test Package"

探索并享受! Cloverfield项目的一部分。




相关问题推荐