Package Exports

eslint-plugin-ddd
eslint-plugin-ddd/src/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (eslint-plugin-ddd) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

eslint-plugin-ddd

ESLint plugin to enforce Domain-Driven Design (DDD) principles in your JavaScript and TypeScript projects.

Installation

pnpm add -D eslint-plugin-ddd

Usage

Add ddd to the plugins section of your .eslintrc configuration file:

{
  "plugins": ["ddd"]
}

Then configure the rules you want to use:

{
  "rules": {
    "ddd/require-spec-file": "error"
  }
}

Using Recommended Config

Alternatively, you can use the recommended configuration:

{
  "extends": ["plugin:ddd/recommended"]
}

Or the strict configuration:

{
  "extends": ["plugin:ddd/strict"]
}

Rules

`require-spec-file`

Enforces that every .js or .ts file containing logic has a corresponding .spec.js or .spec.ts file in the same directory.

Rule Details

This rule ensures test coverage by requiring spec files alongside implementation files that contain logic, promoting test-driven development and maintaining test organization.

What counts as "logic":

Functions with implementations (not just type signatures)
Classes with method implementations
Executable code

Files automatically excluded (no logic):

Type-only files (interfaces, types, enums)
Constant-only files
Simple re-export files

The rule automatically matches the file extension:

.js files require .spec.js files
.ts files require .spec.ts files

Examples of incorrect code:

// src/user-service.js exists
// but src/user-service.spec.js does NOT exist
// ❌ ESLint will report an error

// src/product-repository.ts exists
// but src/product-repository.spec.ts does NOT exist
// ❌ ESLint will report an error

Examples of correct code:

// src/user-service.js exists with logic
// AND src/user-service.spec.js exists
// ✅ No error

// src/product-repository.ts exists with logic
// AND src/product-repository.spec.ts exists
// ✅ No error

// src/constants.js exists with ONLY constants (no logic)
// ✅ No spec file required
export const API_URL = 'https://api.example.com';
export const MAX_RETRIES = 3;

// src/types.ts exists with ONLY types (no logic)
// ✅ No spec file required
export interface User {
  id: string;
  name: string;
}

Options

This rule accepts an options object with the following properties:

excludePatterns (array of strings): Glob patterns to exclude from the spec file requirement

Default exclude patterns:

**/*.spec.js - JavaScript spec files
**/*.spec.ts - TypeScript spec files
**/*.test.js - JavaScript test files
**/*.test.ts - TypeScript test files
**/index.js - JavaScript index files
**/index.ts - TypeScript index files
**/*.d.ts - TypeScript declaration files

Example configuration:

{
  "rules": {
    "ddd/require-spec-file": ["error", {
      "excludePatterns": [
        "**/*.spec.js",
        "**/*.spec.ts",
        "**/*.test.js",
        "**/*.test.ts",
        "**/config/**",
        "**/*.config.js",
        "**/*.config.ts"
      ]
    }]
  }
}

Development

# Install dependencies
pnpm install

# Run tests
pnpm test

# Run tests in watch mode
pnpm test:watch

# Lint the code
pnpm lint

Releasing

This project uses release-it for automated releases.

Setup

Copy the .env.example file to .env:
```
cp .env.example .env
```
Add your tokens to the .env file:
- GITHUB_TOKEN: GitHub Personal Access Token (generate here)
- NPM_TOKEN: NPM Access Token (generate here)

Create a Release

pnpm release

This will:

Run linting and tests
Bump the version
Create a git commit and tag
Push to GitHub
Create a GitHub release
Publish to npm

License

MIT