@thunderid/eslint-plugin

ESLint plugin for ⚡️ ThunderID projects with custom rules and configurations.

Installation

npm install --save-dev @thunderid/eslint-plugin eslint
# or
pnpm add -D @thunderid/eslint-plugin eslint

Usage

ESLint Flat Config (ESLint 9+)

// eslint.config.js
import thunderIdPlugin from '@thunderid/eslint-plugin';

export default [
  {
    plugins: {
      '@thunderid': thunderIdPlugin,
    },
    rules: {
      '@thunderid/copyright-header': 'error',
      '@thunderid/no-internal-imports': 'error',
      '@thunderid/prefer-system-utils': 'warn',
    },
  },
  // Or use a predefined config
  ...thunderIdPlugin.configs.recommended,
];

Predefined Configurations

recommended

General rules for all frontend projects:

• @thunderid/copyright-header: Enforces the Apache 2.0 SPDX copyright header
• @thunderid/no-internal-imports: Prevents importing from internal paths

typescript

Rules for TypeScript projects:

• Extends @typescript-eslint/recommended
• @thunderid/copyright-header: Enforces copyright headers
• @thunderid/no-internal-imports: Prevents internal imports

react

Rules for React projects:

• Extends plugin:react/recommended and plugin:react-hooks/recommended
• @thunderid/copyright-header: Enforces copyright headers
• @thunderid/no-internal-imports: Prevents internal imports
• React-specific rules and settings

next

Rules for Next.js projects:

• Extends next/core-web-vitals
• @thunderid/copyright-header: Enforces copyright headers
• @thunderid/no-internal-imports: Prevents internal imports

Rules for TypeScript frontend projects:

• @thunderid/copyright-header: Enforces copyright headers
• @thunderid/no-internal-imports: Prevents internal imports

Rules

@thunderid/copyright-header

Enforces the presence of the Apache 2.0 SPDX copyright header in all source files.

Options:

• excludePatterns: Array of regex patterns for files to exclude
• template: Custom copyright header template

Examples:

// ❌ Incorrect - missing header
export const foo = 'bar';

// ✅ Correct - has proper header
// Copyright 2025 The ThunderID Authors
// SPDX-License-Identifier: Apache-2.0
export const foo = 'bar';

@thunderid/no-internal-imports

Prevents importing from internal directories of other modules to maintain proper module boundaries.

Options:

• allowedPatterns: Array of regex patterns for allowed internal imports
• forbiddenPatterns: Array of regex patterns for forbidden imports

Examples:

// ❌ Incorrect - importing from internal path
import {secret} from 'package/internal/secret';
import {build} from 'package/lib/build';

// ✅ Correct - using public API
import {publicApi} from 'package';
import {helper} from './helper'; // relative imports are OK

Development

Building

pnpm build

Testing

pnpm test

Linting

pnpm lint

License

Apache 2.0 - see LICENSE file for details.