# @foomo/eslint-plugin

> eslint utility rules for monorepo project setup

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

## Install

```sh
npm install @foomo/eslint-plugin
pnpm add @foomo/eslint-plugin
yarn add @foomo/eslint-plugin
bun add @foomo/eslint-plugin
```

## 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.1.2 |
| Published | 2021-05-05 |
| First published | 2021-04-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 1 |
| Unpacked size | 10.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | @gosticks |
| Maintainers | gosticks |
| Keywords | eslint, eslintplugin, eslint-plugin |

## Links

- npm: https://www.npmjs.com/package/@foomo/eslint-plugin
- npm.io page: https://npm.io/package/@foomo/eslint-plugin

## Dependencies (1)

- [requireindex](https://npm.io/package/requireindex.md) ~1.1.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

- 0.1.2 (latest) — 2021-05-05
- 0.1.1 — 2021-04-20
- 0.1.0 — 2021-04-20

## README

# @foomo/eslint-plugin

eslint utility rules to effectively handle monorepo setups

## Installation

You'll first need to install [ESLint](http://eslint.org):

```bash
yarn add -D eslint
```

Next, install `@foomo/eslint-plugin`:

```bash
yarn add -D @foomo/eslint-plugin
```

## Usage

Add `@foomo/eslint-plugin` to the plugins section of your `.eslintrc` configuration file:

```json
{
  "plugins": ["@foomo/eslint-plugin"]
}
```

Then configure the rules you want to use under the rules section.

```json
{
  "rules": {
    "@foomo/no-package-imports": ["error", {
      "options": [
        { "invalidPrefix": "packages", "invalidSuffix": "src", "monorepoRoot": "@organization" },
        { "invalidPrefix": "packages", "invalidSuffix": "src", "template": "@organization/$1/custom-prefix/$2" }
      ]
    }]
  }
}
```

## Supported Rules

- no-package-imports:
  fixes forbidden import paths

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