https://github.com/javierbrea/eslint-plugin-boundaries
Eslint plugin checking architecture boundaries between elements
https://github.com/javierbrea/eslint-plugin-boundaries
architectural-patterns architecture dependencies eslint eslint-plugin eslint-rules import quality
Last synced: 3 months ago
JSON representation
Eslint plugin checking architecture boundaries between elements
- Host: GitHub
- URL: https://github.com/javierbrea/eslint-plugin-boundaries
- Owner: javierbrea
- License: mit
- Created: 2020-06-09T13:05:33.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2025-03-28T12:25:51.000Z (about 1 year ago)
- Last Synced: 2025-04-03T06:37:26.781Z (about 1 year ago)
- Topics: architectural-patterns, architecture, dependencies, eslint, eslint-plugin, eslint-rules, import, quality
- Language: JavaScript
- Homepage:
- Size: 1.95 MB
- Stars: 632
- Watchers: 4
- Forks: 12
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-eslint - boundaries - Ensures that your architecture boundaries are respected by the elements in your project checking file structure and dependencies. (Plugins / Practices and Specific ES Features)
- fucking-awesome-eslint - boundaries - Ensures that your architecture boundaries are respected by the elements in your project checking file structure and dependencies. (Plugins / Practices and Specific ES Features)
README
[![Build status][build-image]][build-url] [![Coverage Status][coveralls-image]][coveralls-url]
[](https://renovatebot.com) [![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 elements 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 any custom structure you can imagine
- **Real-time Feedback**: Get immediate ESLint errors when imports violate your architectural rules
## Documentation
The full documentation is available on the [JS Boundaries website](https://www.jsboundaries.dev/docs/overview/).
### Key Sections
- **[Overview](https://www.jsboundaries.dev/docs/overview/)** - Introduction to the plugin and its core concepts
- **[Quick Start](https://www.jsboundaries.dev/docs/quick-start/)** - Set up the plugin in 5 minutes
- **[Setup Guide](https://www.jsboundaries.dev/docs/setup/)** - In-depth configuration guide
- [Define Elements](https://www.jsboundaries.dev/docs/setup/elements/)
- [Use Element Selectors](https://www.jsboundaries.dev/docs/setup/selectors/)
- [Configure Rules](https://www.jsboundaries.dev/docs/setup/rules/)
- [Global Settings](https://www.jsboundaries.dev/docs/setup/settings/)
- **[Rules Reference](https://www.jsboundaries.dev/docs/rules/)** - Complete documentation for all available rules
- **[TypeScript Support](https://www.jsboundaries.dev/docs/guides/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: "controller", pattern: "controllers/*" },
{ type: "model", pattern: "models/*" },
{ type: "view", pattern: "views/*" }
]
}
}
];
```
Define your dependency rules:
```javascript
{
rules: {
"boundaries/dependencies": [2, {
default: "disallow",
rules: [
{ from: { type: "controller" }, allow: { to: { type: ["model", "view"] } } },
{ from: { type: "view" }, allow: { to: { type: "model" } } },
{ from: { type: "model" }, disallow: { to: { type: "*" } } }
]
}]
}
}
```
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](https://github.com/javierbrea/eslint-plugin-boundaries/graphs/contributors). 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](https://github.com/javierbrea/eslint-plugin-boundaries/issues) if you find a bug or have a suggestion
- **Participate in Discussions**: Join the conversation on our [GitHub Discussions](https://github.com/javierbrea/eslint-plugin-boundaries/discussions). Review RFCs, share ideas, and help shape the future of the project.
- **Contribute Code**: Check out our [Contributing Guidelines](https://github.com/javierbrea/eslint-plugin-boundaries/blob/main/.github/CONTRIBUTING.md)
## License
MIT © [javierbrea](https://github.com/javierbrea)