# @10stars/styleguide-ts

> TS shareable config

Latest version **1.4.2** (published 2019-10-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install @10stars/styleguide-ts
pnpm add @10stars/styleguide-ts
yarn add @10stars/styleguide-ts
bun add @10stars/styleguide-ts
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.4.2 |
| Published | 2019-10-11 |
| First published | 2019-01-31 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 9 |
| Unpacked size | 15.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | 10stars.io |
| Maintainers | o_alexandrov |

## Links

- npm: https://www.npmjs.com/package/@10stars/styleguide-ts
- npm.io page: https://npm.io/package/@10stars/styleguide-ts

## Dependencies (9)

- [@types/joi](https://npm.io/package/@types/joi.md) 14.3.3
- [@types/jest](https://npm.io/package/@types/jest.md) 24.0.18
- [@types/node](https://npm.io/package/@types/node.md) 12.7.12
- [@types/react](https://npm.io/package/@types/react.md) 16.9.5
- [@types/webpack](https://npm.io/package/@types/webpack.md) 4.39.3
- [@types/aws-lambda](https://npm.io/package/@types/aws-lambda.md) 8.10.33
- [@types/webpack-env](https://npm.io/package/@types/webpack-env.md) 1.14.0
- [@types/react-select](https://npm.io/package/@types/react-select.md) 3.0.5
- [@types/react-router-dom](https://npm.io/package/@types/react-router-dom.md) 5.1.0

## Recent versions

- 1.4.2 (latest) — 2019-10-11
- 1.4.1 — 2019-10-10
- 1.4.0 — 2019-10-10
- 1.3.2 — 2019-10-05
- 1.3.1 — 2019-10-05
- 1.3.0 — 2019-10-01
- 1.2.0 — 2019-09-30
- 1.1.2 — 2019-09-30
- 1.1.1 — 2019-09-30
- 1.1.0 — 2019-09-30
- 1.0.1 — 2019-09-30
- 1.0.0 — 2019-09-29
- 0.13.0 — 2019-09-27
- 0.12.1 — 2019-09-27
- 0.12.0 — 2019-09-27
- … 31 more at https://npm.io/package/@10stars/styleguide-ts/versions

## README

# TSLint Config

> TSLint [shareable config](http://palantir.github.io/tslint/usage/cli/)

## TODO

- [ ] Add jest tests

## Install

```bash
npm i -g \
  @10stars/styleguide-ts \
  prettier \
  typescript \
  tslint \
  tslint-config-prettier \
  tslint-plugin-prettier \
  tslint-react \
  tslint-react-hooks
```

## Usage

- If you use our bundler, then:
  - You **DO NOT** need to change your:
    - `tslint.json` and `tsconfig.json`

### Read below if you use your own bundler

> TSLint [Configuration File Formats](http://palantir.github.io/tslint/usage/tslint-json/)

Add tslint config from `styleguide-ts/index.js` to your `tslint.json`:

```jsonc
{
  // if you:
  //   - are on a MacOS
  //   - installed the package globally
  //   - do NOT use our bundler
  "extends": ["/usr/local/lib/node_modules/@10stars/styleguide-ts"]
}
```

Add `base-tsconfig.json` to your `tsconfig.json`:

```jsonc
{
  // if you:
  //   - are on a MacOS
  //   - installed the package globally
  //   - do NOT use our bundler
  "extends": [
    "/usr/local/lib/node_modules/@10stars/styleguide-ts/base-tsconfig.json"
  ]
}
```

## NOT IMPORTANT - Usage in CLI

```bash
tslint --config @10stars/styleguide-ts
```

> **Note:** It is not necessary to create the `tslint.json` file.

---
_Source: https://npm.io/package/@10stars/styleguide-ts · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._