Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/reallyland/tslint-config
TSLint config for The Really Project
https://github.com/reallyland/tslint-config
really reallyland tslint tslint-config tslint-config-airbnb typescript
Last synced: about 1 month ago
JSON representation
TSLint config for The Really Project
- Host: GitHub
- URL: https://github.com/reallyland/tslint-config
- Owner: reallyland
- License: mit
- Created: 2019-04-26T16:02:54.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2019-07-15T14:00:17.000Z (over 5 years ago)
- Last Synced: 2024-11-06T04:05:37.560Z (about 2 months ago)
- Topics: really, reallyland, tslint, tslint-config, tslint-config-airbnb, typescript
- Language: JavaScript
- Homepage: https://npm.im/@reallyland/tslint-config
- Size: 22.5 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license
- Code of conduct: code-of-conduct.md
Awesome Lists containing this project
README
@reallyland/tslint-config
TSLint config for The Really Project
[![Version][version-badge]][version-url]
[![Node version][node-version-badge]][node-version-url]
[![MIT License][mit-license-badge]][mit-license-url]
[![Downloads][downloads-badge]][downloads-url]
[![Total downloads][total-downloads-badge]][downloads-url]
[![Packagephobia][packagephobia-badge]][packagephobia-url]
[![Bundlephobia][bundlephobia-badge]][bundlephobia-url]
[![Dependency Status][daviddm-badge]][daviddm-url]
[![Code of Conduct][coc-badge]][coc-url]
> [TSLint config][tslint-config-url] based on [Airbnb JavaScript Style Guide][airbnb-javascript-style-guide-url] for [The Really Project][].
## Table of contents
- [Install](#install)
- [Usage](#usage)
- [tslint.json](#tslintjson)
- [[Optional] tslint.prod.json](#optional-tslintprodjson)
- [Rules](#rules)
- [License](#license)
## Install
```sh
# Install via NPM as one of the `devDependencies`
$ npm install --save-dev @reallyland/tslint-config
```
## Usage
### tslint.json
```json
{
"extends": [
"@reallyland/tslint-config"
],
}
```
### [Optional] tslint.prod.json
```js
{
"extends": [
"@reallyland/tslint-config"
],
"rules": {
// No `debugger` in production mode
"no-debugger": true
}
}
```
## Rules
- [tslint][tslint-url]
- [tslint-config-airbnb][tslint-config-airbnb-url]
- [tslint-immutable][tslint-immutable-url]
## License
[MIT License](https://motss.mit-license.org) © Rong Sen Ng
[typescript-url]: https://github.com/Microsoft/TypeScript
[node-js-url]: https://nodejs.org
[npm-url]: https://www.npmjs.com
[node-releases-url]: https://nodejs.org/en/download/releases
[tslint-config-url]: https://palantir.github.io/tslint/usage/tslint-json
[airbnb-javascript-style-guide-url]: https://github.com/airbnb/javascript
[tslint-url]: https://github.com/palantir/tslint
[tslint-config-airbnb-url]: https://github.com/progre/tslint-config-airbnb
[tslint-immutable-url]: https://github.com/jonaskello/tslint-immutable
[The Really Project]: https://github.com/reallyland
[version-badge]: https://flat.badgen.net/npm/v/@reallyland/tslint-config
[node-version-badge]: https://flat.badgen.net/npm/node/@reallyland/tslint-config
[mit-license-badge]: https://flat.badgen.net/npm/license/@reallyland/tslint-config
[downloads-badge]: https://flat.badgen.net/npm/dm/@reallyland/tslint-config
[total-downloads-badge]: https://flat.badgen.net/npm/dt/@reallyland/tslint-config?label=total%20downloads
[packagephobia-badge]: https://flat.badgen.net/packagephobia/install/@reallyland/tslint-config
[bundlephobia-badge]: https://flat.badgen.net/bundlephobia/minzip/@reallyland/tslint-config
[daviddm-badge]: https://flat.badgen.net/david/dep/reallyland/tslint-config
[coc-badge]: https://flat.badgen.net/badge/code%20of/conduct/pink
[version-url]: https://www.npmjs.com/package/@reallyland/tslint-config
[node-version-url]: https://nodejs.org/en/download
[mit-license-url]: https://github.com/reallyland/tslint-config/blob/master/license
[downloads-url]: https://www.npmtrends.com/@reallyland/tslint-config
[packagephobia-url]: https://packagephobia.now.sh/result?p=%40reallyland%2Ftslint-config
[bundlephobia-url]: https://bundlephobia.com/result?p=@reallyland/tslint-config
[daviddm-url]: https://david-dm.org/reallyland/tslint-config
[coc-url]: https://github.com/reallyland/tslint-config/blob/master/code-of-conduct.md