generator-kennship

Common tasks for new projects

Running

We assume you have pre-installed node.js v10 or later.

We suggest using npx to run the generator:

npx generator-kennship

It's true that this is slightly verbose, but running it this way will ensure that you have the latest version.

If you like, you can create a shell alias. Add this to your shell profile (either ~/.bashrc or ~/.zshrc):

alias kyo="npx generator-kennship"

Generators

code-style

Installs and configures code style tools, such as ESLint and Prettier.

npx generator-kennship kn:code-style

circle-ci

Sets up a default CircleCI configuration and contacts CircleCI to follow your project.

npx generator-kennship kn:circle-ci

pack

Sets up @pika/pack for your project.

npx generator-kennship kn:pack

release

Sets up Semantic Release for your project.

npx generator-kennship kn:release

gitignore

Applies a default set of .gitignore rules to your project. Won't clobber your existing rules, and will try to keep related items together.

npx generator-kennship kn:gitignore

readme

Creates a README.md for your project.

npx generator-kennship kn:readme

Smaller generators

This package also includes several smaller generators so you can run them independently.

# Add a GitHub badge
npx generator-kennship kn:github-badge

# Add a badge for your bug tracker
npx generator-kennship kn:bugs

# Add an npm badge linking to your package at npmjs.com
npx generator-kennship kn:npm-public

# Add a badge to let users know that this repo is maintained
npx generator-kennship kn:maintained

License

MIT © Kennship