π― Codely's ESLint Hexagonal Architecture plugin
A plugin that helps you to enforce hexagonal architecture best practises. Valid for your JavaScript or TypeScript projects
π€ What it does
- Enforce conventional folder naming: only
domain
,application
andinfrastructure
are valid folder names (under the glob pattern you specify) - Prevent imports from restricted layers:
domain
can only import files from the same folderapplication
can only import fromapplication
anddomain
infrastructure
can import fromapplication
,domain
andinfrastructure
π How to use
- Install the dependency
npm install --save-dev eslint-plugin-hexagonal-architecture
- Add the plugin to your
.eslintrc.js
file:{ plugins: ["hexagonal-architecture"], }
- Enable the rule for the specific folders that will contain your logic using ESLint's Glob Patterns overrides:
{ overrides: [ { files: ["contexts/{backend,frontend}/*/src/**/*.ts"], rules: { "hexagonal-architecture/enforce": ["error"], }, }, ] }
π Codely Code Quality Standards
Publishing this package we are committing ourselves to the following code quality standards:
π€ Respect Semantic Versioning: No breaking changes in patch or minor versionsπ€ No surprises in transitive dependencies: Use the bare minimum dependencies needed to meet the purposeπ― One specific purpose to meet without having to carry a bunch of unnecessary other utilitiesβ Tests as documentation and usage examplesπ Well documented ReadMe showing how to install and useβοΈ License favoring Open Source and collaboration
π Related resources
π¦ Linting en JavaScript y TypeScript: Used as a template to bootstrap this pluginπ€ Codely's ESLint + Prettier configuration: Opinionated linting configuration considering modern TypeScript best practices and providing consistency to your import statements. Valid for your JavaScript or TypeScript projects
Opinionated skeletons ready for different purposes: