zream-angular-standards v0.0.0-beta.4

Angular Standards

Common standards for a fresh Angular CLI (>=6.0.0) project.

Installation

Install the package using the following command

npm install zream-angular-standards --save-dev

Included is a command-line utility to add desired configuration to your project.

./node_modules/.bin/zream-angular-standards add
  - or -
npx zream-angular-standards add

Available Configurations

TypeScript

Add the following key to the root tsconfig.json file:

{
  "extends": "./node_modules/zream-angular-standards/config/tsconfig.json",
  ...
}

TSLint / Codelyzer

Replace the contents of the root tslint.json file with the following:

{
  "extends": [
    "zream-angular-standards/config/tslint"
  ],
  "rules": {
    "component-selector": {
      "options": [
        "element",
        ["app"],
        "kebab-case"
      ]
    },
    "directive-selector": {
      "options": [
        "attribute",
        ["app"],
        "camelCase"
      ]
    },
    "pipe-naming": {
      "options": [
        "camelCase",
        "app"
      ]
    }
  }
}

You also want to copy the "rules" section into your individual projects' tslint.json files, as these are project-specific.

Stylelint

Add a root .stylelintrc.json file with the following contents:

{
  "extends": "zream-angular-standards/config/stylelint",
  "rules": {}
}

Then replace the "lint" script in your package.json file with the following scripts:

"lint": "npm run lint:ts && npm run lint:style",
"lint:ts": "ng lint",
"lint:style": "stylelint \"@(src|projects)/**/*.?(s)css\"",

Development

Release

To release a new version, make sure there are no pending changes. Then run the following commands:

npm run clean
npm run build
npm run release

This will build, bump version, tag release, and publish to npm.

Run the following to update the remote repository

git push --follow-tags origin master