Getting Started

Installation

npm

npm install --save-dev domainlint

pnpm

pnpm add -D domainlint

yarn

yarn add -D domainlint

Or install globally:

npm install -g domainlint

Run your first check

From the root of your project:

domainlint check

This will analyze src/ and report any violations.

Understanding violations

noCrossFeatureDeepImport

A file outside a feature (or in a different feature) imported an internal module directly instead of going through the barrel.

src/pages/home.tsx:5:1 noCrossFeatureDeepImport
  Importing src/features/billing/ui/Button.tsx directly.
  Expected: src/features/billing/index.ts

Fix: import from the feature’s index.ts instead.

noImportCycle

A circular dependency was detected in the module graph.

src/features/auth/session.ts noImportCycle
  Cycle: auth/session.ts → auth/user.ts → auth/session.ts

Fix: break the cycle by extracting shared state to a third module or restructuring dependencies.

Exit codes

Code	Meaning
0	No violations
1	Violations found
2	Internal error (e.g. unreadable tsconfig)

Next steps

• Feature Structure — how domainlint identifies features and barrels
• Configuration — customize paths, extensions, and rule severity
• CLI Reference — all available flags
• Rules — learn about the built-in rules in detail
• Workspaces — monorepo support and cross-package import rules
• CI Integration — add domainlint to your pipeline