Question 1

How do I set up the ESLint hexagonal architecture plugin in my project?

Accepted Answer

Install it via npm, add 'hexagonal-architecture' to plugins in your ESLint config, and enable the rule for specific glob patterns using overrides—refer to the README for detailed examples with contexts like backend/frontend folders.

Question 2

Can I use custom folder names with this plugin?

Accepted Answer

No, the plugin strictly enforces 'domain', 'application', and 'infrastructure' as the only valid folder names under the specified glob pattern, without any customization options, so it's best for projects adhering to standard terminology.

Question 3

What happens if I need to make an exception for an import between layers?

Accepted Answer

The plugin flags such imports as errors, so you might need to restructure your code, use ESLint disable comments (like /* eslint-disable */), or adjust your architecture, but this could lead to maintenance challenges if overused.

Question 4

Is this plugin better than using TypeScript paths or other tools for architecture?

Accepted Answer

It provides automated linting specific to hexagonal architecture rules, whereas TypeScript paths manage imports but don't enforce layer separation. For comprehensive architecture control, you might need to combine this plugin with other tools or manual checks.

Question 5

How does this compare to other ESLint plugins for clean architecture?

Accepted Answer

This plugin is focused solely on hexagonal architecture with minimal dependencies, while others might offer broader rules or support for different patterns like layered or onion architecture, making it a niche but effective choice for strict hexagonal adherence.

eslint-plugin-hexagonal-architecture

What is eslint-plugin-hexagonal-architecture?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions