# @equisoft/tslint-config-react

> Equisoft's TSLint configuration, React flavor.

Latest version **2.0.0** (published 2020-10-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install @equisoft/tslint-config-react
pnpm add @equisoft/tslint-config-react
yarn add @equisoft/tslint-config-react
bun add @equisoft/tslint-config-react
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: no vulnerabilities; high maintenance score.

Warnings: low downloads; no types; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2020-10-28 |
| First published | 2018-11-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 3.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Equisoft inc. |
| Maintainers | agauthier, maximegendron, christian-roy, meriouma, larrymatte, etremblay, kronostechnologies-build, toby-daigle, kbeaulieu, jsgarneau, christopherviel, adeschenes, nvanheuverzwijn |
| Keywords | equisoft, react, tslint, tslint-config |

## Links

- npm: https://www.npmjs.com/package/@equisoft/tslint-config-react
- Repository: https://github.com/kronostechnologies/standards
- Homepage: https://github.com/kronostechnologies/standards#readme
- Issues: https://github.com/kronostechnologies/standards/issues
- npm.io page: https://npm.io/package/@equisoft/tslint-config-react

## Dependencies (3)

- [tslint](https://npm.io/package/tslint.md) ~6.1.3
- [tslint-react](https://npm.io/package/tslint-react.md) ~5.0.0
- [@equisoft/tslint-config](https://npm.io/package/@equisoft/tslint-config.md) 2.0.0

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 2.0.0 (latest) — 2020-10-28
- 2.0.0-alpha.1 — 2020-09-21
- 2.0.0-alpha.0 — 2020-05-26
- 0.0.3 — 2018-11-07
- 0.0.2 — 2018-11-07
- 0.0.1 — 2018-11-07

## README

# Equisoft's TSLint configuration

This project hosts Equisoft's [TSLint](https://palantir.github.io/tslint/) configuration for React project.

For Node projects, you should instead look at [@equisoft/tslint-config](https://www.npmjs.com/package/@equisoft/tslint-config) which does not include React rules.

## Versioning

The versioning of this project respects [semver](https://semver.org/). That means your project's package.json can caret (`^`) import it.

## Installation

Install the libraries in your project:

```bash
yarn add --dev @equisoft/tslint-config-react
```

Then create a _tslint.json_ file that uses Equisoft's configuration:

```json
{
  "extends": [
    "@equisoft/tslint-config-react"
  ]
}
```

Finally create a script in your _package.json_ to easily run TSLint:

```json
{
  "scripts": {
    "tslint": "tslint -p tsconfig.json 'src/**/*.{ts,tsx}'",
    "tslint:ci": "yarn tslint --format junit -o build/tests/tslint/junit.xml"
  }
}
```

Now you can use `yarn tslint` to validate the code style of your TypeScript files!

## TypeScript compiler checks
This repository additionally exports a `tsconfig.standards.json` file that you should extend in your _tsconfig.json_ configuration:

```json
{
  "extends": "./node_modules/@equisoft/tslint-config/tsconfig.standards.json"
}
```

## Continuous Integration
We strongly suggest that you enforce code style checks on your CI. For example, on CircleCI you can add a configuration similar to this one to your _.circleci/config.yml_:

```yaml
orbs:
  eq: equisoft/build-tools@latest

jobs:
  tslint:
    executor: node
    steps:
      - eq/with-yarn-cache
      - run:
          name: TSLint
          command: yarn tslint:ci
      - store_test_results:
          path: build/tests
```

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