@zater-systems/style-guide v1.0.4

Zater Systems | Style Guide

Common style guide and linting rules for Zater Systems projects.

Documenation

https://zater-systems.github.io/style-guide/

Getting Started

Installation

Install using NPM:

npm install -D @zater-systems/style-guide typescript@~2.7.2 tslint tslint-angular codelyzer

Install using Yarn:

yarn add -D @zater-systems/style-guide

Angular

Create a tslint.json file:

{
  "extends": ["@zater-systems/style-guide/angular"],
  "rules": {
    "directive-selector": [true, "attribute", "zs", "camelCase"],
    "component-selector": [true, "element", "zs", "kebab-case"]
  }
}

Create a tsconfig.json file:

{
  "extends": "./node_modules/@zater-systems/style-guide/typescript/tsconfig.json",
  "compilerOptions": {}
}

Create a .prettierrc file:

{
  "singleQuote": true,
  "trailingComma": "all"
}

General Typescript

Create a tslint.json file:

{
  "extends": ["@zater-systems/style-guide/typescript"]
}

Create a tsconfig.json file:

{
  "extends": "./node_modules/@zater-systems/style-guide/typescript/tsconfig.json",
  "compilerOptions": {}
}

Contributing

Installation

Run yarn to install packages.