# lintier

> Setup ESLint & Prettier in TypeScript projects.

Latest version **3.3.0** (published 2024-10-28) · ISC license · 0 weekly downloads

## Install

```sh
npm install lintier
pnpm add lintier
yarn add lintier
bun add lintier
```

Provides the command `lintier`.

## Health

**Score 35/100 (D)** — status: stable.

Positive: no vulnerabilities.

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

Negative: stale.

## Facts

| | |
|---|---|
| Version | 3.3.0 |
| Published | 2024-10-28 |
| First published | 2020-12-03 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 50.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 33 |
| Maintainers | funkladder |

## Links

- npm: https://www.npmjs.com/package/lintier
- Repository: https://github.com/josh-stillman/lintier
- Homepage: https://github.com/josh-stillman/lintier#readme
- Issues: https://github.com/josh-stillman/lintier/issues
- npm.io page: https://npm.io/package/lintier

## Dependencies (7)

- [ora](https://npm.io/package/ora.md) 5.1.0
- [chalk](https://npm.io/package/chalk.md) 4.1.1
- [execa](https://npm.io/package/execa.md) 4.1.0
- [inquirer](https://npm.io/package/inquirer.md) 7.3.3
- [prettier](https://npm.io/package/prettier.md) 3.3.3
- [commander](https://npm.io/package/commander.md) 6.2.0
- [terminal-link](https://npm.io/package/terminal-link.md) 2.1.1

## Recent versions

- 3.3.0 (latest) — 2024-10-28
- 3.2.0 — 2024-10-11
- 3.1.0 — 2024-09-30
- 3.0.0 — 2024-09-26
- 2.1.0 — 2021-12-29
- 2.0.0 — 2021-06-07
- 1.4.0 — 2021-06-07
- 1.3.0 — 2021-06-07
- 1.2.0 — 2021-05-29
- 1.1.0 — 2021-05-29
- 1.0.3 — 2020-12-03
- 1.0.2 — 2020-12-03
- 1.0.1 — 2020-12-03
- 1.0.0 — 2020-12-03

## README

# Lintier

![E2E Test Status](https://github.com/josh-stillman/lintier/actions/workflows/e2e.yml/badge.svg) [![Version](https://img.shields.io/npm/v/lintier.svg?style=flat-square)](https://www.npmjs.com/package/lintier?activeTab=versions) [![Downloads](https://img.shields.io/npm/dt/lintier.svg?style=flat-square)](https://www.npmjs.com/package/lintier) [![Last commit](https://img.shields.io/github/last-commit/josh-stillman/lintier.svg?style=flat-square)](https://github.com/josh-stillman/lintier/graphs/commit-activity)

### CLI to quickly setup [ESLint](https://eslint.org/) & [Prettier](https://prettier.io/) in [TypeScript](https://www.typescriptlang.org/) projects.  Because linting and formatting are a must, but setup is a pain.

![](https://github.com/josh-stillman/lintier/blob/main/lintier.gif?raw=true)

Lintier works in React, Node, and other Typescript projects. It lets you install [stylelint](https://stylelint.io/) for linting & formatting css, and [lint-staged](https://github.com/okonet/lint-staged#readme) for linting pre-commit. Lintier will install the dependencies, create the config files, and add scripts to your `package.json` file.

Lintier's goal is to provide a minimal foundation, letting you further customize the setup to fit your project's needs.

## Update for ESLint 9

As of Fall 2024, the community is still updating various packages to be compatible with ESLint 9. This version of lintier disables currently incompatible packages like the [airbnb styleguide](https://github.com/airbnb/javascript/issues/2961).

## Usage

Just run `npx lintier@latest` in your project's directory.  Linter will start in interactive mode, letting you choose your project type and configuration.

Alternately, you can specify any of these options to skip the interactive prompts:

  |Options                 |Description
  -------------------------|-------------------------
  |-r, --react             |install react dependencies
  |-n, --node              |install node dependencies
  |-s, --styleLint         |install stylelint
  |-c, --sass              |install sass stylelint config
  |-l, --lintStaged        |install lint-staged and simple-git-hooks
  |-p, --pinned            |use pinned dependency versions that are known to work
  |--help                  |display help for command
  |-V, --version           |output the version number


## Troubleshooting and Pinned Versions

By default, lintier installs the latest dependency versions, which means that breaking changes in those dependencies can break lintier.  A weekly automated end-to-end test helps catch these changes.

If the latest dependency versions aren't working, you can fall back to the last-known working versions by passing the `-p` flag.  (Interactive mode still starts if this is the only flag passed).  The [list](./src/installDependencies/pinnedVersions.json) of known working versions is updated after each successful weekly test run.

If you spot trouble, please open an issue in the GitHub repo.

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