From 57549e2d0fecc33b4498bd3bac3901545689ad29 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Iv=C3=A1n=20Ovejero?= Date: Sun, 6 Oct 2024 20:50:22 +0200 Subject: [PATCH] chore: Remove broken autofix for `node-param-collection-type-unsorted-items` --- README.md | 2 +- ...de-param-collection-type-unsorted-items.md | 2 - ...de-param-collection-type-unsorted-items.ts | 9 +---- ...ram-collection-type-unsorted-items.test.ts | 39 ------------------- 4 files changed, 2 insertions(+), 50 deletions(-) diff --git a/README.md b/README.md index bb1c8b5..449b28c 100644 --- a/README.md +++ b/README.md @@ -125,7 +125,7 @@ In the `community` ruleset, the five `*-still-default` rules allow you to define | [node-filename-against-convention](docs/rules/node-filename-against-convention.md) | `name` in node class description must match the node filename without the `.node.ts` suffix. Example: If `description.name` is `Test`, then filename must be `Test.node.ts`. Version suffix in filename (e.g. `-V2`) is disregarded. | No | | [node-param-array-type-assertion](docs/rules/node-param-array-type-assertion.md) | Array of node parameters must be typed, not type-asserted. | Yes | | [node-param-collection-type-item-required](docs/rules/node-param-collection-type-item-required.md) | Items in collection-type node parameter must not have a `required` property. | Yes | -| [node-param-collection-type-unsorted-items](docs/rules/node-param-collection-type-unsorted-items.md) | Items in collection-type node parameter must be alphabetized by `name` if five or more than five. | Yes | +| [node-param-collection-type-unsorted-items](docs/rules/node-param-collection-type-unsorted-items.md) | Items in collection-type node parameter must be alphabetized by `name` if five or more than five. | No | | [node-param-color-type-unused](docs/rules/node-param-color-type-unused.md) | `string`-type color-related node parameter must be `color`-type. | Yes | | [node-param-default-missing](docs/rules/node-param-default-missing.md) | `default` must be present in a node parameter, except in node parameters under `modes`. | Yes | | [node-param-default-wrong-for-boolean](docs/rules/node-param-default-wrong-for-boolean.md) | `default` for boolean-type node parameter must be a boolean. | Yes | diff --git a/docs/rules/node-param-collection-type-unsorted-items.md b/docs/rules/node-param-collection-type-unsorted-items.md index 3fb4340..1d04799 100644 --- a/docs/rules/node-param-collection-type-unsorted-items.md +++ b/docs/rules/node-param-collection-type-unsorted-items.md @@ -6,8 +6,6 @@ Items in collection-type node parameter must be alphabetized by `name` if five o 📋 This rule is part of the `plugin:n8n-nodes-base/nodes` config. -🔧 Run ESLint with `--fix` option to autofix the issue flagged by this rule. - ## Examples ❌ Example of **incorrect** code: diff --git a/lib/rules/node-param-collection-type-unsorted-items.ts b/lib/rules/node-param-collection-type-unsorted-items.ts index 4d4993f..9491377 100644 --- a/lib/rules/node-param-collection-type-unsorted-items.ts +++ b/lib/rules/node-param-collection-type-unsorted-items.ts @@ -14,11 +14,10 @@ export default utils.createRule({ description: `Items in collection-type node parameter must be alphabetized by \`name\` if ${MIN_ITEMS_TO_ALPHABETIZE_SPELLED_OUT} or more than ${MIN_ITEMS_TO_ALPHABETIZE_SPELLED_OUT}.`, recommended: "strict", }, - fixable: "code", schema: [], messages: { sortItems: - "Alphabetize by 'name'. Order: {{ displayOrder }} [autofixable]", + "Alphabetize by 'name'. Order: {{ displayOrder }} [non-autofixable]", }, }, defaultOptions: [], @@ -45,18 +44,12 @@ export default utils.createRule({ sortedOptions ) ) { - const baseIndentation = utils.getBaseIndentationForOption(options); - - const sorted = utils.formatItems(sortedOptions, baseIndentation); - const displayOrder = utils.toDisplayOrderForCollection(sortedOptions); context.report({ messageId: "sortItems", node: options.ast, data: { displayOrder }, - fix: (fixer) => - fixer.replaceText(options.ast, `options: ${sorted}`), }); } }, diff --git a/tests/node-param-collection-type-unsorted-items.test.ts b/tests/node-param-collection-type-unsorted-items.test.ts index ae4297b..ee4e210 100644 --- a/tests/node-param-collection-type-unsorted-items.test.ts +++ b/tests/node-param-collection-type-unsorted-items.test.ts @@ -120,45 +120,6 @@ ruleTester().run(getRuleName(module), rule, { errors: [ { messageId: "sortItems", data: { displayOrder: "A | B | C | D | E" } }, ], - output: outdent` - const test = { - displayName: 'Test', - name: 'test', - type: 'collection', - default: {}, - options: [ - { - displayName: 'A', - name: 'a', - type: 'boolean', - default: true, - }, - { - displayName: 'B', - name: 'b', - type: 'boolean', - default: true, - }, - { - displayName: 'C', - name: 'c', - type: 'boolean', - default: true, - }, - { - displayName: 'D', - name: 'd', - type: 'boolean', - default: true, - }, - { - displayName: 'E', - name: 'e', - type: 'boolean', - default: true, - }, - ], - };`, }, ], });