@n8n/eslint-plugin-community-nodes 0.21.0 → 0.23.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.turbo/turbo-build$colon$unchecked.log +1 -1
- package/README.md +52 -46
- package/dist/plugin.d.ts +36 -0
- package/dist/plugin.d.ts.map +1 -1
- package/dist/plugin.js +12 -0
- package/dist/plugin.js.map +1 -1
- package/dist/rules/ai-node-package-json.d.ts.map +1 -1
- package/dist/rules/ai-node-package-json.js +4 -3
- package/dist/rules/ai-node-package-json.js.map +1 -1
- package/dist/rules/index.d.ts +6 -0
- package/dist/rules/index.d.ts.map +1 -1
- package/dist/rules/index.js +12 -0
- package/dist/rules/index.js.map +1 -1
- package/dist/rules/no-asterisk-in-option-names.d.ts +2 -0
- package/dist/rules/no-asterisk-in-option-names.d.ts.map +1 -0
- package/dist/rules/no-asterisk-in-option-names.js +90 -0
- package/dist/rules/no-asterisk-in-option-names.js.map +1 -0
- package/dist/rules/no-duplicate-param-options.d.ts +2 -0
- package/dist/rules/no-duplicate-param-options.d.ts.map +1 -0
- package/dist/rules/no-duplicate-param-options.js +97 -0
- package/dist/rules/no-duplicate-param-options.js.map +1 -0
- package/dist/rules/node-class-description-name-camelcase.d.ts +2 -0
- package/dist/rules/node-class-description-name-camelcase.d.ts.map +1 -0
- package/dist/rules/node-class-description-name-camelcase.js +92 -0
- package/dist/rules/node-class-description-name-camelcase.js.map +1 -0
- package/dist/rules/require-mit-license.d.ts +2 -0
- package/dist/rules/require-mit-license.d.ts.map +1 -0
- package/dist/rules/require-mit-license.js +57 -0
- package/dist/rules/require-mit-license.js.map +1 -0
- package/dist/rules/require-param-default.d.ts +15 -0
- package/dist/rules/require-param-default.d.ts.map +1 -0
- package/dist/rules/require-param-default.js +75 -0
- package/dist/rules/require-param-default.js.map +1 -0
- package/dist/rules/trigger-node-conventions.d.ts +2 -0
- package/dist/rules/trigger-node-conventions.d.ts.map +1 -0
- package/dist/rules/trigger-node-conventions.js +70 -0
- package/dist/rules/trigger-node-conventions.js.map +1 -0
- package/dist/rules/valid-peer-dependencies.d.ts.map +1 -1
- package/dist/rules/valid-peer-dependencies.js +5 -3
- package/dist/rules/valid-peer-dependencies.js.map +1 -1
- package/dist/typecheck.tsbuildinfo +1 -1
- package/docs/rules/no-asterisk-in-option-names.md +61 -0
- package/docs/rules/no-duplicate-param-options.md +46 -0
- package/docs/rules/node-class-description-name-camelcase.md +41 -0
- package/docs/rules/require-mit-license.md +38 -0
- package/docs/rules/require-param-default.md +60 -0
- package/docs/rules/trigger-node-conventions.md +49 -0
- package/docs/rules/valid-peer-dependencies.md +1 -1
- package/package.json +6 -5
- package/src/plugin.ts +12 -0
- package/src/rules/ai-node-package-json.test.ts +5 -0
- package/src/rules/ai-node-package-json.ts +4 -3
- package/src/rules/index.ts +12 -0
- package/src/rules/no-asterisk-in-option-names.test.ts +185 -0
- package/src/rules/no-asterisk-in-option-names.ts +111 -0
- package/src/rules/no-duplicate-param-options.test.ts +125 -0
- package/src/rules/no-duplicate-param-options.ts +125 -0
- package/src/rules/node-class-description-name-camelcase.test.ts +121 -0
- package/src/rules/node-class-description-name-camelcase.ts +114 -0
- package/src/rules/require-mit-license.test.ts +67 -0
- package/src/rules/require-mit-license.ts +65 -0
- package/src/rules/require-param-default.test.ts +227 -0
- package/src/rules/require-param-default.ts +89 -0
- package/src/rules/trigger-node-conventions.test.ts +110 -0
- package/src/rules/trigger-node-conventions.ts +92 -0
- package/src/rules/valid-peer-dependencies.test.ts +5 -0
- package/src/rules/valid-peer-dependencies.ts +5 -3
package/dist/rules/index.js
CHANGED
|
@@ -11,10 +11,12 @@ import { IconPreferThemedVariantsRule } from './icon-prefer-themed-variants.js';
|
|
|
11
11
|
import { IconValidationRule } from './icon-validation.js';
|
|
12
12
|
import { MissingPairedItemRule } from './missing-paired-item.js';
|
|
13
13
|
import { N8nObjectValidationRule } from './n8n-object-validation.js';
|
|
14
|
+
import { NoAsteriskInOptionNamesRule } from './no-asterisk-in-option-names.js';
|
|
14
15
|
import { NoBuilderHintLeakageRule } from './no-builder-hint-leakage.js';
|
|
15
16
|
import { NoCredentialReuseRule } from './no-credential-reuse.js';
|
|
16
17
|
import { NoDangerousFunctionsRule } from './no-dangerous-functions.js';
|
|
17
18
|
import { NoDeprecatedWorkflowFunctionsRule } from './no-deprecated-workflow-functions.js';
|
|
19
|
+
import { NoDuplicateParamOptionsRule } from './no-duplicate-param-options.js';
|
|
18
20
|
import { NoEmojiInOptionsRule } from './no-emoji-in-options.js';
|
|
19
21
|
import { NoForbiddenLifecycleScriptsRule } from './no-forbidden-lifecycle-scripts.js';
|
|
20
22
|
import { NoHttpRequestWithManualAuthRule } from './no-http-request-with-manual-auth.js';
|
|
@@ -24,6 +26,7 @@ import { NoRestrictedImportsRule } from './no-restricted-imports.js';
|
|
|
24
26
|
import { NoRuntimeDependenciesRule } from './no-runtime-dependencies.js';
|
|
25
27
|
import { NoTemplatePlaceholdersRule } from './no-template-placeholders.js';
|
|
26
28
|
import { NodeClassDescriptionIconMissingRule } from './node-class-description-icon-missing.js';
|
|
29
|
+
import { NodeClassDescriptionNameCamelCaseRule } from './node-class-description-name-camelcase.js';
|
|
27
30
|
import { NodeConnectionTypeLiteralRule } from './node-connection-type-literal.js';
|
|
28
31
|
import { NodeFilenameAgainstConventionRule } from './node-filename-against-convention.js';
|
|
29
32
|
import { NodeOperationErrorItemIndexRule } from './node-operation-error-itemindex.js';
|
|
@@ -33,10 +36,13 @@ import { OptionsSortedAlphabeticallyRule } from './options-sorted-alphabetically
|
|
|
33
36
|
import { PackageNameConventionRule } from './package-name-convention.js';
|
|
34
37
|
import { RequireCommunityNodeKeywordRule } from './require-community-node-keyword.js';
|
|
35
38
|
import { RequireContinueOnFailRule } from './require-continue-on-fail.js';
|
|
39
|
+
import { RequireMitLicenseRule } from './require-mit-license.js';
|
|
36
40
|
import { RequireNodeApiErrorRule } from './require-node-api-error.js';
|
|
37
41
|
import { RequireNodeDescriptionFieldsRule } from './require-node-description-fields.js';
|
|
42
|
+
import { RequireParamDefaultRule } from './require-param-default.js';
|
|
38
43
|
import { RequireVersionRule } from './require-version.js';
|
|
39
44
|
import { ResourceOperationPatternRule } from './resource-operation-pattern.js';
|
|
45
|
+
import { TriggerNodeConventionsRule } from './trigger-node-conventions.js';
|
|
40
46
|
import { ValidAuthorRule } from './valid-author.js';
|
|
41
47
|
import { ValidCredentialReferencesRule } from './valid-credential-references.js';
|
|
42
48
|
import { ValidDescriptionRule } from './valid-description.js';
|
|
@@ -49,6 +55,8 @@ export const rules = {
|
|
|
49
55
|
'credential-password-field': CredentialPasswordFieldRule,
|
|
50
56
|
'no-deprecated-workflow-functions': NoDeprecatedWorkflowFunctionsRule,
|
|
51
57
|
'no-emoji-in-options': NoEmojiInOptionsRule,
|
|
58
|
+
'no-asterisk-in-option-names': NoAsteriskInOptionNamesRule,
|
|
59
|
+
'no-duplicate-param-options': NoDuplicateParamOptionsRule,
|
|
52
60
|
'node-usable-as-tool': NodeUsableAsToolRule,
|
|
53
61
|
'options-sorted-alphabetically': OptionsSortedAlphabeticallyRule,
|
|
54
62
|
'package-name-convention': PackageNameConventionRule,
|
|
@@ -63,8 +71,10 @@ export const rules = {
|
|
|
63
71
|
'icon-validation': IconValidationRule,
|
|
64
72
|
'icon-prefer-themed-variants': IconPreferThemedVariantsRule,
|
|
65
73
|
'resource-operation-pattern': ResourceOperationPatternRule,
|
|
74
|
+
'trigger-node-conventions': TriggerNodeConventionsRule,
|
|
66
75
|
'credential-documentation-url': CredentialDocumentationUrlRule,
|
|
67
76
|
'node-class-description-icon-missing': NodeClassDescriptionIconMissingRule,
|
|
77
|
+
'node-class-description-name-camelcase': NodeClassDescriptionNameCamelCaseRule,
|
|
68
78
|
'cred-class-field-icon-missing': CredClassFieldIconMissingRule,
|
|
69
79
|
'cred-class-name-field-conventions': CredClassNameFieldConventionsRule,
|
|
70
80
|
'cred-class-name-suffix': CredClassNameSuffixRule,
|
|
@@ -79,8 +89,10 @@ export const rules = {
|
|
|
79
89
|
'n8n-object-validation': N8nObjectValidationRule,
|
|
80
90
|
'require-community-node-keyword': RequireCommunityNodeKeywordRule,
|
|
81
91
|
'require-continue-on-fail': RequireContinueOnFailRule,
|
|
92
|
+
'require-mit-license': RequireMitLicenseRule,
|
|
82
93
|
'require-node-api-error': RequireNodeApiErrorRule,
|
|
83
94
|
'require-node-description-fields': RequireNodeDescriptionFieldsRule,
|
|
95
|
+
'require-param-default': RequireParamDefaultRule,
|
|
84
96
|
'require-version': RequireVersionRule,
|
|
85
97
|
'valid-author': ValidAuthorRule,
|
|
86
98
|
'valid-credential-references': ValidCredentialReferencesRule,
|
package/dist/rules/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/rules/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,qBAAqB,EAAE,MAAM,2BAA2B,CAAC;AAClE,OAAO,EAAE,6BAA6B,EAAE,MAAM,oCAAoC,CAAC;AACnF,OAAO,EAAE,iCAAiC,EAAE,MAAM,wCAAwC,CAAC;AAC3F,OAAO,EAAE,uBAAuB,EAAE,MAAM,6BAA6B,CAAC;AACtE,OAAO,EAAE,yBAAyB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,EAAE,iCAAiC,EAAE,MAAM,uCAAuC,CAAC;AAC1F,OAAO,EAAE,8BAA8B,EAAE,MAAM,mCAAmC,CAAC;AACnF,OAAO,EAAE,2BAA2B,EAAE,MAAM,gCAAgC,CAAC;AAC7E,OAAO,EAAE,0BAA0B,EAAE,MAAM,+BAA+B,CAAC;AAC3E,OAAO,EAAE,4BAA4B,EAAE,MAAM,kCAAkC,CAAC;AAChF,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,qBAAqB,EAAE,MAAM,0BAA0B,CAAC;AACjE,OAAO,EAAE,uBAAuB,EAAE,MAAM,4BAA4B,CAAC;AACrE,OAAO,EAAE,wBAAwB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,EAAE,qBAAqB,EAAE,MAAM,0BAA0B,CAAC;AACjE,OAAO,EAAE,wBAAwB,EAAE,MAAM,6BAA6B,CAAC;AACvE,OAAO,EAAE,iCAAiC,EAAE,MAAM,uCAAuC,CAAC;AAC1F,OAAO,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,EAAE,+BAA+B,EAAE,MAAM,qCAAqC,CAAC;AACtF,OAAO,EAAE,+BAA+B,EAAE,MAAM,uCAAuC,CAAC;AACxF,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAC/D,OAAO,EAAE,uBAAuB,EAAE,MAAM,4BAA4B,CAAC;AACrE,OAAO,EAAE,uBAAuB,EAAE,MAAM,4BAA4B,CAAC;AACrE,OAAO,EAAE,yBAAyB,EAAE,MAAM,8BAA8B,CAAC;AACzE,OAAO,EAAE,0BAA0B,EAAE,MAAM,+BAA+B,CAAC;AAC3E,OAAO,EAAE,mCAAmC,EAAE,MAAM,0CAA0C,CAAC;AAC/F,OAAO,EAAE,6BAA6B,EAAE,MAAM,mCAAmC,CAAC;AAClF,OAAO,EAAE,iCAAiC,EAAE,MAAM,uCAAuC,CAAC;AAC1F,OAAO,EAAE,+BAA+B,EAAE,MAAM,qCAAqC,CAAC;AACtF,OAAO,EAAE,4BAA4B,EAAE,MAAM,iCAAiC,CAAC;AAC/E,OAAO,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,EAAE,+BAA+B,EAAE,MAAM,oCAAoC,CAAC;AACrF,OAAO,EAAE,yBAAyB,EAAE,MAAM,8BAA8B,CAAC;AACzE,OAAO,EAAE,+BAA+B,EAAE,MAAM,qCAAqC,CAAC;AACtF,OAAO,EAAE,yBAAyB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,EAAE,uBAAuB,EAAE,MAAM,6BAA6B,CAAC;AACtE,OAAO,EAAE,gCAAgC,EAAE,MAAM,sCAAsC,CAAC;AACxF,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,4BAA4B,EAAE,MAAM,iCAAiC,CAAC;AAC/E,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,6BAA6B,EAAE,MAAM,kCAAkC,CAAC;AACjF,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAE,yBAAyB,EAAE,MAAM,8BAA8B,CAAC;AACzE,OAAO,EAAE,4BAA4B,EAAE,MAAM,iCAAiC,CAAC;AAE/E,MAAM,CAAC,MAAM,KAAK,GAAG;IACpB,sBAAsB,EAAE,qBAAqB;IAC7C,uBAAuB,EAAE,uBAAuB;IAChD,uBAAuB,EAAE,uBAAuB;IAChD,2BAA2B,EAAE,2BAA2B;IACxD,kCAAkC,EAAE,iCAAiC;IACrE,qBAAqB,EAAE,oBAAoB;IAC3C,qBAAqB,EAAE,oBAAoB;IAC3C,+BAA+B,EAAE,+BAA+B;IAChE,yBAAyB,EAAE,yBAAyB;IACpD,0BAA0B,EAAE,0BAA0B;IACtD,qBAAqB,EAAE,qBAAqB;IAC5C,wBAAwB,EAAE,wBAAwB;IAClD,gCAAgC,EAAE,+BAA+B;IACjE,kCAAkC,EAAE,+BAA+B;IACnE,oBAAoB,EAAE,oBAAoB;IAC1C,yBAAyB,EAAE,yBAAyB;IACpD,0BAA0B,EAAE,0BAA0B;IACtD,iBAAiB,EAAE,kBAAkB;IACrC,6BAA6B,EAAE,4BAA4B;IAC3D,4BAA4B,EAAE,4BAA4B;IAC1D,8BAA8B,EAAE,8BAA8B;IAC9D,qCAAqC,EAAE,mCAAmC;IAC1E,+BAA+B,EAAE,6BAA6B;IAC9D,mCAAmC,EAAE,iCAAiC;IACtE,wBAAwB,EAAE,uBAAuB;IACjD,0BAA0B,EAAE,yBAAyB;IACrD,kCAAkC,EAAE,iCAAiC;IACrE,8BAA8B,EAAE,6BAA6B;IAC7D,kCAAkC,EAAE,iCAAiC;IACrE,gCAAgC,EAAE,+BAA+B;IACjE,4BAA4B,EAAE,4BAA4B;IAC1D,qBAAqB,EAAE,qBAAqB;IAC5C,yBAAyB,EAAE,wBAAwB;IACnD,uBAAuB,EAAE,uBAAuB;IAChD,gCAAgC,EAAE,+BAA+B;IACjE,0BAA0B,EAAE,yBAAyB;IACrD,wBAAwB,EAAE,uBAAuB;IACjD,iCAAiC,EAAE,gCAAgC;IACnE,iBAAiB,EAAE,kBAAkB;IACrC,cAAc,EAAE,eAAe;IAC/B,6BAA6B,EAAE,6BAA6B;IAC5D,mBAAmB,EAAE,oBAAoB;IACzC,yBAAyB,EAAE,yBAAyB;IACpD,4BAA4B,EAAE,4BAA4B;CAClB,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/rules/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,qBAAqB,EAAE,MAAM,2BAA2B,CAAC;AAClE,OAAO,EAAE,6BAA6B,EAAE,MAAM,oCAAoC,CAAC;AACnF,OAAO,EAAE,iCAAiC,EAAE,MAAM,wCAAwC,CAAC;AAC3F,OAAO,EAAE,uBAAuB,EAAE,MAAM,6BAA6B,CAAC;AACtE,OAAO,EAAE,yBAAyB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,EAAE,iCAAiC,EAAE,MAAM,uCAAuC,CAAC;AAC1F,OAAO,EAAE,8BAA8B,EAAE,MAAM,mCAAmC,CAAC;AACnF,OAAO,EAAE,2BAA2B,EAAE,MAAM,gCAAgC,CAAC;AAC7E,OAAO,EAAE,0BAA0B,EAAE,MAAM,+BAA+B,CAAC;AAC3E,OAAO,EAAE,4BAA4B,EAAE,MAAM,kCAAkC,CAAC;AAChF,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,qBAAqB,EAAE,MAAM,0BAA0B,CAAC;AACjE,OAAO,EAAE,uBAAuB,EAAE,MAAM,4BAA4B,CAAC;AACrE,OAAO,EAAE,2BAA2B,EAAE,MAAM,kCAAkC,CAAC;AAC/E,OAAO,EAAE,wBAAwB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,EAAE,qBAAqB,EAAE,MAAM,0BAA0B,CAAC;AACjE,OAAO,EAAE,wBAAwB,EAAE,MAAM,6BAA6B,CAAC;AACvE,OAAO,EAAE,iCAAiC,EAAE,MAAM,uCAAuC,CAAC;AAC1F,OAAO,EAAE,2BAA2B,EAAE,MAAM,iCAAiC,CAAC;AAC9E,OAAO,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,EAAE,+BAA+B,EAAE,MAAM,qCAAqC,CAAC;AACtF,OAAO,EAAE,+BAA+B,EAAE,MAAM,uCAAuC,CAAC;AACxF,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAC/D,OAAO,EAAE,uBAAuB,EAAE,MAAM,4BAA4B,CAAC;AACrE,OAAO,EAAE,uBAAuB,EAAE,MAAM,4BAA4B,CAAC;AACrE,OAAO,EAAE,yBAAyB,EAAE,MAAM,8BAA8B,CAAC;AACzE,OAAO,EAAE,0BAA0B,EAAE,MAAM,+BAA+B,CAAC;AAC3E,OAAO,EAAE,mCAAmC,EAAE,MAAM,0CAA0C,CAAC;AAC/F,OAAO,EAAE,qCAAqC,EAAE,MAAM,4CAA4C,CAAC;AACnG,OAAO,EAAE,6BAA6B,EAAE,MAAM,mCAAmC,CAAC;AAClF,OAAO,EAAE,iCAAiC,EAAE,MAAM,uCAAuC,CAAC;AAC1F,OAAO,EAAE,+BAA+B,EAAE,MAAM,qCAAqC,CAAC;AACtF,OAAO,EAAE,4BAA4B,EAAE,MAAM,iCAAiC,CAAC;AAC/E,OAAO,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,EAAE,+BAA+B,EAAE,MAAM,oCAAoC,CAAC;AACrF,OAAO,EAAE,yBAAyB,EAAE,MAAM,8BAA8B,CAAC;AACzE,OAAO,EAAE,+BAA+B,EAAE,MAAM,qCAAqC,CAAC;AACtF,OAAO,EAAE,yBAAyB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,EAAE,qBAAqB,EAAE,MAAM,0BAA0B,CAAC;AACjE,OAAO,EAAE,uBAAuB,EAAE,MAAM,6BAA6B,CAAC;AACtE,OAAO,EAAE,gCAAgC,EAAE,MAAM,sCAAsC,CAAC;AACxF,OAAO,EAAE,uBAAuB,EAAE,MAAM,4BAA4B,CAAC;AACrE,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,4BAA4B,EAAE,MAAM,iCAAiC,CAAC;AAC/E,OAAO,EAAE,0BAA0B,EAAE,MAAM,+BAA+B,CAAC;AAC3E,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,6BAA6B,EAAE,MAAM,kCAAkC,CAAC;AACjF,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAE,yBAAyB,EAAE,MAAM,8BAA8B,CAAC;AACzE,OAAO,EAAE,4BAA4B,EAAE,MAAM,iCAAiC,CAAC;AAE/E,MAAM,CAAC,MAAM,KAAK,GAAG;IACpB,sBAAsB,EAAE,qBAAqB;IAC7C,uBAAuB,EAAE,uBAAuB;IAChD,uBAAuB,EAAE,uBAAuB;IAChD,2BAA2B,EAAE,2BAA2B;IACxD,kCAAkC,EAAE,iCAAiC;IACrE,qBAAqB,EAAE,oBAAoB;IAC3C,6BAA6B,EAAE,2BAA2B;IAC1D,4BAA4B,EAAE,2BAA2B;IACzD,qBAAqB,EAAE,oBAAoB;IAC3C,+BAA+B,EAAE,+BAA+B;IAChE,yBAAyB,EAAE,yBAAyB;IACpD,0BAA0B,EAAE,0BAA0B;IACtD,qBAAqB,EAAE,qBAAqB;IAC5C,wBAAwB,EAAE,wBAAwB;IAClD,gCAAgC,EAAE,+BAA+B;IACjE,kCAAkC,EAAE,+BAA+B;IACnE,oBAAoB,EAAE,oBAAoB;IAC1C,yBAAyB,EAAE,yBAAyB;IACpD,0BAA0B,EAAE,0BAA0B;IACtD,iBAAiB,EAAE,kBAAkB;IACrC,6BAA6B,EAAE,4BAA4B;IAC3D,4BAA4B,EAAE,4BAA4B;IAC1D,0BAA0B,EAAE,0BAA0B;IACtD,8BAA8B,EAAE,8BAA8B;IAC9D,qCAAqC,EAAE,mCAAmC;IAC1E,uCAAuC,EAAE,qCAAqC;IAC9E,+BAA+B,EAAE,6BAA6B;IAC9D,mCAAmC,EAAE,iCAAiC;IACtE,wBAAwB,EAAE,uBAAuB;IACjD,0BAA0B,EAAE,yBAAyB;IACrD,kCAAkC,EAAE,iCAAiC;IACrE,8BAA8B,EAAE,6BAA6B;IAC7D,kCAAkC,EAAE,iCAAiC;IACrE,gCAAgC,EAAE,+BAA+B;IACjE,4BAA4B,EAAE,4BAA4B;IAC1D,qBAAqB,EAAE,qBAAqB;IAC5C,yBAAyB,EAAE,wBAAwB;IACnD,uBAAuB,EAAE,uBAAuB;IAChD,gCAAgC,EAAE,+BAA+B;IACjE,0BAA0B,EAAE,yBAAyB;IACrD,qBAAqB,EAAE,qBAAqB;IAC5C,wBAAwB,EAAE,uBAAuB;IACjD,iCAAiC,EAAE,gCAAgC;IACnE,uBAAuB,EAAE,uBAAuB;IAChD,iBAAiB,EAAE,kBAAkB;IACrC,cAAc,EAAE,eAAe;IAC/B,6BAA6B,EAAE,6BAA6B;IAC5D,mBAAmB,EAAE,oBAAoB;IACzC,yBAAyB,EAAE,yBAAyB;IACpD,4BAA4B,EAAE,4BAA4B;CAClB,CAAC"}
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
export declare const NoAsteriskInOptionNamesRule: import("@typescript-eslint/utils/ts-eslint").RuleModule<"asteriskInOptionName" | "replaceAsterisk", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
|
|
2
|
+
//# sourceMappingURL=no-asterisk-in-option-names.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"no-asterisk-in-option-names.d.ts","sourceRoot":"","sources":["../../src/rules/no-asterisk-in-option-names.ts"],"names":[],"mappings":"AAYA,eAAO,MAAM,2BAA2B,6KAkGtC,CAAC"}
|
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
import { AST_NODE_TYPES } from '@typescript-eslint/utils';
|
|
2
|
+
import { isNodeTypeClass, findClassProperty, findObjectProperty, getStringLiteralValue, isFileType, createRule, } from '../utils/index.js';
|
|
3
|
+
export const NoAsteriskInOptionNamesRule = createRule({
|
|
4
|
+
name: 'no-asterisk-in-option-names',
|
|
5
|
+
meta: {
|
|
6
|
+
type: 'suggestion',
|
|
7
|
+
docs: {
|
|
8
|
+
description: 'Disallow asterisk characters in node option name values',
|
|
9
|
+
},
|
|
10
|
+
hasSuggestions: true,
|
|
11
|
+
messages: {
|
|
12
|
+
asteriskInOptionName: 'Option name "{{ name }}" contains "*", which renders ambiguously in the n8n UI. Use bracketed notation like "[All]" instead.',
|
|
13
|
+
replaceAsterisk: 'Replace "*" with "[All]".',
|
|
14
|
+
},
|
|
15
|
+
schema: [],
|
|
16
|
+
},
|
|
17
|
+
defaultOptions: [],
|
|
18
|
+
create(context) {
|
|
19
|
+
if (!isFileType(context.filename, '.node.ts')) {
|
|
20
|
+
return {};
|
|
21
|
+
}
|
|
22
|
+
// Check every object that is a direct element of an `options` array.
|
|
23
|
+
const checkOptionsArray = (optionsArray) => {
|
|
24
|
+
for (const option of optionsArray.elements) {
|
|
25
|
+
if (!option || option.type !== AST_NODE_TYPES.ObjectExpression) {
|
|
26
|
+
continue;
|
|
27
|
+
}
|
|
28
|
+
const valueNode = findObjectProperty(option, 'name')?.value;
|
|
29
|
+
if (!valueNode) {
|
|
30
|
+
continue;
|
|
31
|
+
}
|
|
32
|
+
const name = getStringLiteralValue(valueNode);
|
|
33
|
+
if (!name?.includes('*')) {
|
|
34
|
+
continue;
|
|
35
|
+
}
|
|
36
|
+
context.report({
|
|
37
|
+
node: valueNode,
|
|
38
|
+
messageId: 'asteriskInOptionName',
|
|
39
|
+
data: { name },
|
|
40
|
+
suggest: [
|
|
41
|
+
{
|
|
42
|
+
messageId: 'replaceAsterisk',
|
|
43
|
+
fix(fixer) {
|
|
44
|
+
const quote = context.sourceCode.getText(valueNode).at(0) ?? "'";
|
|
45
|
+
return fixer.replaceText(valueNode, `${quote}${name.replaceAll('*', '[All]')}${quote}`);
|
|
46
|
+
},
|
|
47
|
+
},
|
|
48
|
+
],
|
|
49
|
+
});
|
|
50
|
+
}
|
|
51
|
+
};
|
|
52
|
+
const traverse = (node) => {
|
|
53
|
+
if (node.type === AST_NODE_TYPES.ObjectExpression) {
|
|
54
|
+
const optionsProperty = findObjectProperty(node, 'options');
|
|
55
|
+
if (optionsProperty?.value.type === AST_NODE_TYPES.ArrayExpression) {
|
|
56
|
+
checkOptionsArray(optionsProperty.value);
|
|
57
|
+
}
|
|
58
|
+
}
|
|
59
|
+
for (const key in node) {
|
|
60
|
+
if (key === 'parent') {
|
|
61
|
+
continue;
|
|
62
|
+
}
|
|
63
|
+
const child = node[key];
|
|
64
|
+
if (Array.isArray(child)) {
|
|
65
|
+
for (const item of child) {
|
|
66
|
+
if (item && typeof item === 'object' && 'type' in item) {
|
|
67
|
+
traverse(item);
|
|
68
|
+
}
|
|
69
|
+
}
|
|
70
|
+
}
|
|
71
|
+
else if (child && typeof child === 'object' && 'type' in child) {
|
|
72
|
+
traverse(child);
|
|
73
|
+
}
|
|
74
|
+
}
|
|
75
|
+
};
|
|
76
|
+
return {
|
|
77
|
+
ClassDeclaration(node) {
|
|
78
|
+
if (!isNodeTypeClass(node)) {
|
|
79
|
+
return;
|
|
80
|
+
}
|
|
81
|
+
const descriptionProperty = findClassProperty(node, 'description');
|
|
82
|
+
if (!descriptionProperty?.value) {
|
|
83
|
+
return;
|
|
84
|
+
}
|
|
85
|
+
traverse(descriptionProperty.value);
|
|
86
|
+
},
|
|
87
|
+
};
|
|
88
|
+
},
|
|
89
|
+
});
|
|
90
|
+
//# sourceMappingURL=no-asterisk-in-option-names.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"no-asterisk-in-option-names.js","sourceRoot":"","sources":["../../src/rules/no-asterisk-in-option-names.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAE1D,OAAO,EACN,eAAe,EACf,iBAAiB,EACjB,kBAAkB,EAClB,qBAAqB,EACrB,UAAU,EACV,UAAU,GACV,MAAM,mBAAmB,CAAC;AAE3B,MAAM,CAAC,MAAM,2BAA2B,GAAG,UAAU,CAAC;IACrD,IAAI,EAAE,6BAA6B;IACnC,IAAI,EAAE;QACL,IAAI,EAAE,YAAY;QAClB,IAAI,EAAE;YACL,WAAW,EAAE,yDAAyD;SACtE;QACD,cAAc,EAAE,IAAI;QACpB,QAAQ,EAAE;YACT,oBAAoB,EACnB,8HAA8H;YAC/H,eAAe,EAAE,2BAA2B;SAC5C;QACD,MAAM,EAAE,EAAE;KACV;IACD,cAAc,EAAE,EAAE;IAClB,MAAM,CAAC,OAAO;QACb,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,QAAQ,EAAE,UAAU,CAAC,EAAE,CAAC;YAC/C,OAAO,EAAE,CAAC;QACX,CAAC;QAED,qEAAqE;QACrE,MAAM,iBAAiB,GAAG,CAAC,YAAsC,EAAQ,EAAE;YAC1E,KAAK,MAAM,MAAM,IAAI,YAAY,CAAC,QAAQ,EAAE,CAAC;gBAC5C,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC,IAAI,KAAK,cAAc,CAAC,gBAAgB,EAAE,CAAC;oBAChE,SAAS;gBACV,CAAC;gBAED,MAAM,SAAS,GAAG,kBAAkB,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,KAAK,CAAC;gBAC5D,IAAI,CAAC,SAAS,EAAE,CAAC;oBAChB,SAAS;gBACV,CAAC;gBAED,MAAM,IAAI,GAAG,qBAAqB,CAAC,SAAS,CAAC,CAAC;gBAC9C,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;oBAC1B,SAAS;gBACV,CAAC;gBAED,OAAO,CAAC,MAAM,CAAC;oBACd,IAAI,EAAE,SAAS;oBACf,SAAS,EAAE,sBAAsB;oBACjC,IAAI,EAAE,EAAE,IAAI,EAAE;oBACd,OAAO,EAAE;wBACR;4BACC,SAAS,EAAE,iBAAiB;4BAC5B,GAAG,CAAC,KAAK;gCACR,MAAM,KAAK,GAAG,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC;gCACjE,OAAO,KAAK,CAAC,WAAW,CACvB,SAAS,EACT,GAAG,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,OAAO,CAAC,GAAG,KAAK,EAAE,CAClD,CAAC;4BACH,CAAC;yBACD;qBACD;iBACD,CAAC,CAAC;YACJ,CAAC;QACF,CAAC,CAAC;QAEF,MAAM,QAAQ,GAAG,CAAC,IAAmB,EAAQ,EAAE;YAC9C,IAAI,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,gBAAgB,EAAE,CAAC;gBACnD,MAAM,eAAe,GAAG,kBAAkB,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;gBAC5D,IAAI,eAAe,EAAE,KAAK,CAAC,IAAI,KAAK,cAAc,CAAC,eAAe,EAAE,CAAC;oBACpE,iBAAiB,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;gBAC1C,CAAC;YACF,CAAC;YAED,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;gBACxB,IAAI,GAAG,KAAK,QAAQ,EAAE,CAAC;oBACtB,SAAS;gBACV,CAAC;gBACD,MAAM,KAAK,GAAG,IAAI,CAAC,GAA0B,CAAY,CAAC;gBAC1D,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;oBAC1B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;wBAC1B,IAAI,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,MAAM,IAAI,IAAI,EAAE,CAAC;4BACxD,QAAQ,CAAC,IAAqB,CAAC,CAAC;wBACjC,CAAC;oBACF,CAAC;gBACF,CAAC;qBAAM,IAAI,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,IAAI,KAAK,EAAE,CAAC;oBAClE,QAAQ,CAAC,KAAsB,CAAC,CAAC;gBAClC,CAAC;YACF,CAAC;QACF,CAAC,CAAC;QAEF,OAAO;YACN,gBAAgB,CAAC,IAAI;gBACpB,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC;oBAC5B,OAAO;gBACR,CAAC;gBAED,MAAM,mBAAmB,GAAG,iBAAiB,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC;gBACnE,IAAI,CAAC,mBAAmB,EAAE,KAAK,EAAE,CAAC;oBACjC,OAAO;gBACR,CAAC;gBAED,QAAQ,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC;YACrC,CAAC;SACD,CAAC;IACH,CAAC;CACD,CAAC,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"no-duplicate-param-options.d.ts","sourceRoot":"","sources":["../../src/rules/no-duplicate-param-options.ts"],"names":[],"mappings":"AAaA,eAAO,MAAM,2BAA2B,qKA+GtC,CAAC"}
|
|
@@ -0,0 +1,97 @@
|
|
|
1
|
+
import { AST_NODE_TYPES } from '@typescript-eslint/utils';
|
|
2
|
+
import { isNodeTypeClass, findClassProperty, findObjectProperty, getStringLiteralValue, getLiteralValue, isFileType, createRule, } from '../utils/index.js';
|
|
3
|
+
export const NoDuplicateParamOptionsRule = createRule({
|
|
4
|
+
name: 'no-duplicate-param-options',
|
|
5
|
+
meta: {
|
|
6
|
+
type: 'problem',
|
|
7
|
+
docs: {
|
|
8
|
+
description: 'Disallow duplicate option names or values within a single node parameter',
|
|
9
|
+
},
|
|
10
|
+
messages: {
|
|
11
|
+
duplicateName: 'Duplicate option name "{{ value }}" in parameter "{{ displayName }}".',
|
|
12
|
+
duplicateValue: 'Duplicate option value "{{ value }}" in parameter "{{ displayName }}".',
|
|
13
|
+
},
|
|
14
|
+
schema: [],
|
|
15
|
+
},
|
|
16
|
+
defaultOptions: [],
|
|
17
|
+
create(context) {
|
|
18
|
+
if (!isFileType(context.filename, '.node.ts')) {
|
|
19
|
+
return {};
|
|
20
|
+
}
|
|
21
|
+
const checkProperty = (property) => {
|
|
22
|
+
const typeProperty = findObjectProperty(property, 'type');
|
|
23
|
+
const type = typeProperty ? getStringLiteralValue(typeProperty.value) : null;
|
|
24
|
+
if (type !== 'options' && type !== 'multiOptions') {
|
|
25
|
+
return;
|
|
26
|
+
}
|
|
27
|
+
const optionsProperty = findObjectProperty(property, 'options');
|
|
28
|
+
if (!optionsProperty?.value ||
|
|
29
|
+
optionsProperty.value.type !== AST_NODE_TYPES.ArrayExpression) {
|
|
30
|
+
return;
|
|
31
|
+
}
|
|
32
|
+
const displayNameProperty = findObjectProperty(property, 'displayName');
|
|
33
|
+
const displayName = (displayNameProperty ? getStringLiteralValue(displayNameProperty.value) : null) ??
|
|
34
|
+
'unknown';
|
|
35
|
+
const seenNames = new Set();
|
|
36
|
+
const seenValues = new Set();
|
|
37
|
+
for (const option of optionsProperty.value.elements) {
|
|
38
|
+
if (!option || option.type !== AST_NODE_TYPES.ObjectExpression) {
|
|
39
|
+
continue;
|
|
40
|
+
}
|
|
41
|
+
const nameProperty = findObjectProperty(option, 'name');
|
|
42
|
+
const name = nameProperty ? getStringLiteralValue(nameProperty.value) : null;
|
|
43
|
+
if (name !== null) {
|
|
44
|
+
if (seenNames.has(name)) {
|
|
45
|
+
context.report({
|
|
46
|
+
node: nameProperty.value,
|
|
47
|
+
messageId: 'duplicateName',
|
|
48
|
+
data: { value: name, displayName },
|
|
49
|
+
});
|
|
50
|
+
}
|
|
51
|
+
seenNames.add(name);
|
|
52
|
+
}
|
|
53
|
+
const valueProperty = findObjectProperty(option, 'value');
|
|
54
|
+
const value = valueProperty ? getLiteralValue(valueProperty.value) : null;
|
|
55
|
+
if (value !== null) {
|
|
56
|
+
if (seenValues.has(value)) {
|
|
57
|
+
context.report({
|
|
58
|
+
node: valueProperty.value,
|
|
59
|
+
messageId: 'duplicateValue',
|
|
60
|
+
data: { value: String(value), displayName },
|
|
61
|
+
});
|
|
62
|
+
}
|
|
63
|
+
seenValues.add(value);
|
|
64
|
+
}
|
|
65
|
+
}
|
|
66
|
+
};
|
|
67
|
+
const analyzeNodeDescription = (descriptionValue) => {
|
|
68
|
+
if (!descriptionValue || descriptionValue.type !== AST_NODE_TYPES.ObjectExpression) {
|
|
69
|
+
return;
|
|
70
|
+
}
|
|
71
|
+
const propertiesProperty = findObjectProperty(descriptionValue, 'properties');
|
|
72
|
+
if (!propertiesProperty?.value ||
|
|
73
|
+
propertiesProperty.value.type !== AST_NODE_TYPES.ArrayExpression) {
|
|
74
|
+
return;
|
|
75
|
+
}
|
|
76
|
+
for (const property of propertiesProperty.value.elements) {
|
|
77
|
+
if (!property || property.type !== AST_NODE_TYPES.ObjectExpression) {
|
|
78
|
+
continue;
|
|
79
|
+
}
|
|
80
|
+
checkProperty(property);
|
|
81
|
+
}
|
|
82
|
+
};
|
|
83
|
+
return {
|
|
84
|
+
ClassDeclaration(node) {
|
|
85
|
+
if (!isNodeTypeClass(node)) {
|
|
86
|
+
return;
|
|
87
|
+
}
|
|
88
|
+
const descriptionProperty = findClassProperty(node, 'description');
|
|
89
|
+
if (!descriptionProperty) {
|
|
90
|
+
return;
|
|
91
|
+
}
|
|
92
|
+
analyzeNodeDescription(descriptionProperty.value);
|
|
93
|
+
},
|
|
94
|
+
};
|
|
95
|
+
},
|
|
96
|
+
});
|
|
97
|
+
//# sourceMappingURL=no-duplicate-param-options.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"no-duplicate-param-options.js","sourceRoot":"","sources":["../../src/rules/no-duplicate-param-options.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAE1D,OAAO,EACN,eAAe,EACf,iBAAiB,EACjB,kBAAkB,EAClB,qBAAqB,EACrB,eAAe,EACf,UAAU,EACV,UAAU,GACV,MAAM,mBAAmB,CAAC;AAE3B,MAAM,CAAC,MAAM,2BAA2B,GAAG,UAAU,CAAC;IACrD,IAAI,EAAE,4BAA4B;IAClC,IAAI,EAAE;QACL,IAAI,EAAE,SAAS;QACf,IAAI,EAAE;YACL,WAAW,EAAE,0EAA0E;SACvF;QACD,QAAQ,EAAE;YACT,aAAa,EAAE,uEAAuE;YACtF,cAAc,EAAE,wEAAwE;SACxF;QACD,MAAM,EAAE,EAAE;KACV;IACD,cAAc,EAAE,EAAE;IAClB,MAAM,CAAC,OAAO;QACb,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,QAAQ,EAAE,UAAU,CAAC,EAAE,CAAC;YAC/C,OAAO,EAAE,CAAC;QACX,CAAC;QAED,MAAM,aAAa,GAAG,CAAC,QAAmC,EAAQ,EAAE;YACnE,MAAM,YAAY,GAAG,kBAAkB,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;YAC1D,MAAM,IAAI,GAAG,YAAY,CAAC,CAAC,CAAC,qBAAqB,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;YAC7E,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,cAAc,EAAE,CAAC;gBACnD,OAAO;YACR,CAAC;YAED,MAAM,eAAe,GAAG,kBAAkB,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;YAChE,IACC,CAAC,eAAe,EAAE,KAAK;gBACvB,eAAe,CAAC,KAAK,CAAC,IAAI,KAAK,cAAc,CAAC,eAAe,EAC5D,CAAC;gBACF,OAAO;YACR,CAAC;YAED,MAAM,mBAAmB,GAAG,kBAAkB,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;YACxE,MAAM,WAAW,GAChB,CAAC,mBAAmB,CAAC,CAAC,CAAC,qBAAqB,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;gBAC/E,SAAS,CAAC;YAEX,MAAM,SAAS,GAAG,IAAI,GAAG,EAAU,CAAC;YACpC,MAAM,UAAU,GAAG,IAAI,GAAG,EAA6B,CAAC;YAExD,KAAK,MAAM,MAAM,IAAI,eAAe,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;gBACrD,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC,IAAI,KAAK,cAAc,CAAC,gBAAgB,EAAE,CAAC;oBAChE,SAAS;gBACV,CAAC;gBAED,MAAM,YAAY,GAAG,kBAAkB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;gBACxD,MAAM,IAAI,GAAG,YAAY,CAAC,CAAC,CAAC,qBAAqB,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;gBAC7E,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;oBACnB,IAAI,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;wBACzB,OAAO,CAAC,MAAM,CAAC;4BACd,IAAI,EAAE,YAAa,CAAC,KAAK;4BACzB,SAAS,EAAE,eAAe;4BAC1B,IAAI,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,WAAW,EAAE;yBAClC,CAAC,CAAC;oBACJ,CAAC;oBACD,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;gBACrB,CAAC;gBAED,MAAM,aAAa,GAAG,kBAAkB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;gBAC1D,MAAM,KAAK,GAAG,aAAa,CAAC,CAAC,CAAC,eAAe,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;gBAC1E,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;oBACpB,IAAI,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;wBAC3B,OAAO,CAAC,MAAM,CAAC;4BACd,IAAI,EAAE,aAAc,CAAC,KAAK;4BAC1B,SAAS,EAAE,gBAAgB;4BAC3B,IAAI,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,EAAE,WAAW,EAAE;yBAC3C,CAAC,CAAC;oBACJ,CAAC;oBACD,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;gBACvB,CAAC;YACF,CAAC;QACF,CAAC,CAAC;QAEF,MAAM,sBAAsB,GAAG,CAAC,gBAA4C,EAAQ,EAAE;YACrF,IAAI,CAAC,gBAAgB,IAAI,gBAAgB,CAAC,IAAI,KAAK,cAAc,CAAC,gBAAgB,EAAE,CAAC;gBACpF,OAAO;YACR,CAAC;YAED,MAAM,kBAAkB,GAAG,kBAAkB,CAAC,gBAAgB,EAAE,YAAY,CAAC,CAAC;YAC9E,IACC,CAAC,kBAAkB,EAAE,KAAK;gBAC1B,kBAAkB,CAAC,KAAK,CAAC,IAAI,KAAK,cAAc,CAAC,eAAe,EAC/D,CAAC;gBACF,OAAO;YACR,CAAC;YAED,KAAK,MAAM,QAAQ,IAAI,kBAAkB,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;gBAC1D,IAAI,CAAC,QAAQ,IAAI,QAAQ,CAAC,IAAI,KAAK,cAAc,CAAC,gBAAgB,EAAE,CAAC;oBACpE,SAAS;gBACV,CAAC;gBACD,aAAa,CAAC,QAAQ,CAAC,CAAC;YACzB,CAAC;QACF,CAAC,CAAC;QAEF,OAAO;YACN,gBAAgB,CAAC,IAAI;gBACpB,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC;oBAC5B,OAAO;gBACR,CAAC;gBAED,MAAM,mBAAmB,GAAG,iBAAiB,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC;gBACnE,IAAI,CAAC,mBAAmB,EAAE,CAAC;oBAC1B,OAAO;gBACR,CAAC;gBAED,sBAAsB,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC;YACnD,CAAC;SACD,CAAC;IACH,CAAC;CACD,CAAC,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"node-class-description-name-camelcase.d.ts","sourceRoot":"","sources":["../../src/rules/node-class-description-name-camelcase.ts"],"names":[],"mappings":"AAiDA,eAAO,MAAM,qCAAqC,iJAgEhD,CAAC"}
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
import { TSESTree } from '@typescript-eslint/utils';
|
|
2
|
+
import { isNodeTypeClass, findClassProperty, findObjectProperty, getStringLiteralValue, isFileType, createRule, } from '../utils/index.js';
|
|
3
|
+
// `description.name` must be camelCase: a lowercase letter followed by
|
|
4
|
+
// letters/digits, with no separators.
|
|
5
|
+
const CAMEL_CASE_PATTERN = /^[a-z][a-zA-Z0-9]*$/;
|
|
6
|
+
/**
|
|
7
|
+
* Converts an arbitrary node name to camelCase by splitting on any
|
|
8
|
+
* non-alphanumeric separators, upper-casing the first character of each
|
|
9
|
+
* subsequent segment, and lower-casing the very first character.
|
|
10
|
+
* Examples: `My Node` -> `myNode`, `my-node` -> `myNode`, `GitHub` -> `gitHub`.
|
|
11
|
+
*/
|
|
12
|
+
function toCamelCase(value) {
|
|
13
|
+
const segments = value.split(/[^a-zA-Z0-9]+/).filter(Boolean);
|
|
14
|
+
if (segments.length === 0) {
|
|
15
|
+
return value;
|
|
16
|
+
}
|
|
17
|
+
const joined = segments
|
|
18
|
+
.map((segment, index) => index === 0 ? segment : segment.charAt(0).toUpperCase() + segment.slice(1))
|
|
19
|
+
.join('');
|
|
20
|
+
return joined.charAt(0).toLowerCase() + joined.slice(1);
|
|
21
|
+
}
|
|
22
|
+
// Serialize a value as a string literal using the original quote character,
|
|
23
|
+
// escaping any characters that would otherwise break the literal so the
|
|
24
|
+
// autofix never emits invalid code.
|
|
25
|
+
function toStringLiteral(value, quote) {
|
|
26
|
+
const escaped = value
|
|
27
|
+
.replace(/\\/g, '\\\\')
|
|
28
|
+
.replace(/\n/g, '\\n')
|
|
29
|
+
.replace(/\r/g, '\\r')
|
|
30
|
+
.split(quote)
|
|
31
|
+
.join(`\\${quote}`);
|
|
32
|
+
return `${quote}${escaped}${quote}`;
|
|
33
|
+
}
|
|
34
|
+
export const NodeClassDescriptionNameCamelCaseRule = createRule({
|
|
35
|
+
name: 'node-class-description-name-camelcase',
|
|
36
|
+
meta: {
|
|
37
|
+
type: 'problem',
|
|
38
|
+
docs: {
|
|
39
|
+
description: 'Node class `description.name` must be camelCase',
|
|
40
|
+
},
|
|
41
|
+
messages: {
|
|
42
|
+
notCamelCase: "Node `description.name` '{{value}}' must be camelCase",
|
|
43
|
+
},
|
|
44
|
+
fixable: 'code',
|
|
45
|
+
schema: [],
|
|
46
|
+
},
|
|
47
|
+
defaultOptions: [],
|
|
48
|
+
create(context) {
|
|
49
|
+
if (!isFileType(context.filename, '.node.ts')) {
|
|
50
|
+
return {};
|
|
51
|
+
}
|
|
52
|
+
return {
|
|
53
|
+
ClassDeclaration(node) {
|
|
54
|
+
if (!isNodeTypeClass(node)) {
|
|
55
|
+
return;
|
|
56
|
+
}
|
|
57
|
+
const descriptionProperty = findClassProperty(node, 'description');
|
|
58
|
+
if (descriptionProperty?.value?.type !== TSESTree.AST_NODE_TYPES.ObjectExpression) {
|
|
59
|
+
return;
|
|
60
|
+
}
|
|
61
|
+
const nameProperty = findObjectProperty(descriptionProperty.value, 'name');
|
|
62
|
+
if (!nameProperty) {
|
|
63
|
+
return;
|
|
64
|
+
}
|
|
65
|
+
const nameValue = getStringLiteralValue(nameProperty.value);
|
|
66
|
+
if (nameValue === null) {
|
|
67
|
+
return;
|
|
68
|
+
}
|
|
69
|
+
if (CAMEL_CASE_PATTERN.test(nameValue)) {
|
|
70
|
+
return;
|
|
71
|
+
}
|
|
72
|
+
const valueNode = nameProperty.value;
|
|
73
|
+
const fixedValue = toCamelCase(nameValue);
|
|
74
|
+
// Only offer an autofix when it actually yields a valid camelCase
|
|
75
|
+
// value (e.g. names starting with a digit cannot be repaired).
|
|
76
|
+
const canFix = fixedValue !== nameValue && CAMEL_CASE_PATTERN.test(fixedValue);
|
|
77
|
+
context.report({
|
|
78
|
+
node: valueNode,
|
|
79
|
+
messageId: 'notCamelCase',
|
|
80
|
+
data: { value: nameValue },
|
|
81
|
+
fix: canFix
|
|
82
|
+
? (fixer) => {
|
|
83
|
+
const quote = context.sourceCode.getText(valueNode).charAt(0);
|
|
84
|
+
return fixer.replaceText(valueNode, toStringLiteral(fixedValue, quote));
|
|
85
|
+
}
|
|
86
|
+
: undefined,
|
|
87
|
+
});
|
|
88
|
+
},
|
|
89
|
+
};
|
|
90
|
+
},
|
|
91
|
+
});
|
|
92
|
+
//# sourceMappingURL=node-class-description-name-camelcase.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"node-class-description-name-camelcase.js","sourceRoot":"","sources":["../../src/rules/node-class-description-name-camelcase.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AAEpD,OAAO,EACN,eAAe,EACf,iBAAiB,EACjB,kBAAkB,EAClB,qBAAqB,EACrB,UAAU,EACV,UAAU,GACV,MAAM,mBAAmB,CAAC;AAE3B,uEAAuE;AACvE,sCAAsC;AACtC,MAAM,kBAAkB,GAAG,qBAAqB,CAAC;AAEjD;;;;;GAKG;AACH,SAAS,WAAW,CAAC,KAAa;IACjC,MAAM,QAAQ,GAAG,KAAK,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAC9D,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC3B,OAAO,KAAK,CAAC;IACd,CAAC;IAED,MAAM,MAAM,GAAG,QAAQ;SACrB,GAAG,CAAC,CAAC,OAAO,EAAE,KAAK,EAAE,EAAE,CACvB,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAC1E;SACA,IAAI,CAAC,EAAE,CAAC,CAAC;IAEX,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AACzD,CAAC;AAED,4EAA4E;AAC5E,wEAAwE;AACxE,oCAAoC;AACpC,SAAS,eAAe,CAAC,KAAa,EAAE,KAAa;IACpD,MAAM,OAAO,GAAG,KAAK;SACnB,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC;SACtB,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC;SACrB,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC;SACrB,KAAK,CAAC,KAAK,CAAC;SACZ,IAAI,CAAC,KAAK,KAAK,EAAE,CAAC,CAAC;IACrB,OAAO,GAAG,KAAK,GAAG,OAAO,GAAG,KAAK,EAAE,CAAC;AACrC,CAAC;AAED,MAAM,CAAC,MAAM,qCAAqC,GAAG,UAAU,CAAC;IAC/D,IAAI,EAAE,uCAAuC;IAC7C,IAAI,EAAE;QACL,IAAI,EAAE,SAAS;QACf,IAAI,EAAE;YACL,WAAW,EAAE,iDAAiD;SAC9D;QACD,QAAQ,EAAE;YACT,YAAY,EAAE,uDAAuD;SACrE;QACD,OAAO,EAAE,MAAM;QACf,MAAM,EAAE,EAAE;KACV;IACD,cAAc,EAAE,EAAE;IAClB,MAAM,CAAC,OAAO;QACb,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,QAAQ,EAAE,UAAU,CAAC,EAAE,CAAC;YAC/C,OAAO,EAAE,CAAC;QACX,CAAC;QAED,OAAO;YACN,gBAAgB,CAAC,IAAI;gBACpB,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC;oBAC5B,OAAO;gBACR,CAAC;gBAED,MAAM,mBAAmB,GAAG,iBAAiB,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC;gBACnE,IAAI,mBAAmB,EAAE,KAAK,EAAE,IAAI,KAAK,QAAQ,CAAC,cAAc,CAAC,gBAAgB,EAAE,CAAC;oBACnF,OAAO;gBACR,CAAC;gBAED,MAAM,YAAY,GAAG,kBAAkB,CAAC,mBAAmB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;gBAC3E,IAAI,CAAC,YAAY,EAAE,CAAC;oBACnB,OAAO;gBACR,CAAC;gBAED,MAAM,SAAS,GAAG,qBAAqB,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;gBAC5D,IAAI,SAAS,KAAK,IAAI,EAAE,CAAC;oBACxB,OAAO;gBACR,CAAC;gBAED,IAAI,kBAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;oBACxC,OAAO;gBACR,CAAC;gBAED,MAAM,SAAS,GAAG,YAAY,CAAC,KAAK,CAAC;gBACrC,MAAM,UAAU,GAAG,WAAW,CAAC,SAAS,CAAC,CAAC;gBAC1C,kEAAkE;gBAClE,+DAA+D;gBAC/D,MAAM,MAAM,GAAG,UAAU,KAAK,SAAS,IAAI,kBAAkB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;gBAE/E,OAAO,CAAC,MAAM,CAAC;oBACd,IAAI,EAAE,SAAS;oBACf,SAAS,EAAE,cAAc;oBACzB,IAAI,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE;oBAC1B,GAAG,EAAE,MAAM;wBACV,CAAC,CAAC,CAAC,KAAK,EAAE,EAAE;4BACV,MAAM,KAAK,GAAG,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;4BAC9D,OAAO,KAAK,CAAC,WAAW,CAAC,SAAS,EAAE,eAAe,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC,CAAC;wBACzE,CAAC;wBACF,CAAC,CAAC,SAAS;iBACZ,CAAC,CAAC;YACJ,CAAC;SACD,CAAC;IACH,CAAC;CACD,CAAC,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-mit-license.d.ts","sourceRoot":"","sources":["../../src/rules/require-mit-license.ts"],"names":[],"mappings":"AAOA,eAAO,MAAM,qBAAqB,oKAyDhC,CAAC"}
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
import { AST_NODE_TYPES } from '@typescript-eslint/utils';
|
|
2
|
+
import { createRule, findJsonProperty, getStringLiteralValue } from '../utils/index.js';
|
|
3
|
+
const REQUIRED_LICENSE = 'MIT';
|
|
4
|
+
export const RequireMitLicenseRule = createRule({
|
|
5
|
+
name: 'require-mit-license',
|
|
6
|
+
meta: {
|
|
7
|
+
type: 'problem',
|
|
8
|
+
docs: {
|
|
9
|
+
description: 'Require the "license" field in community node package.json to be "MIT"',
|
|
10
|
+
},
|
|
11
|
+
fixable: 'code',
|
|
12
|
+
messages: {
|
|
13
|
+
missingLicense: `The package.json must have a "license" field set to "${REQUIRED_LICENSE}".`,
|
|
14
|
+
wrongLicense: `The "license" field must be "${REQUIRED_LICENSE}".`,
|
|
15
|
+
},
|
|
16
|
+
schema: [],
|
|
17
|
+
},
|
|
18
|
+
defaultOptions: [],
|
|
19
|
+
create(context) {
|
|
20
|
+
if (!context.filename.endsWith('package.json')) {
|
|
21
|
+
return {};
|
|
22
|
+
}
|
|
23
|
+
return {
|
|
24
|
+
ObjectExpression(node) {
|
|
25
|
+
if (node.parent?.type !== AST_NODE_TYPES.ExpressionStatement) {
|
|
26
|
+
return;
|
|
27
|
+
}
|
|
28
|
+
const licenseProp = findJsonProperty(node, 'license');
|
|
29
|
+
if (!licenseProp) {
|
|
30
|
+
context.report({
|
|
31
|
+
node,
|
|
32
|
+
messageId: 'missingLicense',
|
|
33
|
+
fix(fixer) {
|
|
34
|
+
const lastProp = node.properties[node.properties.length - 1];
|
|
35
|
+
if (!lastProp) {
|
|
36
|
+
return fixer.replaceText(node, `{ "license": "${REQUIRED_LICENSE}" }`);
|
|
37
|
+
}
|
|
38
|
+
return fixer.insertTextAfter(lastProp, `, "license": "${REQUIRED_LICENSE}"`);
|
|
39
|
+
},
|
|
40
|
+
});
|
|
41
|
+
return;
|
|
42
|
+
}
|
|
43
|
+
if (getStringLiteralValue(licenseProp.value) === REQUIRED_LICENSE) {
|
|
44
|
+
return;
|
|
45
|
+
}
|
|
46
|
+
context.report({
|
|
47
|
+
node: licenseProp.value,
|
|
48
|
+
messageId: 'wrongLicense',
|
|
49
|
+
fix(fixer) {
|
|
50
|
+
return fixer.replaceText(licenseProp.value, `"${REQUIRED_LICENSE}"`);
|
|
51
|
+
},
|
|
52
|
+
});
|
|
53
|
+
},
|
|
54
|
+
};
|
|
55
|
+
},
|
|
56
|
+
});
|
|
57
|
+
//# sourceMappingURL=require-mit-license.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-mit-license.js","sourceRoot":"","sources":["../../src/rules/require-mit-license.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAE1D,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAC;AAExF,MAAM,gBAAgB,GAAG,KAAK,CAAC;AAE/B,MAAM,CAAC,MAAM,qBAAqB,GAAG,UAAU,CAAC;IAC/C,IAAI,EAAE,qBAAqB;IAC3B,IAAI,EAAE;QACL,IAAI,EAAE,SAAS;QACf,IAAI,EAAE;YACL,WAAW,EAAE,wEAAwE;SACrF;QACD,OAAO,EAAE,MAAM;QACf,QAAQ,EAAE;YACT,cAAc,EAAE,wDAAwD,gBAAgB,IAAI;YAC5F,YAAY,EAAE,gCAAgC,gBAAgB,IAAI;SAClE;QACD,MAAM,EAAE,EAAE;KACV;IACD,cAAc,EAAE,EAAE;IAClB,MAAM,CAAC,OAAO;QACb,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAE,CAAC;YAChD,OAAO,EAAE,CAAC;QACX,CAAC;QAED,OAAO;YACN,gBAAgB,CAAC,IAA+B;gBAC/C,IAAI,IAAI,CAAC,MAAM,EAAE,IAAI,KAAK,cAAc,CAAC,mBAAmB,EAAE,CAAC;oBAC9D,OAAO;gBACR,CAAC;gBAED,MAAM,WAAW,GAAG,gBAAgB,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;gBAEtD,IAAI,CAAC,WAAW,EAAE,CAAC;oBAClB,OAAO,CAAC,MAAM,CAAC;wBACd,IAAI;wBACJ,SAAS,EAAE,gBAAgB;wBAC3B,GAAG,CAAC,KAAK;4BACR,MAAM,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;4BAC7D,IAAI,CAAC,QAAQ,EAAE,CAAC;gCACf,OAAO,KAAK,CAAC,WAAW,CAAC,IAAI,EAAE,iBAAiB,gBAAgB,KAAK,CAAC,CAAC;4BACxE,CAAC;4BACD,OAAO,KAAK,CAAC,eAAe,CAAC,QAAQ,EAAE,iBAAiB,gBAAgB,GAAG,CAAC,CAAC;wBAC9E,CAAC;qBACD,CAAC,CAAC;oBACH,OAAO;gBACR,CAAC;gBAED,IAAI,qBAAqB,CAAC,WAAW,CAAC,KAAK,CAAC,KAAK,gBAAgB,EAAE,CAAC;oBACnE,OAAO;gBACR,CAAC;gBAED,OAAO,CAAC,MAAM,CAAC;oBACd,IAAI,EAAE,WAAW,CAAC,KAAK;oBACvB,SAAS,EAAE,cAAc;oBACzB,GAAG,CAAC,KAAK;wBACR,OAAO,KAAK,CAAC,WAAW,CAAC,WAAW,CAAC,KAAK,EAAE,IAAI,gBAAgB,GAAG,CAAC,CAAC;oBACtE,CAAC;iBACD,CAAC,CAAC;YACJ,CAAC;SACD,CAAC;IACH,CAAC;CACD,CAAC,CAAC"}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Requires every node parameter to declare a `default` property.
|
|
3
|
+
*
|
|
4
|
+
* A parameter is detected structurally: an object literal inside a node's
|
|
5
|
+
* `description` with `displayName`, `name`, and `type` all set to string
|
|
6
|
+
* literals — the shape every `INodeProperties` entry has. This avoids
|
|
7
|
+
* hardcoding the `NodePropertyTypes` union (which would silently go stale as
|
|
8
|
+
* new types are added) and naturally excludes `options`-array entries, which
|
|
9
|
+
* carry `name`/`value` but no `displayName`/`type`.
|
|
10
|
+
*
|
|
11
|
+
* Without a `default`, n8n cannot reliably initialise the parameter's value,
|
|
12
|
+
* which leads to inconsistent runtime behaviour in the editor and on execution.
|
|
13
|
+
*/
|
|
14
|
+
export declare const RequireParamDefaultRule: import("@typescript-eslint/utils/ts-eslint").RuleModule<"missingDefault", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
|
|
15
|
+
//# sourceMappingURL=require-param-default.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-param-default.d.ts","sourceRoot":"","sources":["../../src/rules/require-param-default.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AA0BH,eAAO,MAAM,uBAAuB,mJAkDlC,CAAC"}
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Requires every node parameter to declare a `default` property.
|
|
3
|
+
*
|
|
4
|
+
* A parameter is detected structurally: an object literal inside a node's
|
|
5
|
+
* `description` with `displayName`, `name`, and `type` all set to string
|
|
6
|
+
* literals — the shape every `INodeProperties` entry has. This avoids
|
|
7
|
+
* hardcoding the `NodePropertyTypes` union (which would silently go stale as
|
|
8
|
+
* new types are added) and naturally excludes `options`-array entries, which
|
|
9
|
+
* carry `name`/`value` but no `displayName`/`type`.
|
|
10
|
+
*
|
|
11
|
+
* Without a `default`, n8n cannot reliably initialise the parameter's value,
|
|
12
|
+
* which leads to inconsistent runtime behaviour in the editor and on execution.
|
|
13
|
+
*/
|
|
14
|
+
import { simpleTraverse } from '@typescript-eslint/typescript-estree';
|
|
15
|
+
import { AST_NODE_TYPES } from '@typescript-eslint/utils';
|
|
16
|
+
import { createRule, findClassProperty, findObjectProperty, getStringLiteralValue, isFileType, isNodeTypeClass, } from '../utils/index.js';
|
|
17
|
+
/** Property keys an `INodeProperties` parameter always carries as string literals. */
|
|
18
|
+
const REQUIRED_PARAM_KEYS = ['displayName', 'name', 'type'];
|
|
19
|
+
/** Returns true when the object literal has the shape of a node parameter. */
|
|
20
|
+
function isNodeParameter(node) {
|
|
21
|
+
return REQUIRED_PARAM_KEYS.every((key) => {
|
|
22
|
+
const property = findObjectProperty(node, key);
|
|
23
|
+
return property !== null && getStringLiteralValue(property.value) !== null;
|
|
24
|
+
});
|
|
25
|
+
}
|
|
26
|
+
export const RequireParamDefaultRule = createRule({
|
|
27
|
+
name: 'require-param-default',
|
|
28
|
+
meta: {
|
|
29
|
+
type: 'problem',
|
|
30
|
+
docs: {
|
|
31
|
+
description: 'Require every node parameter to declare a default value.',
|
|
32
|
+
},
|
|
33
|
+
messages: {
|
|
34
|
+
missingDefault: "Node parameter '{{ name }}' is missing a `default` value. Add a `default` property so the parameter initialises consistently.",
|
|
35
|
+
},
|
|
36
|
+
schema: [],
|
|
37
|
+
},
|
|
38
|
+
defaultOptions: [],
|
|
39
|
+
create(context) {
|
|
40
|
+
if (!isFileType(context.filename, '.node.ts')) {
|
|
41
|
+
return {};
|
|
42
|
+
}
|
|
43
|
+
const reportIfMissingDefault = (node) => {
|
|
44
|
+
if (!isNodeParameter(node) || findObjectProperty(node, 'default') !== null) {
|
|
45
|
+
return;
|
|
46
|
+
}
|
|
47
|
+
const nameProperty = findObjectProperty(node, 'name');
|
|
48
|
+
context.report({
|
|
49
|
+
node,
|
|
50
|
+
messageId: 'missingDefault',
|
|
51
|
+
data: { name: getStringLiteralValue(nameProperty?.value ?? null) ?? '' },
|
|
52
|
+
});
|
|
53
|
+
};
|
|
54
|
+
return {
|
|
55
|
+
// Scope to an INodeType class's `description`, then walk only that
|
|
56
|
+
// subtree, so helper classes and object literals elsewhere in the file
|
|
57
|
+
// (e.g. in method bodies) that share the parameter shape are ignored.
|
|
58
|
+
ClassDeclaration(node) {
|
|
59
|
+
if (!isNodeTypeClass(node))
|
|
60
|
+
return;
|
|
61
|
+
const description = findClassProperty(node, 'description');
|
|
62
|
+
if (description?.value?.type !== AST_NODE_TYPES.ObjectExpression)
|
|
63
|
+
return;
|
|
64
|
+
simpleTraverse(description.value, {
|
|
65
|
+
enter(child) {
|
|
66
|
+
if (child.type === AST_NODE_TYPES.ObjectExpression) {
|
|
67
|
+
reportIfMissingDefault(child);
|
|
68
|
+
}
|
|
69
|
+
},
|
|
70
|
+
});
|
|
71
|
+
},
|
|
72
|
+
};
|
|
73
|
+
},
|
|
74
|
+
});
|
|
75
|
+
//# sourceMappingURL=require-param-default.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-param-default.js","sourceRoot":"","sources":["../../src/rules/require-param-default.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,sCAAsC,CAAC;AAEtE,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAE1D,OAAO,EACN,UAAU,EACV,iBAAiB,EACjB,kBAAkB,EAClB,qBAAqB,EACrB,UAAU,EACV,eAAe,GACf,MAAM,mBAAmB,CAAC;AAE3B,sFAAsF;AACtF,MAAM,mBAAmB,GAAG,CAAC,aAAa,EAAE,MAAM,EAAE,MAAM,CAAU,CAAC;AAErE,8EAA8E;AAC9E,SAAS,eAAe,CAAC,IAA+B;IACvD,OAAO,mBAAmB,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;QACxC,MAAM,QAAQ,GAAG,kBAAkB,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QAC/C,OAAO,QAAQ,KAAK,IAAI,IAAI,qBAAqB,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,IAAI,CAAC;IAC5E,CAAC,CAAC,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,MAAM,uBAAuB,GAAG,UAAU,CAAC;IACjD,IAAI,EAAE,uBAAuB;IAC7B,IAAI,EAAE;QACL,IAAI,EAAE,SAAS;QACf,IAAI,EAAE;YACL,WAAW,EAAE,0DAA0D;SACvE;QACD,QAAQ,EAAE;YACT,cAAc,EACb,+HAA+H;SAChI;QACD,MAAM,EAAE,EAAE;KACV;IACD,cAAc,EAAE,EAAE;IAClB,MAAM,CAAC,OAAO;QACb,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,QAAQ,EAAE,UAAU,CAAC,EAAE,CAAC;YAC/C,OAAO,EAAE,CAAC;QACX,CAAC;QAED,MAAM,sBAAsB,GAAG,CAAC,IAA+B,EAAQ,EAAE;YACxE,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,kBAAkB,CAAC,IAAI,EAAE,SAAS,CAAC,KAAK,IAAI,EAAE,CAAC;gBAC5E,OAAO;YACR,CAAC;YACD,MAAM,YAAY,GAAG,kBAAkB,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;YACtD,OAAO,CAAC,MAAM,CAAC;gBACd,IAAI;gBACJ,SAAS,EAAE,gBAAgB;gBAC3B,IAAI,EAAE,EAAE,IAAI,EAAE,qBAAqB,CAAC,YAAY,EAAE,KAAK,IAAI,IAAI,CAAC,IAAI,EAAE,EAAE;aACxE,CAAC,CAAC;QACJ,CAAC,CAAC;QAEF,OAAO;YACN,mEAAmE;YACnE,uEAAuE;YACvE,sEAAsE;YACtE,gBAAgB,CAAC,IAAI;gBACpB,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC;oBAAE,OAAO;gBACnC,MAAM,WAAW,GAAG,iBAAiB,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC;gBAC3D,IAAI,WAAW,EAAE,KAAK,EAAE,IAAI,KAAK,cAAc,CAAC,gBAAgB;oBAAE,OAAO;gBAEzE,cAAc,CAAC,WAAW,CAAC,KAAK,EAAE;oBACjC,KAAK,CAAC,KAAK;wBACV,IAAI,KAAK,CAAC,IAAI,KAAK,cAAc,CAAC,gBAAgB,EAAE,CAAC;4BACpD,sBAAsB,CAAC,KAAK,CAAC,CAAC;wBAC/B,CAAC;oBACF,CAAC;iBACD,CAAC,CAAC;YACJ,CAAC;SACD,CAAC;IACH,CAAC;CACD,CAAC,CAAC"}
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
export declare const TriggerNodeConventionsRule: import("@typescript-eslint/utils/ts-eslint").RuleModule<"nameMissingSuffix" | "displayNameMissingTrigger" | "inputsNotEmpty", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
|
|
2
|
+
//# sourceMappingURL=trigger-node-conventions.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"trigger-node-conventions.d.ts","sourceRoot":"","sources":["../../src/rules/trigger-node-conventions.ts"],"names":[],"mappings":"AAWA,eAAO,MAAM,0BAA0B,uMAgFrC,CAAC"}
|