@azz/generator-npm-package

@azz/generator-npm-package

An opinionated npm package bootstrapper

Features

• prettier
• pretty-quick and husky
• eslint with:
  • eslint:recommended
  • eslint-plugin-prettier
  • eslint-plugin-jest
• babel with babel-preset-env
• jest
• semantic-release

Install

First, install Yeoman and generator-npm-package using npm (we assume you have pre-installed node.js).

yarn global add yo @azz/generator-npm-package

Use

yo @azz/npm-package

Prompt

$ yo @azz/npm-package
  _ __  _ __  _ __ ___        _ __   __ _  ___| | ____ _  __ _  ___
 | '_ \| '_ \| '_ ` _ \ _____| '_ \ / _` |/ __| |/ / _` |/ _` |/ _ \
 | | | | |_) | | | | | |_____| |_) | (_| | (__|   < (_| | (_| |  __/
 |_| |_| .__/|_| |_| |_|     | .__/ \__,_|\___|_|\_\__,_|\__, |\___|
       |_|                   |_|                         |___/
? package name? my-pkg
? package description? My package description
? full name (First Last)? John Citizen
? GitHub username or organization? jcitizen

Produces

$ tree -I node_modules
.
├── LICENSE
├── README.md
├── dist
│   └── index.js
├── package.json
├── src
│   └── index.js
└── yarn.lock

2 directories, 6 files