@taskade/eslint-plugin Configurations

This plugin provides ESLint configurations for Taskade projects, compatible with ESLint v9 flat config.

Usage with ESLint v9 Flat Config

Installation

npm install --save-dev @taskade/eslint-plugin eslint@^9.0.0

Basic Usage

// eslint.config.js
import js from '@eslint/js';
import typescriptEslint from 'typescript-eslint';
import taskade from '@taskade/eslint-plugin';

export default [
  js.configs.recommended,
  ...typescriptEslint.configs.recommended,
  {
    files: ['**/*.{js,jsx,ts,tsx}'],
    plugins: {
      '@taskade': taskade,
    },
    languageOptions: {
      parser: typescriptEslint.parser,
      parserOptions: {
        project: './tsconfig.json',
      },
    },
    rules: {
      ...taskade.configs.base.rules,
      // Add custom overrides here
    },
  },
];

Usage for Non-React Projects

For projects that don't use React (like Node.js libraries, CLI tools, etc.), use the base-no-react configuration:

// eslint.config.js
import js from '@eslint/js';
import typescriptEslint from 'typescript-eslint';
import taskade from '@taskade/eslint-plugin';

export default [
  js.configs.recommended,
  ...typescriptEslint.configs.recommended,
  {
    files: ['**/*.{js,ts}'], // Note: no jsx/tsx files
    plugins: {
      '@taskade': taskade,
    },
    languageOptions: {
      parser: typescriptEslint.parser,
      parserOptions: {
        project: './tsconfig.json',
      },
    },
    rules: {
      ...taskade.configs['base-no-react'].rules,
      // Add custom overrides here
    },
  },
];

Using Recommended Configuration

// eslint.config.js
import js from '@eslint/js';
import typescriptEslint from 'typescript-eslint';
import taskade from '@taskade/eslint-plugin';

export default [
  js.configs.recommended,
  ...typescriptEslint.configs.recommended,
  {
    files: ['**/*.{js,jsx,ts,tsx}'],
    plugins: {
      '@taskade': taskade,
      '@typescript-eslint': typescriptEslint.plugin,
      'simple-import-sort': simpleImportSort,
    },
    languageOptions: {
      parser: typescriptEslint.parser,
    },
    rules: {
      ...taskade.configs.base.rules,
      ...taskade.configs.recommended.rules,
    },
  },
];

Available Configurations

base

Base configuration with Prettier and React support.

base-no-react

Base configuration with Prettier support but without React dependencies. Ideal for Node.js projects, libraries, or any TypeScript/JavaScript projects that don't use React.

recommended

Additional TypeScript and import sorting rules for enhanced code quality. Includes custom Taskade rules.

Custom Rules in Recommended Configuration

• @taskade/no-destructuring-params - Disallows destructuring in function parameters to avoid complexity and potential runtime errors with null values. Encourages using regular parameters with optional chaining instead.

Migrating from ESLint v8

If you're upgrading from ESLint v8, you'll need to:

1. Update your .eslintrc.* files to eslint.config.js
2. Use the flat config format shown above
3. Install the required dependencies: @eslint/js, typescript-eslint, globals
4. Update your plugins to use object syntax instead of string arrays

Custom Rules

@taskade/no-destructuring-params

Disallows destructuring in function parameters. This rule helps avoid complexity and potential runtime errors that can occur with destructuring parameters, especially when dealing with null values.

❌ Incorrect

function foo({ bar = true } = {}) {
  return bar;
}

const handleEvent = ({ target, preventDefault }) => {
  preventDefault();
  console.log(target);
};

class MyClass {
  processData({ id, value }) {
    // ...
  }
}

✅ Correct

function foo(options) {
  const bar = options?.bar ?? true;
  return bar;
}

const handleEvent = (event) => {
  const { target, preventDefault } = event;
  preventDefault();
  console.log(target);
};

class MyClass {
  processData(data) {
    const { id, value } = data;
    // ...
  }
}

Rationale

1. Clarity: Regular parameters are easier to understand and debug
2. Null Safety: Using optional chaining (?.) and nullish coalescing (??) handles null/undefined values more predictably
3. Performance: Avoids implicit object creation when default parameters are used
4. TypeScript Compatibility: Works better with strict null checks