@appruut/node-preset v1.1.8

'Contents'

• Quick Set Up
  • Appveyor
  • Circleci
  • Contributor's List
  • Editor Config File
  • Application Linting with eslint
  • GitHub templates
  • GitHub Actions
  • Application git check .gitignore
  • GitHub Labels
  • Application Licensing
  • Package release management
  • Package.json
  • Package security
  • Prettier config
  • Probots
  • Readme file
  • TOC
  • Validate Commits

Quick Set Up

npm i --save-dev mrm @appruut/node-preset

Add script to package.json file

{
 "scripts": {
   "mrm": "mrm --preset=@appruut/node-preset"
 }
}

and then run it as follows

## Initiate by creating config file
npm run mrm init

## Execute all tasks (for new projects)
npm run mrm all

Appveyor

Add appveyor.yml file

Circleci

Add .circleci/config.yml file

Contributor's List

Creates .github/CONTRIBUTING.md file

Editor Config File

Add .editorconfig file

Application Linting with eslint

Add .eslintrc.json & .eslintignore files. Installs eslint and @appruut/eslint-plugin npm packages.

GitHub templates

Add Github related templates

GitHub Actions

Add .github/workflows/test.yml file

Application git check .gitignore

Add .gitignore file. Defaults to the Node.js .gitignore recommendations

GitHub Labels

Add a script to sync labels with Github

Application Licensing

Add LICENSE.md file. Defaults to MIT

Package release management

Add np for npm package release management. Create .npmrc

Package.json

Add package.jsonfile and configures/installs dependencies

Package security

Add "publishConfig" to package.json depending on the type of organization you are in. Defaults to "public".

Prettier config

Add prettier files .prettierignoreand .prettierrc to the project

Probots

Configure certain probot applications

Readme file

Add README.md

TOC

Generate TOC for readme.md file

Validate Commits

Enforce commit message convention