Skip to content

MailOnline/tslint-config-mailonline

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

tslint-config-mailonline

NPM version Travis build status

MailOnline TSLint configuration.

Usage

Add tslint-config-mailonline, tslint, typescript, and prettier as development dependencies:

yarn add --dev tslint-config-mailonline tslint typescript prettier

Create TSLint configuration file (tslint.json) that extends tslint-config-mailonline:

{
  "extends": "tslint-config-mailonline"
}

Create prettier.config.js on the root of your project with these contents:

module.exports = require('tslint-config-mailonline/prettier');

Add the following script command to your package.json:

{
  "lint:prettier": "prettier --ignore-path .gitignore --write './**/*.{js,jsx,ts,tsx}'",
  "lint:tslint": "tslint './**/*.{js,jsx,ts,tsx}' -t verbose",
  "lint": "yarn run lint:prettier && yarn run lint:tslint"
}

Extended configs

The package also has separate entry points for some environments. Simply extend from the entry point as described below

{
  "extends": [
    "tslint-config-mailonline",
    "tslint-config-mailonline/react"
  ]
}

react

{
  "extends": "tslint-config-mailonline/react"
}

Breaking changes

Any changes to this package that might cause code using it to not validate anymore, will be a semver-major change.