# prettier-tslint

> Formats your TypeScript using Prettier followed by tslint --fix

Latest version **0.4.2** (published 2019-01-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install prettier-tslint
pnpm add prettier-tslint
yarn add prettier-tslint
bun add prettier-tslint
```

Provides the command `prettier-tslint`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.4.2 |
| Published | 2019-01-03 |
| First published | 2017-10-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 18.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 222 |
| Author | Lucas Azzola |
| Maintainers | azz |

## Links

- npm: https://www.npmjs.com/package/prettier-tslint
- Repository: https://github.com/azz/prettier-tslint
- Homepage: https://github.com/azz/prettier-tslint#readme
- Issues: https://github.com/azz/prettier-tslint/issues
- npm.io page: https://npm.io/package/prettier-tslint

## Dependencies (6)

- [chalk](https://npm.io/package/chalk.md) ^2.4.0
- [yargs](https://npm.io/package/yargs.md) ^11.0.0
- [globby](https://npm.io/package/globby.md) ^8.0.1
- [ignore](https://npm.io/package/ignore.md) ^3.3.7
- [tslint](https://npm.io/package/tslint.md) ^5.9.1
- [require-relative](https://npm.io/package/require-relative.md) ^0.8.7

## Recent versions

- 0.4.2 (latest) — 2019-01-03
- 0.4.1 — 2018-12-11
- 0.4.0 — 2018-04-24
- 0.3.0 — 2017-10-21
- 0.2.0 — 2017-10-21
- 0.1.0 — 2017-10-15
- 0.0.0-development — 2017-10-15

## README

# prettier-tslint

Formats your TypeScript using [`prettier`](https://github.com/prettier/prettier)
followed by [`tslint --fix`](https://github.com/palantir/tslint).

[![Travis](https://img.shields.io/travis/azz/prettier-tslint.svg?style=flat-square)](https://travis-ci.org/azz/prettier-tslint)
[![Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
[![npm](https://img.shields.io/npm/v/prettier-tslint.svg?style=flat-square)](https://npmjs.org/prettier-tslint)
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square)](https://github.com/semantic-release/semantic-release)
[![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](LICENSE)

## Install

With `npm`:

```bash
npm install --save-dev prettier-tslint
```

Or with `yarn`:

```bash
yarn add --dev prettier-tslint
```

`prettier-tslint` allows you to install your own version of `prettier` and
`typescript`, so make sure you've installed them, too.

## Configuration

`prettier-tslint` find and will respect:

* `prettier`'s `.prettierrc`, or any other config file such as `package.json`.
* `prettier`'s `.prettierignore` file.
* `tslint`'s `tslint.json`.

`prettier-tslint` has no additional configuration.

## CLI

```
Commands:
  fix    Fix one or more files
  check  List files that aren't formatted

Options:
  --version  Show version number                                       [boolean]
  --help     Show help                                                 [boolean]

Examples:
  prettier-tslint fix file1.ts file2.ts  Fix provided files
  prettier-tslint fix '**/*.ts'          Fix all TypeScript files
  prettier-tslint check '**/*.ts'        List all unformatted TypeScript files
```

## API

```js
import { fix, check } from "prettier-tslint";

check("file.ts"); // -> false
fix("file.ts");
check("file.ts"); // -> true
```

Currently the `fix` function will write to disk and not return anything. This behavior **may change** in a minor release before `1.0.0` is released.

## Contributing

See [`CONTRIBUTING.md`](CONTRIBUTING.md)

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