UNPKG

@d3banking/tslint-config/README.md

Version:

876 BMarkdownView Raw

1# @d3banking/tslint-config
2
3[![NPM version](https://img.shields.io/npm/v/@d3banking/tslint-config.svg?style=flat)](https://www.npmjs.com/package/@d3banking/tslint-config)
4[![Downloads](https://img.shields.io/npm/dm/@d3banking/tslint-config.svg)](https://www.npmjs.com/package/@d3banking/tslint-config)
5
6This package provides D3 Banking's tslint.json as an extensible shared config.
7
8## Usage
9
10Our default export contains all of our TSLint rules, including Typescript 2+ and ECMAScript 6+. It requires `tslint` and `typescript`.
11
121. `npm install --save-dev @d3banking/tslint-config tslint typescript`
132. add `"extends": "@d3banking/tslint-config"` to your `tslint.json`
14
15
16See [D3 Banking's Javascript styleguide](https://github.com/LodoSoftware/javascript-style-guide) and
17the [TSlint config docs](https://palantir.github.io/tslint/usage/configuration/)
18for more information.
19

1	`# @d3banking/tslint-config`
2
3	`[![NPM version](https://img.shields.io/npm/v/@d3banking/tslint-config.svg?style=flat)](https://www.npmjs.com/package/@d3banking/tslint-config)`
4	`[![Downloads](https://img.shields.io/npm/dm/@d3banking/tslint-config.svg)](https://www.npmjs.com/package/@d3banking/tslint-config)`
5
6	`This package provides D3 Banking's tslint.json as an extensible shared config.`
7
8	`## Usage`
9
10	Our default export contains all of our TSLint rules, including Typescript 2+ and ECMAScript 6+. It requires `tslint` and `typescript`.
11
12	1. `npm install --save-dev @d3banking/tslint-config tslint typescript`
13	2. add `"extends": "@d3banking/tslint-config"` to your `tslint.json`
14
15
16	`See [D3 Banking's Javascript styleguide](https://github.com/LodoSoftware/javascript-style-guide) and`
17	`the [TSlint config docs](https://palantir.github.io/tslint/usage/configuration/)`
18	`for more information.`
19