# eslint-plugin-modular-architecture

> An ESlint plugin to enforce modular architecture and encapsulation

Latest version **0.0.2** (published 2023-09-16) · ISC license · 0 weekly downloads

## Install

```sh
npm install eslint-plugin-modular-architecture
pnpm add eslint-plugin-modular-architecture
yarn add eslint-plugin-modular-architecture
bun add eslint-plugin-modular-architecture
```

## 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.2 |
| Published | 2023-09-16 |
| First published | 2023-09-16 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Node | ^14.17.0 \|\| ^16.0.0 \|\| >= 18.0.0 |
| Dependencies | 2 |
| Unpacked size | 23.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Atar Avraham |
| Maintainers | atar9500 |
| Keywords | eslint, eslintplugin, eslint-plugin |

## Links

- npm: https://www.npmjs.com/package/eslint-plugin-modular-architecture
- npm.io page: https://npm.io/package/eslint-plugin-modular-architecture

## Dependencies (2)

- [minimatch](https://npm.io/package/minimatch.md) ^9.0.3
- [requireindex](https://npm.io/package/requireindex.md) ^1.2.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
- [@inrupt/eslint-config-base](https://npm.io/package/@inrupt/eslint-config-base.md) — 4.5K weekly downloads

## Recent versions

- 0.0.2 (latest) — 2023-09-16
- 0.0.1 — 2023-09-16
- 0.0.0 — 2023-09-16

## README

# eslint-plugin-modular-architecture

An eslint plugin to enforce modular architecture and encapsulation

## Installation

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

```sh
npm i eslint --save-dev
```

Next, install `eslint-plugin-modular-architecture`:

```sh
npm install eslint-plugin-modular-architecture --save-dev
```

## Usage

Add `modular-architecture` to the plugins section of your `.eslintrc` configuration file. You can omit the `eslint-plugin-` prefix:

```json
{
  "plugins": ["modular-architecture"]
}
```

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

```json
{
  "rules": {
    "modular-architecture/import-export-only": 2,
    "modular-architecture/modules-engagement": 2
  }
}
```

## Rules

<!-- begin auto-generated rules list -->

| Name                                                   | Description                               |
| :----------------------------------------------------- | :---------------------------------------- |
| [import-export-only](docs/rules/import-export-only.md) | Enforce import/export only on index files |
| [modules-engagement](docs/rules/modules-engagement.md) | Enforce the rules of engagement           |

<!-- end auto-generated rules list -->

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