tslint-config-scc

Code style checking for Sequoia Capital China Typescript repositories. Forked from shopify/tslint-config-shopify.

Installation

Install TSlint and tslint-config-scc:

``
yarn add --dev tslint tslint-config-scc
`




Usage


SCC’s TSLint rules come bundled in tslint-config-scc.
To enable these rules, create a tslint.json file at the root level of your project, and extend tslint-config-scc.
`
{
"extends": "tslint-config-scc"
}
`

Now you can run TSLint by adding the following linting script to your package.json. See here for more script configurations.
`
{
"scripts": {
"lint": "tslint './src/*/.{ts,tsx}' --project tsconfig.json"
}
}
`
Run it:

`
yarn run tslint
`

Configuration

* See here for more details on configuring your tslint.json.
* See here for all the rules provided by TSlint

Some of the rules configured in tslint-config-scc may not be sufficient for your project. You can override these rules in tslint.json:

`json
{
"extends": "tslint-config-scc",
"rules": {
"no-console": false
}
}
``

> (c) 2018 Sequoia Capital.