Skip to content

swellaby/tslint-config

Repository files navigation

tslint-config

Module that contains our tslint configurations.

npmjs Version Badge npmjs Downloads Badge Circle CI Badge license Badge

Installation

Install the tslint-config module as a dev dependency:

npm i @swellaby/tslint-config --save-dev

Usage

Add an extends key to your tslint config file and specify the value of the configuration you want to use:

For example, to use our default tslint configuration add the following to your tslint.json file:

{
    ...
    "extends": "@swellaby/tslint-config",
    ...
}

You can optionally use any of our other tslint configurations by adding the desired configuration to the end of the extends path. For example to use our base configuration instead of the default:

{
    ...
    "extends": "@swellaby/tslint-config/base",
    ...
}

Configuration

Our default module configuration includes our rule config from the base TSLint rule set, as well as rule configurations for the tslint-microsoft-contrib ruleset and the tslint-eslint ruleset. You can view our rule configurations for the respective rulesets at the below links:

Contributing

See our Contributing Guidelines for more information about contributing, building, etc.

License

MIT - see license details here