# eslint-rule-extender

> Utility to extend existing ESLint rules

Latest version **0.0.1** (published 2020-10-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install eslint-rule-extender
pnpm add eslint-rule-extender
yarn add eslint-rule-extender
bun add eslint-rule-extender
```

## 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.0.1 |
| Published | 2020-10-16 |
| First published | 2020-10-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=10 |
| Dependencies | 0 |
| Unpacked size | 8.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 5 |
| Author | Kai Cataldo |
| Maintainers | kaicataldo |
| Keywords | eslint, custom, rule, rules, plugin, plugins |

## Links

- npm: https://www.npmjs.com/package/eslint-rule-extender
- Repository: https://github.com/kaicataldo/eslint-rule-extender
- Homepage: https://github.com/kaicataldo/eslint-rule-extender#readme
- Issues: https://github.com/kaicataldo/eslint-rule-extender/issues
- Funding: https://github.com/sponsors/kaicataldo
- npm.io page: https://npm.io/package/eslint-rule-extender

## 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

- 0.0.1 (latest) — 2020-10-16

## README

# eslint-rule-extender

[![npm](https://img.shields.io/npm/v/eslint-rule-extender.svg?style=flat-square)](https://www.npmjs.com/package/eslint-rule-extender/)
[![node](https://img.shields.io/node/v/eslint-rule-extender.svg?style=flat-square)](https://nodejs.org/en/)

A utility to extend existing ESLint rules.

## Installation

```sh
npm install eslint-rule-extender
```

or

```sh
yarn add eslint-rule-extender
```

## Usage

The default export is a function that takes two arguments and returns the modified rule.

### API

```ts
ruleExtender(originalRule: ESLintRule, options: Object) => ESLintRule;
```

- `originalRule` - The original rule to extend
- options - An object with the desired overrides (options can be viewed [below](#options))

### Example Usage

```js
const ruleExtender = require('eslint-rule-extender');
const { originalRule } = require('eslint-plugin-example');

const extendedRule = ruleExtender(originalRule, options);

module.exports = {
  extendedRule,
};
```

## Options

### `metaOverrides`

Overrides for the original rule's `meta` property. The properties of the `meta` object can be found [here](https://eslint.org/docs/developer-guide/working-with-rules#rule-basics).Options

```js
const extendedRule = ruleExtender(originalRule, {
  metaOverrides: {
    type: 'suggestion',
    fixable: false,
  },
});
```

### `createAdditionalVisitors`

A function that has the same signature as ESLint rules' `create` method. It is passed the [`context`](https://eslint.org/docs/developer-guide/working-with-rules#the-context-object) object and should return a object of visitor callbacks. See [the official ESLint docs](https://eslint.org/docs/developer-guide/working-with-rules#rule-basics) for more details!

### Example Usage

```js
const extendedRule = ruleExtender(originalRule, {
  createAdditionalVisitors(context) {
    return {
      ArrowFunctionExpression(node) {
        context.report({ node, messageId: 'anAdditionalSuggestion' });
      },
    };
  },
});
```

### `reportOverrides`

A function that is called with the report metadata of the original rule's [`context.report()`](https://eslint.org/docs/developer-guide/working-with-rules#contextreport) calls. The return value of this function is a trinary with the following behavior:

- `true`: report with original metadata (unchanged)
- `false`: do not report
- modified report metadata object: report with this metadata instead

### Example Usage

```js
const extendedRule = ruleExtender(originalRule, {
  reportOverrides(meta) {
    return meta.node.type !== 'ThisExpression';
  },
});
```

## Putting It All Together

```js
const ruleExtender = require('eslint-rule-extender');
const { originalRule } = require('eslint-plugin-example');

const extendedRule = ruleExtender(originalRule, {
  metaOverrides: {
    type: 'suggestion',
    fixable: false,
  },
  createAdditionalVisitors(context) {
    return {
      ArrowFunctionExpression(node) {
        context.report({ node, messageId: 'anAdditionalSuggestion' });
      },
    };
  },
  reportOverrides(meta) {
    return meta.node.type !== 'ThisExpression';
  },
});

module.exports = {
  extendedRule,
};
```

## Prior art

- [eslint-rule-composer](https://github.com/not-an-aardvark/eslint-rule-composer)

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