tslint-config-xo

Adaptation XO configuration for TSLint.

Donate

If you want to thank me, or promote your issue.

❤️ I will be glad to see your support and PR's.

Disclaimer

Some bad news:

• This config does not contain TypeScript specific rules. This is adaptation XO configuration to TSLint.
• Some of the rules currently do not exist in the TSLint and other library. See @unavailable directive in the index.js and next.js files.

Install

$ npm install -D tslint-config-xo

Usage

Create tslint.json file and add extends field:

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

This package also exposes xo/esnext if you want ES2015+ rules:

{
  "extends": "tslint-config-xo/esnext"
}

You can overwrite rules by rules field:

{
  "extends": "tslint-config-xo/esnext",
  "rules": {
     // Your rules here
  }
}

We use

• tslint-eslint-rules
• tslint-microsoft-contrib
• vrsource-tslint-rules
• tslint-divid
• tslint-consistent-codestyle
• tslint-sonarts
• tslint-config-security

Quick Start

$ git clone https://github.com/mrmlnc/tslint-config-xo
$ npm i
$ npm test

Markers

We use JSDoc-like syntax for mark rules:

/**
 * @eslint – The rule name in ESLint.
 * @provider – The package that contains the rule.
 * @missed – The rule has a missed option (for example, unavailable).
 * @typescript – The rule is available in the compiler.
 * @duplicate – The rule is a duplicate for XXX.
 * @unavailable – The rule is currently unavailable.
 * @notApplicable – The rule is not applicable to Typescript.
 */

Changelog

See the Releases section of our GitHub project for changelogs for each release version.

License

This software is released under the terms of the MIT license.