# opinionated-eslint

> An opinionated TypeScript eslint rigging config based on Rushstack

Latest version **1.0.1** (published 2021-04-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install opinionated-eslint
pnpm add opinionated-eslint
yarn add opinionated-eslint
bun add opinionated-eslint
```

## 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.0.1 |
| Published | 2021-04-05 |
| First published | 2021-04-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 54.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | presciencedata@gmail.com |
| Maintainers | 0x00trace |
| Keywords | eslint, eslint-config, typescript-eslint, rigging, rush |

## Links

- npm: https://www.npmjs.com/package/opinionated-eslint
- Repository: https://github.com/prescience-data/opinionated-eslint
- Issues: https://github.com/prescience-data/opinionated-eslint/issues
- npm.io page: https://npm.io/package/opinionated-eslint

## Dependencies (5)

- [eslint](https://npm.io/package/eslint.md) ^7.23.0
- [@rushstack/eslint-config](https://npm.io/package/@rushstack/eslint-config.md) ^2.3.2
- [@typescript-eslint/parser](https://npm.io/package/@typescript-eslint/parser.md) ^4.20.0
- [@typescript-eslint/eslint-plugin](https://npm.io/package/@typescript-eslint/eslint-plugin.md) ^4.20.0
- [eslint-plugin-simple-import-sort](https://npm.io/package/eslint-plugin-simple-import-sort.md) ^7.0.0

## 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
- [@pandacss/eslint-plugin](https://npm.io/package/@pandacss/eslint-plugin.md) — 18.7K weekly downloads

## Recent versions

- 1.0.1 (latest) — 2021-04-05
- 1.0.0 — 2021-04-05

## README

# Opinionated ESLint

An opinionated ESLint config rigging package based on Rushstack.

## Base Config Setup

Modifies the base [Rushstack ESLint config](https://github.com/microsoft/rushstack/tree/master/stack/eslint-config) to:

- [x] Include import sorting.
- [x] Disable the demand for `I` interface prefixes.
- [x] Disables type specification for [Zod](https://github.com/colinhacks/zod/tree/v3) schema folders.
- [x] Enforce [no require imports](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-require-imports.md).
- [x] Disabled [no parameter properties](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-parameter-properties.md) to enforce public/protected/private.

## Usage

To implement this config in your project, add it to your `devDependencies` and setup your package `.eslintrc.js` file as follows:

```shell
$ npm install -d opinionated-eslint
$ npm install -d @rushstack/eslint-config
$ npm install -d @typescript-eslint/parser
```

```js
require("@rushstack/eslint-config/patch/modern-module-resolution")

module.exports = {
  extends: [
    "@rushstack/eslint-config/profile/node",
    "@rushstack/eslint-config/mixins/friendly-locals",
    "opinionated-eslint",
  ]
}
```


## IDE Setup

Make sure to set up your IDE to auto-apply the rules it can easily fix by enabling `"fix on save"`.


## References

- https://eslint.org/
- https://rushstack.io/pages/heft_tasks/eslint/
- https://github.com/microsoft/rushstack/tree/master/stack/eslint-config

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