Skip to content
This repository has been archived by the owner on Feb 21, 2022. It is now read-only.

Commit

Permalink
Switch to yarn and update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
peterjwest committed Jul 24, 2018
1 parent 17debf6 commit f061528
Show file tree
Hide file tree
Showing 4 changed files with 2,888 additions and 5,101 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Expand Up @@ -38,7 +38,7 @@ started on a new rule or fix/improve some existing rule you can follow the instr
working on the `no-tabs` rule, then the rule name will be `ter-no-tabs`. This is to avoid future
name collision with native rules provided by `TSLint`.
- Create a branch with the rule name, e.g. `ter-indent`.
- If you haven't, run `npm install` to download the project dependencies.
- If you haven't, run `yarn install` to download the project dependencies.
- Create your rule tests at `./src/test/rules` and your rule in `./src/rules` with the convention:
- Name: rule-name (hyphenated, e.g: `ter-no-if-usage`)
- Rule File: ruleNameRule.ts (camelCased and with the `Rule` suffix, e.g: `terNoIfUsageRule.ts`)
Expand Down
6 changes: 6 additions & 0 deletions README.md
Expand Up @@ -23,6 +23,12 @@ Now you can combine both worlds by using this TSLint plugin!
npm install --save-dev tslint-eslint-rules
```

### Or install from Yarn to your Dev Dependencies

```console
yarn add tslint-eslint-rules --dev
```

### Configure TSLint to use `tslint-eslint-rules`:

In your `tslint.json` file, extend this package, e.g:
Expand Down

0 comments on commit f061528

Please sign in to comment.