# @gravitywelluk/eslint-plugin > Gravitywell defined ESLint rule sets as an ESLint plugin Latest version **4.0.2** (published 2024-04-30) · MIT license · 0 weekly downloads ## Install ```sh npm install @gravitywelluk/eslint-plugin pnpm add @gravitywelluk/eslint-plugin yarn add @gravitywelluk/eslint-plugin bun add @gravitywelluk/eslint-plugin ``` ## 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 | 4.0.2 | | Published | 2024-04-30 | | First published | 2020-10-01 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Node | >=18.0.0 | | Dependencies | 0 | | Unpacked size | 23.6 KB | | Known vulnerabilities | 0 | | Install scripts | no | | Author | GravitywellUK | | Maintainers | gravitywell.uk | | Keywords | gravitywell, gravitywelluk, typescript-eslint, eslint, react-eslint, react-native-eslint | ## Links - npm: https://www.npmjs.com/package/@gravitywelluk/eslint-plugin - Repository: https://github.com/GravitywellUK/eslint-plugin - Homepage: https://github.com/GravitywellUK/eslint-plugin#readme - Issues: https://github.com/GravitywellUK/eslint-plugin/issues - npm.io page: https://npm.io/package/@gravitywelluk/eslint-plugin ## 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 - [@inrupt/eslint-config-base](https://npm.io/package/@inrupt/eslint-config-base.md) — 4.5K weekly downloads ## Recent versions - 4.0.2 (latest) — 2024-04-30 - 4.0.1 — 2024-04-30 - 3.0.2 — 2023-02-10 - 3.0.1 — 2023-02-10 - 2.0.1 — 2021-10-26 - 1.0.38 — 2021-08-25 - 1.0.37 — 2021-08-19 - 1.0.36 — 2021-08-10 - 1.0.35 — 2021-06-15 - 1.0.34 — 2021-06-15 - 1.0.33 — 2021-06-15 - 1.0.32 — 2021-05-07 - 1.0.31 — 2020-12-17 - 1.0.30 — 2020-12-16 - 1.0.29 — 2020-12-16 - … 23 more at https://npm.io/package/@gravitywelluk/eslint-plugin/versions ## README

Gravitywell ESLint Plugin

Gravitywell defined ESLint rule sets for ESLint.

CI License Downloads Version


## Table of Contents - [Table of Contents](#table-of-contents) - [Getting started / Installation](#getting-started--installation) - [Usage](#usage) - [`@gravitywelluk/eslint-recommended`](#gravitywellukeslint-recommended) - [`@gravitywelluk/typescript-recommended`](#gravitywelluktypescript-recommended) - [`@gravitywelluk/react-recommended`](#gravitywellukreact-recommended) - [`@gravitywelluk/react-native-recommended`](#gravitywellukreact-native-recommended) - [Contributing](#contributing) ## Getting started / Installation ``` # Yarn yarn add -D @gravitywelluk/eslint-plugin # NPM npm install --save-dev @gravitywelluk/eslint-plugin ``` ## Usage In your `.eslintrc` file, add the package as a plugin. ``` plugins: [ "@gravitywelluk/eslint-plugin" ] ``` There are 4 configurations to choose from: - `@gravitywelluk/eslint-recommended` - `@gravitywelluk/typescript-recommended` - `@gravitywelluk/react-recommended` - `@gravitywelluk/react-native-recommended` **Note:** You will only need to **choose ONE from the list above** as they inherit each other. Make sure that it is placed last in the `extends` array. ``` plugins: [ "@gravitywelluk/eslint-plugin" ] extends: [ "plugin:@gravitywelluk/react-recommended" ], ``` ### `@gravitywelluk/eslint-recommended` ``` extends: [ "plugin:@gravitywelluk/eslint-recommended" ], ``` This includes the following plugins and rules including Gravitywell's own override rules: - eslint - eslint:recommended - eslint-plugin-import - plugin:import/errors - plugin:import/warnings - eslint-plugin-json - plugin:json/recommended ### `@gravitywelluk/typescript-recommended` ``` extends: [ "plugin:@gravitywelluk/typescript-recommended" ], ``` This includes `@gravitywelluk/eslint-recommended` and the following plugins and rules : - @gravitywelluk/eslint-recommended - @typescript-eslint/eslint-plugin - plugin:@typescript-eslint/eslint-recommended - plugin:@typescript-eslint/recommended - eslint-plugin-import - plugin:import/typescript ### `@gravitywelluk/react-recommended` ``` extends: [ "plugin:@gravitywelluk/react-recommended" ], ``` This includes `@gravitywelluk/typescript-recommended` and the following plugins and rules: - @gravitywelluk/typescript-recommended - react - plugin:react/recommended - react-hooks - plugin:react-hooks/recommended ### `@gravitywelluk/react-native-recommended` ``` extends: [ "plugin:@gravitywelluk/react-native-recommended" ], ``` This includes `@gravitywelluk/react-recommended` and the following plugins and rules : - @gravitywelluk/react-recommended - @react-native-community/eslint-config ## Contributing To contribute to this package you will need to first setup access to NPM packages. 1. You will firstly need to create an NPM **Access Token**. Use the following link on [Creating and viewing authentication tokens](https://docs.npmjs.com/creating-and-viewing-authentication-tokens). 2. You will then need to add the following to your `~/.npmrc` file. ``` //registry.npmjs.org/:_authToken=ACCESS_TOKEN ``` 3. Contribute using the **Git Truck** flow (`pull-request` > `master`). **Note:** Publishing is automated via a CI workflow. --- _Source: https://npm.io/package/@gravitywelluk/eslint-plugin · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._