dzaman / node-scaffold

Features

• TypeScript
• Tests with Jest
• Linting with ESLint
• Lint rules from Airbnb via this package
• Continuous Integration with CircleCI
• Code coverage with Jest shared to Codecov
• Documentation generation with TypeDoc
• Documentation publishing with GH Pages
• Commits with Commitizen
• Releases with Semantic Release

Commands

build

node_modules/.bin/tsc -p .

build+test

npm run build && npm run test-build

build+test+coverage

npm run build+test -- -- --collect-coverage

commit

npx git-cz

coverage-post

node_modules/.bin/codecov

docs

node_modules/.bin/typedoc --out docs --module commonjs lib

docs-publish

node_modules/.bin/gh-pages --dist docs

lint

node_modules/.bin/eslint lib tests --ext .js,.jsx,.ts,.tsx

test

node_modules/.bin/jest

test-build

npm test -- -c jest.config.build.js

test+coverage

node_modules/.bin/jest --collect-coverage

Setup

1. Add project to CircleCI and Codecov
2. Add Codecov token to CircleCI environment variables
3. Verify webooks on Github
4. Add Github personal access tokens for release tokens
5. Add NPM access tokens for distribution
6. Install the Codecov Github App

Release Branches

Create releases by merging to a release branch and running semantic-release on that branch. A release branch (e.g. release) will need to be pushed to the repo origin in order to execute semantic release on any branch because one release branch is required and pre-release branches do not count.

{
  "branches": [
    { "name": "pre-alpha", "prerelease": true },
    { "name": "alpha", "prerelease": true },
    { "name": "beta", "prerelease": true },
    "release",
    "+([0-9])?(.{+([0-9]),x}).x"
  ]
}