UNPKG

1.09 kBMarkdownView Raw
1## @0x/tslint-config
2
3TSLint configuration and custom linter rules used by 0xProject.
4
5## Installation
6
7```bash
8yarn add --dev @0x/tslint-config
9```
10
11## Usage
12
13Add the following to your `tslint.json` file
14
15```json
16{
17 "extends": ["@0x/tslint-config"]
18}
19```
20
21## Contributing
22
23We welcome improvements and fixes from the wider community! To report bugs within this package, please create an issue in this repository.
24
25Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started.
26
27### Install dependencies
28
29If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them:
30
31```bash
32yarn config set workspaces-experimental true
33```
34
35Then install dependencies
36
37```bash
38yarn install
39```
40
41### Build
42
43To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory:
44
45```bash
46PKG=@0x/tslint-config yarn build
47```
48
49Or continuously rebuild on change:
50
51```bash
52PKG=@0x/tslint-config yarn watch
53```
54
55### Clean
56
57```bash
58yarn clean
59```
60
61### Lint
62
63```bash
64yarn lint
65```
66
67### Run Tests
68
69```bash
70yarn test
71```
72
\No newline at end of file