cf-package

Cloverfield Package Scaffold

Status - Deprecated

This package is not being actively maintained.

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 prompt:

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.

cloverfield-tools / cf-package

readme