mirror of
https://github.com/n8n-io/n8n.git
synced 2024-11-10 06:34:05 -08:00
0448feec56
* ⚡ Initial setup
* 👕 Update `.eslintignore`
* 👕 Autofix node-param-default-missing (#3173)
* 🔥 Remove duplicate key
* 👕 Add exceptions
* 📦 Update package-lock.json
* 👕 Apply `node-class-description-inputs-wrong-trigger-node` (#3176)
* 👕 Apply `node-class-description-inputs-wrong-regular-node` (#3177)
* 👕 Apply `node-class-description-outputs-wrong` (#3178)
* 👕 Apply `node-execute-block-double-assertion-for-items` (#3179)
* 👕 Apply `node-param-default-wrong-for-collection` (#3180)
* 👕 Apply node-param-default-wrong-for-boolean (#3181)
* Autofixed default missing
* Autofixed booleans, worked well
* ⚡ Fix params
* ⏪ Undo exempted autofixes
* 📦 Update package-lock.json
* 👕 Apply node-class-description-missing-subtitle (#3182)
* ⚡ Fix missing comma
* 👕 Apply `node-param-default-wrong-for-fixed-collection` (#3184)
* 👕 Add exception for `node-class-description-missing-subtitle`
* 👕 Apply `node-param-default-wrong-for-multi-options` (#3185)
* 👕 Apply `node-param-collection-type-unsorted-items` (#3186)
* Missing coma
* 👕 Apply `node-param-default-wrong-for-simplify` (#3187)
* 👕 Apply `node-param-description-comma-separated-hyphen` (#3190)
* 👕 Apply `node-param-description-empty-string` (#3189)
* 👕 Apply `node-param-description-excess-inner-whitespace` (#3191)
* Rule looks good
* Add whitespace rule in eslint config
* :zao: fix
* 👕 Apply `node-param-description-identical-to-display-name` (#3193)
* 👕 Apply `node-param-description-missing-for-ignore-ssl-issues` (#3195)
* ⏪ Revert ":zao: fix"
This reverts commit ef8a76f3df.
* 👕 Apply `node-param-description-missing-for-simplify` (#3196)
* 👕 Apply `node-param-description-missing-final-period` (#3194)
* Rule working as intended
* Add rule to eslint
* 👕 Apply node-param-description-missing-for-return-all (#3197)
* ⚡ Restore `lintfix` command
Co-authored-by: agobrech <[email protected]>
Co-authored-by: Omar Ajoue <[email protected]>
Co-authored-by: agobrech <[email protected]>
Co-authored-by: Michael Kret <[email protected]>
401 lines
13 KiB
JavaScript
401 lines
13 KiB
JavaScript
module.exports = {
|
|
root: true,
|
|
|
|
env: {
|
|
browser: true,
|
|
es6: true,
|
|
node: true,
|
|
},
|
|
|
|
parser: '@typescript-eslint/parser',
|
|
parserOptions: {
|
|
project: ['./packages/*/tsconfig.json'],
|
|
sourceType: 'module',
|
|
},
|
|
ignorePatterns: [
|
|
'.eslintrc.js',
|
|
'**/*.js',
|
|
'**/node_modules/**',
|
|
'**/dist/**',
|
|
'**/test/**',
|
|
'**/templates/**',
|
|
'**/ormconfig.ts',
|
|
'**/migrations/**',
|
|
],
|
|
|
|
overrides: [
|
|
{
|
|
files: './packages/*(cli|core|workflow|node-dev)/**/*.ts',
|
|
plugins: [
|
|
/**
|
|
* Plugin with lint rules for import/export syntax
|
|
* https://github.com/import-js/eslint-plugin-import
|
|
*/
|
|
'eslint-plugin-import',
|
|
|
|
/**
|
|
* @typescript-eslint/eslint-plugin is required by eslint-config-airbnb-typescript
|
|
* See step 2: https://github.com/iamturns/eslint-config-airbnb-typescript#2-install-eslint-plugins
|
|
*/
|
|
'@typescript-eslint',
|
|
|
|
/**
|
|
* Plugin to report formatting violations as lint violations
|
|
* https://github.com/prettier/eslint-plugin-prettier
|
|
*/
|
|
'eslint-plugin-prettier',
|
|
],
|
|
extends: [
|
|
/**
|
|
* Config for typescript-eslint recommended ruleset (without type checking)
|
|
*
|
|
* https://github.com/typescript-eslint/typescript-eslint/blob/1c1b572c3000d72cfe665b7afbada0ec415e7855/packages/eslint-plugin/src/configs/recommended.ts
|
|
*/
|
|
'plugin:@typescript-eslint/recommended',
|
|
|
|
/**
|
|
* Config for typescript-eslint recommended ruleset (with type checking)
|
|
*
|
|
* https://github.com/typescript-eslint/typescript-eslint/blob/1c1b572c3000d72cfe665b7afbada0ec415e7855/packages/eslint-plugin/src/configs/recommended-requiring-type-checking.ts
|
|
*/
|
|
'plugin:@typescript-eslint/recommended-requiring-type-checking',
|
|
|
|
/**
|
|
* Config for Airbnb style guide for TS, /base to remove React rules
|
|
*
|
|
* https://github.com/iamturns/eslint-config-airbnb-typescript
|
|
* https://github.com/airbnb/javascript/tree/master/packages/eslint-config-airbnb-base/rules
|
|
*/
|
|
'eslint-config-airbnb-typescript/base',
|
|
|
|
/**
|
|
* Config to disable ESLint rules covered by Prettier
|
|
*
|
|
* https://github.com/prettier/eslint-config-prettier
|
|
*/
|
|
'eslint-config-prettier',
|
|
],
|
|
rules: {
|
|
// ******************************************************************
|
|
// required by prettier plugin
|
|
// ******************************************************************
|
|
|
|
// The following rule enables eslint-plugin-prettier
|
|
// See: https://github.com/prettier/eslint-plugin-prettier#recommended-configuration
|
|
|
|
'prettier/prettier': 'error',
|
|
|
|
// The following two rules must be disabled when using eslint-plugin-prettier:
|
|
// See: https://github.com/prettier/eslint-plugin-prettier#arrow-body-style-and-prefer-arrow-callback-issue
|
|
|
|
/**
|
|
* https://eslint.org/docs/rules/arrow-body-style
|
|
*/
|
|
'arrow-body-style': 'off',
|
|
|
|
/**
|
|
* https://eslint.org/docs/rules/prefer-arrow-callback
|
|
*/
|
|
'prefer-arrow-callback': 'off',
|
|
|
|
// ******************************************************************
|
|
// additions to base ruleset
|
|
// ******************************************************************
|
|
|
|
// ----------------------------------
|
|
// ESLint
|
|
// ----------------------------------
|
|
|
|
/**
|
|
* https://eslint.org/docs/rules/id-denylist
|
|
*/
|
|
'id-denylist': [
|
|
'error',
|
|
'err',
|
|
'cb',
|
|
'callback',
|
|
'any',
|
|
'Number',
|
|
'number',
|
|
'String',
|
|
'string',
|
|
'Boolean',
|
|
'boolean',
|
|
'Undefined',
|
|
'undefined',
|
|
],
|
|
|
|
'no-void': ['error', { allowAsStatement: true }],
|
|
|
|
// ----------------------------------
|
|
// @typescript-eslint
|
|
// ----------------------------------
|
|
|
|
/**
|
|
* https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/array-type.md
|
|
*/
|
|
'@typescript-eslint/array-type': ['error', { default: 'array-simple' }],
|
|
|
|
/**
|
|
* https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/ban-ts-comment.md
|
|
*/
|
|
'@typescript-eslint/ban-ts-comment': 'off',
|
|
|
|
/**
|
|
* https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/ban-types.md
|
|
*/
|
|
'@typescript-eslint/ban-types': [
|
|
'error',
|
|
{
|
|
types: {
|
|
Object: {
|
|
message: 'Use object instead',
|
|
fixWith: 'object',
|
|
},
|
|
String: {
|
|
message: 'Use string instead',
|
|
fixWith: 'string',
|
|
},
|
|
Boolean: {
|
|
message: 'Use boolean instead',
|
|
fixWith: 'boolean',
|
|
},
|
|
Number: {
|
|
message: 'Use number instead',
|
|
fixWith: 'number',
|
|
},
|
|
Symbol: {
|
|
message: 'Use symbol instead',
|
|
fixWith: 'symbol',
|
|
},
|
|
Function: {
|
|
message: [
|
|
'The `Function` type accepts any function-like value.',
|
|
'It provides no type safety when calling the function, which can be a common source of bugs.',
|
|
'It also accepts things like class declarations, which will throw at runtime as they will not be called with `new`.',
|
|
'If you are expecting the function to accept certain arguments, you should explicitly define the function shape.',
|
|
].join('\n'),
|
|
},
|
|
},
|
|
extendDefaults: false,
|
|
},
|
|
],
|
|
|
|
/**
|
|
* https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/consistent-type-assertions.md
|
|
*/
|
|
'@typescript-eslint/consistent-type-assertions': 'error',
|
|
|
|
/**
|
|
* https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/explicit-member-accessibility.md
|
|
*/
|
|
'@typescript-eslint/explicit-member-accessibility': [
|
|
'error',
|
|
{ accessibility: 'no-public' },
|
|
],
|
|
|
|
/**
|
|
* https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/member-delimiter-style.md
|
|
*/
|
|
'@typescript-eslint/member-delimiter-style': [
|
|
'error',
|
|
{
|
|
multiline: {
|
|
delimiter: 'semi',
|
|
requireLast: true,
|
|
},
|
|
singleline: {
|
|
delimiter: 'semi',
|
|
requireLast: false,
|
|
},
|
|
},
|
|
],
|
|
|
|
/**
|
|
* https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/naming-convention.md
|
|
*/
|
|
'@typescript-eslint/naming-convention': [
|
|
'error',
|
|
{
|
|
selector: 'default',
|
|
format: ['camelCase'],
|
|
},
|
|
{
|
|
selector: 'variable',
|
|
format: ['camelCase', 'snake_case', 'UPPER_CASE'],
|
|
leadingUnderscore: 'allowSingleOrDouble',
|
|
trailingUnderscore: 'allowSingleOrDouble',
|
|
},
|
|
{
|
|
selector: 'property',
|
|
format: ['camelCase', 'snake_case'],
|
|
leadingUnderscore: 'allowSingleOrDouble',
|
|
trailingUnderscore: 'allowSingleOrDouble',
|
|
},
|
|
{
|
|
selector: 'typeLike',
|
|
format: ['PascalCase'],
|
|
},
|
|
{
|
|
selector: ['method', 'function'],
|
|
format: ['camelCase'],
|
|
leadingUnderscore: 'allowSingleOrDouble',
|
|
},
|
|
],
|
|
|
|
/**
|
|
* https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-duplicate-imports.md
|
|
*/
|
|
'@typescript-eslint/no-duplicate-imports': 'error',
|
|
|
|
/**
|
|
* https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-invalid-void-type.md
|
|
*/
|
|
'@typescript-eslint/no-invalid-void-type': 'error',
|
|
|
|
/**
|
|
* https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-misused-promises.md
|
|
*/
|
|
'@typescript-eslint/no-misused-promises': ['error', { checksVoidReturn: false }],
|
|
|
|
/**
|
|
* https://github.com/typescript-eslint/typescript-eslint/blob/v4.30.0/packages/eslint-plugin/docs/rules/no-floating-promises.md
|
|
*/
|
|
'@typescript-eslint/no-floating-promises': ['error', { ignoreVoid: true }],
|
|
|
|
/**
|
|
* https://github.com/typescript-eslint/typescript-eslint/blob/v4.33.0/packages/eslint-plugin/docs/rules/no-namespace.md
|
|
*/
|
|
'@typescript-eslint/no-namespace': 'off',
|
|
|
|
/**
|
|
* https://eslint.org/docs/1.0.0/rules/no-throw-literal
|
|
*/
|
|
'@typescript-eslint/no-throw-literal': 'error',
|
|
|
|
/**
|
|
* https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-unnecessary-boolean-literal-compare.md
|
|
*/
|
|
'@typescript-eslint/no-unnecessary-boolean-literal-compare': 'error',
|
|
|
|
/**
|
|
* https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-unnecessary-qualifier.md
|
|
*/
|
|
'@typescript-eslint/no-unnecessary-qualifier': 'error',
|
|
|
|
/**
|
|
* https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-unused-expressions.md
|
|
*/
|
|
'@typescript-eslint/no-unused-expressions': 'error',
|
|
|
|
/**
|
|
* https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-unused-vars.md
|
|
*/
|
|
'@typescript-eslint/no-unused-vars': ['error', { argsIgnorePattern: '_' }],
|
|
|
|
/**
|
|
* https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/prefer-nullish-coalescing.md
|
|
*/
|
|
'@typescript-eslint/prefer-nullish-coalescing': 'error',
|
|
|
|
/**
|
|
* https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/prefer-optional-chain.md
|
|
*/
|
|
'@typescript-eslint/prefer-optional-chain': 'error',
|
|
|
|
/**
|
|
* https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/promise-function-async.md
|
|
*/
|
|
'@typescript-eslint/promise-function-async': 'error',
|
|
|
|
// ----------------------------------
|
|
// eslint-plugin-import
|
|
// ----------------------------------
|
|
|
|
/**
|
|
* https://github.com/import-js/eslint-plugin-import/blob/master/docs/rules/no-default-export.md
|
|
*/
|
|
'import/no-default-export': 'error',
|
|
|
|
/**
|
|
* https://github.com/import-js/eslint-plugin-import/blob/master/docs/rules/order.md
|
|
*/
|
|
'import/order': 'error',
|
|
|
|
// ******************************************************************
|
|
// overrides to base ruleset
|
|
// ******************************************************************
|
|
|
|
// ----------------------------------
|
|
// ESLint
|
|
// ----------------------------------
|
|
|
|
/**
|
|
* https://eslint.org/docs/rules/class-methods-use-this
|
|
*/
|
|
'class-methods-use-this': 'off',
|
|
|
|
/**
|
|
* https://eslint.org/docs/rules/eqeqeq
|
|
*/
|
|
eqeqeq: 'error',
|
|
|
|
/**
|
|
* https://eslint.org/docs/rules/no-plusplus
|
|
*/
|
|
'no-plusplus': 'off',
|
|
|
|
/**
|
|
* https://eslint.org/docs/rules/object-shorthand
|
|
*/
|
|
'object-shorthand': 'error',
|
|
|
|
/**
|
|
* https://eslint.org/docs/rules/prefer-const
|
|
*/
|
|
'prefer-const': 'error',
|
|
|
|
/**
|
|
* https://eslint.org/docs/rules/prefer-spread
|
|
*/
|
|
'prefer-spread': 'error',
|
|
|
|
// ----------------------------------
|
|
// import
|
|
// ----------------------------------
|
|
|
|
/**
|
|
* https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/prefer-default-export.md
|
|
*/
|
|
'import/prefer-default-export': 'off',
|
|
},
|
|
},
|
|
{
|
|
files: ['./packages/nodes-base/nodes/**/*.ts'],
|
|
plugins: ['eslint-plugin-n8n-nodes-base'],
|
|
rules: {
|
|
"n8n-nodes-base/node-param-default-missing": "error",
|
|
"n8n-nodes-base/node-class-description-missing-subtitle": "error",
|
|
"n8n-nodes-base/node-class-description-inputs-wrong-trigger-node": "error",
|
|
"n8n-nodes-base/node-class-description-inputs-wrong-regular-node": "error",
|
|
"n8n-nodes-base/node-class-description-outputs-wrong": "error",
|
|
"n8n-nodes-base/node-execute-block-double-assertion-for-items": "error",
|
|
"n8n-nodes-base/node-param-default-wrong-for-collection": "error",
|
|
"n8n-nodes-base/node-param-default-wrong-for-boolean": "error",
|
|
"n8n-nodes-base/node-param-collection-type-unsorted-items": "error",
|
|
"n8n-nodes-base/node-param-default-wrong-for-fixed-collection": "error",
|
|
"n8n-nodes-base/node-param-default-wrong-for-multi-options": "error",
|
|
"n8n-nodes-base/node-param-description-excess-inner-whitespace": "error",
|
|
"n8n-nodes-base/node-param-description-empty-string": "error",
|
|
"n8n-nodes-base/node-param-description-comma-separated-hyphen": "error",
|
|
"n8n-nodes-base/node-param-default-wrong-for-simplify": "error",
|
|
"n8n-nodes-base/node-param-description-missing-for-return-all": "error",
|
|
"n8n-nodes-base/node-param-description-missing-final-period": "error",
|
|
"n8n-nodes-base/node-param-description-missing-for-simplify": "error",
|
|
"n8n-nodes-base/node-param-description-missing-for-ignore-ssl-issues": "error",
|
|
"n8n-nodes-base/node-param-description-identical-to-display-name": "error",
|
|
}
|
|
},
|
|
],
|
|
};
|