jorishermans / node-flowtype-boilerplate

Minimalistic boilerplate to quick-start Node.js development in ES6 (with async/await & es6 modules) with Flow type checking.

node-flowtype-boilerplate

Minimalistic boilerplate to jump-start a Node.js project in ES6 with Flow type checking.

Provides a basic template, batteries included:

• ES6 + babel,
  • Removes Flow type annotations,
  • Transforms imports to lazy CommonJS requires,
  • Transforms async/await to generators,
• ESLint with the airbnb-base and flowtype rules,
• Jest unit testing and coverage,
• Type definitions for Jest,
• NPM scripts for common operations,
• .editorconfig for consistent file format,
• Yarn lockfile so only verified and up-to-date dependencies are installed.

Quick start

This project requires Node.js 6.2 or later and NPM, Yarn is optional but recommended. Make sure you have those installed. Then just type following commands:

git clone https://github.com/jsynowiec/node-flowtype-boilerplate
cd node-flowtype-boilerplate
yarn || npm install

Available scripts

Run using either npm run <script> or yarn run <script> comand.

• clean - remove coverage data, Jest cache and transpiled files,
• lint - lint source files and tests,
• typecheck - check type annotations,
• test - lint, typecheck and run tests with coverage,
• test-only - run tests with coverage,
• test:watch - interactive watch mode to automatically re-run tests,
• build - compile source files,
• build:watch - interactive watch mode, compile sources on change.

Alternative

As an alternative to Flow type checking, you can try my Node.js TypeScript boilerplate. It's basically the same but with TypeScript and TSLint.

License

MIT License. See the LICENSE file.