[![Build status][build-image]][build-url] [![Coverage Status][coveralls-image]][coveralls-url]

 [![Last commit][last-commit-image]][last-commit-url] [![Last release][release-image]][release-url]

[![NPM downloads][npm-downloads-image]][npm-downloads-url] [![License][license-image]][license-url]

[coveralls-image]: https://coveralls.io/repos/github/javierbrea/eslint-plugin-boundaries/badge.svg
[coveralls-url]: https://coveralls.io/github/javierbrea/eslint-plugin-boundaries
[build-image]: https://github.com/javierbrea/eslint-plugin-boundaries/workflows/build/badge.svg
[build-url]: https://github.com/javierbrea/eslint-plugin-boundaries/actions?query=workflow%3Abuild+branch%3Amaster
[last-commit-image]: https://img.shields.io/github/last-commit/javierbrea/eslint-plugin-boundaries.svg
[last-commit-url]: https://github.com/javierbrea/eslint-plugin-boundaries/commits
[license-image]: https://img.shields.io/npm/l/eslint-plugin-boundaries.svg
[license-url]: https://github.com/javierbrea/eslint-plugin-boundaries/blob/master/LICENSE
[npm-downloads-image]: https://img.shields.io/npm/dm/eslint-plugin-boundaries.svg
[npm-downloads-url]: https://www.npmjs.com/package/eslint-plugin-boundaries
[quality-gate-image]: https://sonarcloud.io/api/project_badges/measure?project=javierbrea_eslint-plugin-boundaries&metric=alert_status
[quality-gate-url]: https://sonarcloud.io/dashboard?id=javierbrea_eslint-plugin-boundaries
[release-image]: https://img.shields.io/github/release-date/javierbrea/eslint-plugin-boundaries.svg
[release-url]: https://github.com/javierbrea/eslint-plugin-boundaries/releases

ESLint Plugin Boundaries

Enforce architectural boundaries in your JavaScript and TypeScript projects.

ESLint Plugin Boundaries is an ESLint plugin that helps you maintain clean architecture by enforcing boundaries between different parts of your codebase. Define your architectural layers, specify how they can interact, and get instant feedback when boundaries are violated.

- Architectural Enforcement: Define element types and dependency rules that match your project's architecture
- Flexible Configuration: Adapt the plugin to any project structure. It works with monorepos, modular architectures, layered patterns, and more
- Real-time Feedback: Get immediate ESLint errors when imports violate your architectural rules

Documentation

The full documentation is available on the JS Boundaries website.

$3

- Overview - Introduction to the plugin and its core concepts
- Quick Start - Set up the plugin in 5 minutes
- Setup Guide - In-depth configuration guide
- Define Elements
- Use Element Selectors
- Configure Rules
- Global Settings
- Rules Reference - Complete documentation for all available rules
- TypeScript Support - Use with TypeScript projects

Quick Example

Install the plugin using npm:

``bash
npm install eslint eslint-plugin-boundaries --save-dev
`

Define your architectural elements:

`javascript
import boundaries from "eslint-plugin-boundaries";

export default [
{
plugins: { boundaries },
settings: {
"boundaries/elements": [
{ type: "controllers", pattern: "controllers/*" },
{ type: "models", pattern: "models/*" },
{ type: "views", pattern: "views/*" }
]
}
}
];
`

Define your dependency rules:

`javascript
{
rules: {
"boundaries/element-types": [2, {
default: "disallow",
rules: [
{ from: "controllers", allow: ["models", "views"] },
{ from: "views", allow: ["models"] },
{ from: "models", disallow: ["*"] }
]
}]
}
}
`

Now ESLint will catch violations:

`javascript
// In src/models/model.js
import View from "../views/view"; // ❌ Error: Architectural boundary violated
``

Contributing

To everyone who has opened an issue, suggested improvements, fixed bugs, added features, or improved documentation: Thank you. Your contributions, no matter how small, make a real difference. Every bug report helps us improve, every feature request guides our roadmap, and every pull request strengthens the project.

Special recognition goes to those who have contributed code to the project. Your technical contributions are the foundation of what makes this plugin valuable to the community.

Want to contribute? We'd love to have you! Here are some ways to get involved:

- Report Issues: Open an issue if you find a bug or have a suggestion
- Participate in Discussions: Join the conversation on our GitHub Discussions. Review RFCs, share ideas, and help shape the future of the project.
- Contribute Code: Check out our Contributing Guidelines

License

MIT © javierbrea