DEV Community

Cover image for Avoid Cross Module Dependencies with Dependency Cruiser
Jakub Andrzejewski
Jakub Andrzejewski

Posted on

Avoid Cross Module Dependencies with Dependency Cruiser

As applications grow, maintaining a clean architecture becomes increasingly difficult.

At first, everything feels manageable but after a few months (or years), projects often become full of:

  • circular dependencies
  • deeply coupled modules
  • messy import paths
  • forbidden cross-layer imports
  • architectural chaos

The worst part is that these problems usually grow silently over time.

This is where dependency-cruiser becomes incredibly useful. It helps you visualize and enforce rules for your project dependencies before things become unmaintainable.

In this article, we’ll explore:

  • What dependency-cruiser is
  • What problems it solves
  • How to set it up
  • Practical examples
  • How to enforce architectural boundaries

Let’s dive in.

πŸ€” What Is dependency-cruiser?

dependency-cruiser is a powerful tool for analyzing and validating dependencies in JavaScript and TypeScript projects.

It scans your project imports and helps you:

  • detect circular dependencies
  • enforce architecture rules
  • visualize dependency graphs
  • identify unused modules
  • prevent bad import patterns

Think of it like:

πŸ‘‰ β€œESLint for your project architecture.”

🟒 What Problem Does dependency-cruiser Solve?

In large applications, dependencies can quickly become messy.

Example problems:

❌ Circular dependencies

A β†’ B β†’ C β†’ A
Enter fullscreen mode Exit fullscreen mode

These can cause:

  • runtime issues
  • undefined values
  • difficult debugging
  • unpredictable behavior

❌ Layer violations

Example:

components β†’ api β†’ components
Enter fullscreen mode Exit fullscreen mode

Or:

ui β†’ backend β†’ ui
Enter fullscreen mode Exit fullscreen mode

This breaks separation of concerns.

❌ Shared modules becoming dumping grounds

You often end up with:

/utils
/shared
/helpers
Enter fullscreen mode Exit fullscreen mode

containing everything.

Over time:

  • dependencies become tangled
  • architecture loses structure

βœ… dependency-cruiser helps enforce boundaries

You can define rules like:

  • β€œUI cannot import backend”
  • β€œFeature modules cannot depend on each other”
  • β€œNo circular dependencies allowed”

And automatically validate them in CI.

🟒 Installing dependency-cruiser

Setup is very simple.

Install it:

npm install --save-dev dependency-cruiser
Enter fullscreen mode Exit fullscreen mode

🟒 Generating Your First Dependency Graph

One of the coolest features is visualization.

Example:

npx depcruise src --include-only "^src" --output-type dot | dot -T svg > dependency-graph.svg
Enter fullscreen mode Exit fullscreen mode

This generates a visual graph of your project dependencies.

You can quickly spot:

  • circular dependencies
  • overly connected modules
  • problematic architecture

In large projects, this is incredibly eye-opening.

🟒 Creating Rules

The real power comes from architecture validation.

Example config:

module.exports = {
  forbidden: [
    {
      name: 'no-circular',
      severity: 'error',
      from: {},
      to: {
        circular: true
      }
    }
  ]
}
Enter fullscreen mode Exit fullscreen mode

Now dependency-cruiser will fail whenever circular dependencies appear.

🟒 Real-World Example: Enforcing Layered Architecture

Imagine this structure:

src/
β”œβ”€β”€ components/
β”œβ”€β”€ features/
β”œβ”€β”€ api/
β”œβ”€β”€ utils/
Enter fullscreen mode Exit fullscreen mode

You may want:

πŸ‘‰ components should never import from api

Rule example:

module.exports = {
  forbidden: [
    {
      name: 'no-components-to-api',
      from: {
        path: '^src/components'
      },
      to: {
        path: '^src/api'
      }
    }
  ]
}
Enter fullscreen mode Exit fullscreen mode

Now architecture rules become automated.

This is extremely valuable for:

  • large teams
  • enterprise projects
  • monorepos
  • long-term maintainability

🟒 Using dependency-cruiser with Vue Projects

dependency-cruiser works great with:

  • Vue
  • Nuxt
  • React
  • Angular
  • Node.js
  • TypeScript monorepos

For Vue apps, it’s especially useful when managing:

  • composables
  • feature modules
  • shared UI components
  • store architecture
  • layered frontend structure

Example issue it can prevent:

components β†’ composables β†’ components
Enter fullscreen mode Exit fullscreen mode

Which can become very difficult to maintain later.

🟒 CI Integration

One of the best things about dependency-cruiser:

πŸ‘‰ It can run automatically in CI/CD pipelines.

Example:

npx depcruise src --validate .dependency-cruiser.js
Enter fullscreen mode Exit fullscreen mode

Now pull requests fail when architecture rules are violated.

This prevents technical debt from growing silently.

🟒 Common Mistakes

❌ Creating overly strict rules too early

Start simple.

Too many restrictions can frustrate teams.

❌ Ignoring the reports

The tool is only useful if rules are actually enforced.

❌ Not visualizing dependencies

Graphs often reveal architecture problems immediately.

❌ Allowing shared folders to grow uncontrollably

dependency-cruiser helps expose this early.

πŸ§ͺ Best Practices

  • Start with circular dependency detection
  • Gradually add architectural rules
  • Integrate validation into CI
  • Use dependency graphs regularly
  • Keep rules aligned with real architecture decisions
  • Avoid massive shared utility folders
  • Use the tool proactively β€” not only after problems appear

πŸ“– Learn more

If you would like to learn more about Vue, Nuxt, JavaScript or other useful technologies, checkout VueSchool by clicking this link or by clicking the image below:

Vue School Link

It covers most important concepts while building modern Vue or Nuxt applications that can help you in your daily work or side projects πŸ˜‰

πŸ§ͺ Advance skills

A certification boosts your skills, builds credibility, and opens doors to new opportunities. Whether you're advancing your career or switching paths, it's a smart step toward success.

Check out Certificates.dev by clicking this link or by clicking the image below:

Certificates.dev Link

Invest in yourselfβ€”get certified in Vue.js, JavaScript, Nuxt, Angular, React, and more!

βœ… Summary

dependency-cruiser is an incredibly valuable tool for keeping project architecture healthy as applications grow.

Good architecture rarely happens accidentally.

Tools like dependency-cruiser help teams maintain structure, reduce technical debt, and prevent dependency chaos before it becomes a serious problem.

Take care!
And happy coding as always πŸ–₯️

Top comments (0)