codelytv / eslint-plugin-hexagonal-architecture

A plugin that helps you to enforce hexagonal architecture best practises

🎯 Codely's ESLint Hexagonal Architecture plugin

A plugin that helps you to enforce hexagonal architecture best practises. Valid for your JavaScript or TypeScript projects 🤟 Stars are welcome 😊

🤔 What it does

• Enforce conventional folder naming: only domain, application and infrastructure are valid folder names (under the glob pattern you specify)
• Prevent imports from restricted layers:
  • domain can only import files from the same folder
  • application can only import from application and domain
  • infrastructure can import from application, domain and infrastructure

👀 How to use

1. Install the dependency

   npm install --save-dev eslint-plugin-hexagonal-architecture

2. Add the plugin to your .eslintrc.js file:

   {
     plugins: ["hexagonal-architecture"],
   }

3. 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:

• ✨🌱 JavaScript Basic Skeleton
• 🔷🌱 TypeScript Basic Skeleton
• 🔷🕸️ TypeScript Web Skeleton
• 🔷🌍 TypeScript API Skeleton
• 🔷✨ TypeScript DDD Skeleton

eslint-plugin-hexagonal-architecture's Issues

Implementación con Vue

¡Hola!

¿Es posible usar este plugin con Vue, cómo podría ser?

Gracias

Missleading naming of this plugin (Not Hexagonal architecture)

Hello.
The name of this plugin can lead many to believe, that this has something to do with Hexagonal architecture and might promote a false premise, that Hexagonal architecture has something to do with number of layers and their structure in your Application core, which it really does not.

Hexagonal architecture is originally named ports and adapters architecture, because its main premise is that you hide parts of the application, ussially technology specific (UI, DB, CLI) and technology agnostic code (Application core) respectively, behind "ports". Additionally Hexagonal architecture usually splits into 3 parts. Driven part, Application core and Driving part. Driving part initiates interaction, calls Application core through a port and that then may or may not call Driven port to get data or anything else.

It does not tell you much or anything about how to structure Application core (that is btw why it pairs well with architectures aimed at structuring the domain related code like DDD).

I suggest adding at least a note, that this does not reflect the architecture and its main principle, but rather enforces opinionated folder structure inspired by hexagonal architecture.