Package Exports

tslint-config-dabapps

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (tslint-config-dabapps) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

TSLint Config

About

This repository includes a default tslint config based on tslint's recommended rules with some adjustments to closer match our eslint rules.

Install

Install a specific version of the tslint config with NPM. You can see a full list of versions here.

npm i tslint-config-dabapps@x.x.x -D

Note: -D is shorthand for --save-dev.

This will update your package.json automatically, as seen below.

"devDependencies": {
  "tslint-config-dabapps": "x.x.x",
}

Configuration

NPM Scripts

Add the following scripts to your package.json.

Note: You must not have a files key defined in your tsconfig.json or your globs will be ignored.

{
  "scripts": {
    "lint": "tslint --project tsconfig.json '{src,tests}/**/*.{ts,tsx}'"
  }
}

Default Config

Create a tslint.json in the route of the project and extend the default config:

{
  "extends": [
    "tslint-config-dabapps"
  ]
}

If you are using react-native you should extend the following:

{
  "extends": [
    "tslint-config-dabapps/react-native"
  ]
}

Code of conduct

For guidelines regarding the code of conduct when contributing to this repository please review https://www.dabapps.com/open-source/code-of-conduct/