@truenine/eslint10-config

An ESLint 10 configuration package optimised for Compose Client projects, providing caching optimisation, performance tuning, and rule optimisation features.

Features

Performance Optimisation

• Smart Caching: Support for efficient caching strategies
• Parallel Processing: Auto-utilise multi-core CPU for parallel linting
• Rule Optimisation: Option to skip performance-intensive rules
• Progressive Checking: Priority checking for critical files

Preset Configs

• performance: Performance-first, suitable for large projects or CI environments
• quality: Quality-first, suitable for small projects or dev environments
• balanced: Balanced configuration, default recommendation
• ci: CI environment-specific config
• dev: Dev environment-friendly config
• library: Library project strict config

Smart Ignores

• Auto-ignore build artefacts, cache directories, compressed files, etc.
• Configurable priority checking for critical files
• Support for custom ignore patterns

Usage

Basic Usage

// eslint.config.mjs
import eslint10 from '@truenine/eslint10-config'

export default eslint10({
  type: 'lib',
  typescript: {
    strictTypescriptEslint: true,
    tsconfigPath: './tsconfig.json',
  },
})

Using Preset Configs

// eslint.config.mjs
import eslint10, { applyPreset } from '@truenine/eslint10-config'

export default eslint10({
  type: 'lib',
  typescript: {
    strictTypescriptEslint: true,
    tsconfigPath: './tsconfig.json',
  },
  // Use balanced preset
  ...applyPreset('balanced'),
})

Preset Config Details

Performance Preset

Suitable for large projects or CI environments, prioritising linting speed.

Quality Preset

Suitable for small projects or dev environments, prioritising code quality.

Balanced Preset

Default recommended config, balancing performance and quality.

CI Preset

Optimised for continuous integration environments.

Dev Preset

Dev environment-friendly config.

Library Preset

Suitable for open source libraries or component libraries.

Uniapp Config

// eslint.config.mjs
import eslint10 from '@truenine/eslint10-config'

export default eslint10({
  vue: true,
  uniapp: true,
})

Performance Optimisation Tips

1. Enable Caching: Add caching parameters in package.json scripts.
2. Use Appropriate Presets: Choose the most suitable preset based on environment.
3. Configure Ignore Patterns: Ensure files not needing linting (e.g., dist, build, node_modules) are ignored.
4. Progressive Checking: For large projects, enable progressive checking feature.