eslint-plugin 1.0.0
Install from the command line:
Learn more about npm packages
$ npm install @taskade/eslint-plugin@1.0.0
Install via package.json:
"@taskade/eslint-plugin": "1.0.0"
About this version
This plugin provides ESLint configurations for Taskade projects, compatible with ESLint v9 flat config.
npm install --save-dev @taskade/eslint-plugin eslint@^9.0.0// 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
},
},
];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
},
},
];// 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,
},
},
];Base configuration with Prettier and React support.
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.
Additional TypeScript and import sorting rules for enhanced code quality. Includes custom Taskade rules.
-
@taskade/no-destructuring-params- Disallows destructuring in function parameters to avoid complexity and potential runtime errors withnullvalues. Encourages using regular parameters with optional chaining instead.
If you're upgrading from ESLint v8, you'll need to:
- Update your
.eslintrc.*files toeslint.config.js - Use the flat config format shown above
- Install the required dependencies:
@eslint/js,typescript-eslint,globals - Update your plugins to use object syntax instead of string arrays
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.
function foo({ bar = true } = {}) {
return bar;
}
const handleEvent = ({ target, preventDefault }) => {
preventDefault();
console.log(target);
};
class MyClass {
processData({ id, value }) {
// ...
}
}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;
// ...
}
}- Clarity: Regular parameters are easier to understand and debug
-
Null Safety: Using optional chaining (
?.) and nullish coalescing (??) handlesnull/undefinedvalues more predictably - Performance: Avoids implicit object creation when default parameters are used
- TypeScript Compatibility: Works better with strict null checks
