# tslint-config-adidas

> TSLint base configuration and rules for all TypeScript codebases

Latest version **1.0.1** (published 2018-08-20) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install tslint-config-adidas
pnpm add tslint-config-adidas
yarn add tslint-config-adidas
bun add tslint-config-adidas
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2018-08-20 |
| First published | 2018-07-31 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 8 |
| Dependencies | 0 |
| Unpacked size | 13.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 29 |
| Maintainers | adidas |
| Keywords | tslint, tslint-config |

## Links

- npm: https://www.npmjs.com/package/tslint-config-adidas
- Repository: https://github.com/adidas/js-linter-configs
- Homepage: https://github.com/adidas/js-linter-configs#readme
- Issues: https://github.com/adidas/js-linter-configs/issues
- npm.io page: https://npm.io/package/tslint-config-adidas

## Alternatives

- [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads
- [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads
- [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads
- [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads
- [@inrupt/eslint-config-base](https://npm.io/package/@inrupt/eslint-config-base.md) — 4.5K weekly downloads

## Recent versions

- 1.0.1 (latest) — 2018-08-20
- 1.0.0 — 2018-07-31

## README

[![npm version](https://badge.fury.io/js/tslint-config-adidas.svg)](https://npmjs.com/package/tslint-config-adidas)

# tslint-config-adidas

Basic TypeScript TSLint rules.

This should be the base for every TypeScript project.

## Install

```
npm i --save-dev tslint@5 tslint-eslint-rules@5 tslint-config-adidas
```

## Usage

Create a `tslint.json` file on the root folder of the project and add the following:

```json
{
  "extends": "tslint-config-adidas"
}
```

> You can also create `tslint.yaml`, check [TSLint documentation](https://palantir.github.io/tslint/usage/configuration/) for details.

## Running

Create a `lint` script in your `package.json`:

```json
{
  "scripts": {
    "lint": "tslint -p tsconfig.json" // run the linter over the files watched by the compiler as specified in tsconfig.json
  }
}
```

> `tslint` CLI provides far more options, make sure to check its [documentation](https://palantir.github.io/tslint/usage/cli/).

In a terminal, run:

```
npm run lint
```

The linter will run and either exit clean if there were no issues or display a report log with all the issues found and exit with error.

## Overriding rules

It sometimes can happen that some rule conflicts with the code, and the latter cannot be changed/updated to match the rule.

In those cases there are plenty of options, you can disable the rule globally, partially or override the rule.

> Check this [TSLint page on disabling rules](https://palantir.github.io/tslint/usage/rule-flags/) through comments in the code. It is not recommended, but sometimes it's inevitable.

To override, add a `rules` entry in your `tslint.json` configuration and set any rules that should be overridden:

```json
{
  "extends": "tslint-config-adidas",
  "rules": {
    // overrides "no-this-assignment": [true, { "allowed-names": ["^_this$"], "allow-destructuring": true }]
    "no-this-assignment": [true, { "allowed-names": ["^self$"] }],

    // overrides "radix": true
    "radix": false
  }
}
```

## Links

- [TSLint](https://palantir.github.io/tslint/)
- [TSLint: Configuration](https://palantir.github.io/tslint/usage/configuration/)
- [TSLint: CLI](https://palantir.github.io/tslint/usage/cli/)
- [TSLint: Rules](https://palantir.github.io/tslint/rules/)
- [TSLint: ESLint rules](https://github.com/buzinas/tslint-eslint-rules)

---
_Source: https://npm.io/package/tslint-config-adidas · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._