search

RebeccaStevens / tslint-rebeccastevens

TSLint rules I made for myself.
BSD 3-Clause "New" or "Revised" License
0 stars 0 forks source link

readme

tslint-rebeccastevens

npm version travis build ![Coverage Status][coverage-badge] greenkeeper dependencies status dev dependencies status BSD 3 Clause license

A TSLint sharable config with custom rules I made for myself.

Install

# Install with npm:
npm install --save-dev @rebeccastevens/tslint-rebeccastevens

# Install with yarn:
yarn add -D @rebeccastevens/tslint-rebeccastevens

Usage

Choose one of the rule sets below and add it to your tslint.json file to use it.

Standard (default) The standard rule set contains all the custom rules defined by this project with a default configuration set for each. `tslint.json` config: ```json { "extends": [ "@rebeccastevens/tslint-rebeccastevens" ] } ```
Recommended The recommended rule set not only contains custom rules from this project but also from many other projects as well as the default rule set. This rule set is a useful starting point for a new project. `tslint.json` config: ```json { "extends": [ "@rebeccastevens/tslint-rebeccastevens/ruleset-recommended" ] } ```

Custom Rules

Rules Description
no-return-readonly-array Prevents the type ReadonlyArray<T> from being returned from a function.

[coverage-badge]: https://img.shields.io/coveralls/github/RebeccaStevens/tslint-rebeccastevens/master.svg?style=flat-square