@n8n/eslint-plugin-community-nodes 0.14.0 → 0.16.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.
Files changed (83) hide show
  1. package/.turbo/turbo-build.log +1 -1
  2. package/README.md +7 -0
  3. package/dist/plugin.d.ts +48 -0
  4. package/dist/plugin.d.ts.map +1 -1
  5. package/dist/plugin.js +16 -0
  6. package/dist/plugin.js.map +1 -1
  7. package/dist/rules/cred-class-name-suffix.d.ts +2 -0
  8. package/dist/rules/cred-class-name-suffix.d.ts.map +1 -0
  9. package/dist/rules/cred-class-name-suffix.js +53 -0
  10. package/dist/rules/cred-class-name-suffix.js.map +1 -0
  11. package/dist/rules/cred-class-oauth2-naming.d.ts +2 -0
  12. package/dist/rules/cred-class-oauth2-naming.d.ts.map +1 -0
  13. package/dist/rules/cred-class-oauth2-naming.js +96 -0
  14. package/dist/rules/cred-class-oauth2-naming.js.map +1 -0
  15. package/dist/rules/index.d.ts +11 -1
  16. package/dist/rules/index.d.ts.map +1 -1
  17. package/dist/rules/index.js +16 -0
  18. package/dist/rules/index.js.map +1 -1
  19. package/dist/rules/n8n-object-validation.d.ts +5 -0
  20. package/dist/rules/n8n-object-validation.d.ts.map +1 -0
  21. package/dist/rules/n8n-object-validation.js +148 -0
  22. package/dist/rules/n8n-object-validation.js.map +1 -0
  23. package/dist/rules/no-builder-hint-leakage.d.ts +7 -0
  24. package/dist/rules/no-builder-hint-leakage.d.ts.map +1 -0
  25. package/dist/rules/no-builder-hint-leakage.js +99 -0
  26. package/dist/rules/no-builder-hint-leakage.js.map +1 -0
  27. package/dist/rules/no-overrides-field.js +1 -1
  28. package/dist/rules/no-overrides-field.js.map +1 -1
  29. package/dist/rules/no-runtime-dependencies.d.ts +2 -0
  30. package/dist/rules/no-runtime-dependencies.d.ts.map +1 -0
  31. package/dist/rules/no-runtime-dependencies.js +41 -0
  32. package/dist/rules/no-runtime-dependencies.js.map +1 -0
  33. package/dist/rules/no-template-placeholders.d.ts +2 -0
  34. package/dist/rules/no-template-placeholders.d.ts.map +1 -0
  35. package/dist/rules/no-template-placeholders.js +57 -0
  36. package/dist/rules/no-template-placeholders.js.map +1 -0
  37. package/dist/rules/node-operation-error-itemindex.d.ts +12 -0
  38. package/dist/rules/node-operation-error-itemindex.d.ts.map +1 -0
  39. package/dist/rules/node-operation-error-itemindex.js +184 -0
  40. package/dist/rules/node-operation-error-itemindex.js.map +1 -0
  41. package/dist/rules/valid-credential-references.d.ts +2 -0
  42. package/dist/rules/valid-credential-references.d.ts.map +1 -0
  43. package/dist/rules/valid-credential-references.js +77 -0
  44. package/dist/rules/valid-credential-references.js.map +1 -0
  45. package/dist/rules/webhook-lifecycle-complete.d.ts +1 -1
  46. package/dist/rules/webhook-lifecycle-complete.d.ts.map +1 -1
  47. package/dist/rules/webhook-lifecycle-complete.js +8 -0
  48. package/dist/rules/webhook-lifecycle-complete.js.map +1 -1
  49. package/dist/utils/ast-utils.d.ts.map +1 -1
  50. package/dist/utils/ast-utils.js +5 -1
  51. package/dist/utils/ast-utils.js.map +1 -1
  52. package/docs/rules/cred-class-name-suffix.md +46 -0
  53. package/docs/rules/cred-class-oauth2-naming.md +68 -0
  54. package/docs/rules/n8n-object-validation.md +93 -0
  55. package/docs/rules/no-overrides-field.md +5 -5
  56. package/docs/rules/no-runtime-dependencies.md +58 -0
  57. package/docs/rules/no-template-placeholders.md +51 -0
  58. package/docs/rules/node-operation-error-itemindex.md +81 -0
  59. package/docs/rules/valid-credential-references.md +78 -0
  60. package/package.json +3 -3
  61. package/src/plugin.ts +16 -0
  62. package/src/rules/cred-class-name-suffix.test.ts +74 -0
  63. package/src/rules/cred-class-name-suffix.ts +57 -0
  64. package/src/rules/cred-class-oauth2-naming.test.ts +197 -0
  65. package/src/rules/cred-class-oauth2-naming.ts +118 -0
  66. package/src/rules/index.ts +16 -0
  67. package/src/rules/n8n-object-validation.test.ts +202 -0
  68. package/src/rules/n8n-object-validation.ts +200 -0
  69. package/src/rules/no-builder-hint-leakage.test.ts +84 -0
  70. package/src/rules/no-builder-hint-leakage.ts +112 -0
  71. package/src/rules/no-overrides-field.ts +1 -1
  72. package/src/rules/no-runtime-dependencies.test.ts +50 -0
  73. package/src/rules/no-runtime-dependencies.ts +50 -0
  74. package/src/rules/no-template-placeholders.test.ts +135 -0
  75. package/src/rules/no-template-placeholders.ts +68 -0
  76. package/src/rules/node-operation-error-itemindex.test.ts +280 -0
  77. package/src/rules/node-operation-error-itemindex.ts +223 -0
  78. package/src/rules/valid-credential-references.test.ts +230 -0
  79. package/src/rules/valid-credential-references.ts +105 -0
  80. package/src/rules/webhook-lifecycle-complete.test.ts +5 -0
  81. package/src/rules/webhook-lifecycle-complete.ts +10 -0
  82. package/src/utils/ast-utils.ts +5 -1
  83. package/tsconfig.build.tsbuildinfo +1 -1
@@ -1,4 +1,4 @@
1
1
 
2
- > @n8n/eslint-plugin-community-nodes@0.14.0 build /home/runner/work/n8n/n8n/packages/@n8n/eslint-plugin-community-nodes
2
+ > @n8n/eslint-plugin-community-nodes@0.16.0 build /home/runner/work/n8n/n8n/packages/@n8n/eslint-plugin-community-nodes
3
3
  > tsc --project tsconfig.build.json
4
4
 
package/README.md CHANGED
@@ -48,11 +48,14 @@ export default [
48
48
  | :--------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------ | :--- | :--- | :- | :- | :- |
49
49
  | [ai-node-package-json](docs/rules/ai-node-package-json.md) | Enforce consistency between n8n.aiNodeSdkVersion and ai-node-sdk peer dependency in community node packages | ✅ ☑️ | | | | |
50
50
  | [cred-class-field-icon-missing](docs/rules/cred-class-field-icon-missing.md) | Credential class must have an `icon` property defined | ✅ ☑️ | | | 💡 | |
51
+ | [cred-class-name-suffix](docs/rules/cred-class-name-suffix.md) | Credential class names must be suffixed with `Api` | ✅ ☑️ | | 🔧 | | |
52
+ | [cred-class-oauth2-naming](docs/rules/cred-class-oauth2-naming.md) | OAuth2 credentials must include `OAuth2` in the class name, `name`, and `displayName` | ✅ ☑️ | | 🔧 | | |
51
53
  | [credential-documentation-url](docs/rules/credential-documentation-url.md) | Enforce valid credential documentationUrl format (URL or lowercase alphanumeric slug) | ✅ ☑️ | | 🔧 | | |
52
54
  | [credential-password-field](docs/rules/credential-password-field.md) | Ensure credential fields with sensitive names have typeOptions.password = true | ✅ ☑️ | | 🔧 | | |
53
55
  | [credential-test-required](docs/rules/credential-test-required.md) | Ensure credentials have a credential test | ✅ ☑️ | | | 💡 | |
54
56
  | [icon-validation](docs/rules/icon-validation.md) | Validate node and credential icon files exist, are SVG format, and light/dark icons are different | ✅ ☑️ | | | 💡 | |
55
57
  | [missing-paired-item](docs/rules/missing-paired-item.md) | Require pairedItem on INodeExecutionData objects in execute() methods to preserve item linking. | ✅ ☑️ | | | | |
58
+ | [n8n-object-validation](docs/rules/n8n-object-validation.md) | Validate the structure of the "n8n" object in community node package.json (required keys, types, and dist/ paths) | ✅ ☑️ | | | | |
56
59
  | [no-credential-reuse](docs/rules/no-credential-reuse.md) | Prevent credential re-use security issues by ensuring nodes only reference credentials from the same package | ✅ ☑️ | | | 💡 | |
57
60
  | [no-deprecated-workflow-functions](docs/rules/no-deprecated-workflow-functions.md) | Disallow usage of deprecated functions and types from n8n-workflow package | ✅ ☑️ | | | 💡 | |
58
61
  | [no-forbidden-lifecycle-scripts](docs/rules/no-forbidden-lifecycle-scripts.md) | Ban lifecycle scripts (prepare, preinstall, postinstall, etc.) in community node packages | ✅ ☑️ | | | | |
@@ -60,8 +63,11 @@ export default [
60
63
  | [no-overrides-field](docs/rules/no-overrides-field.md) | Ban the "overrides" field in community node package.json | ✅ ☑️ | | | | |
61
64
  | [no-restricted-globals](docs/rules/no-restricted-globals.md) | Disallow usage of restricted global variables in community nodes. | ✅ | | | | |
62
65
  | [no-restricted-imports](docs/rules/no-restricted-imports.md) | Disallow usage of restricted imports in community nodes. | ✅ | | | | |
66
+ | [no-runtime-dependencies](docs/rules/no-runtime-dependencies.md) | Disallow non-empty "dependencies" in community node package.json | ✅ ☑️ | | | | |
67
+ | [no-template-placeholders](docs/rules/no-template-placeholders.md) | Disallow unresolved template placeholders in package.json | ✅ ☑️ | | | | |
63
68
  | [node-class-description-icon-missing](docs/rules/node-class-description-icon-missing.md) | Node class description must have an `icon` property defined. Deprecated: use `require-node-description-fields` instead. | | | | 💡 | ❌ |
64
69
  | [node-connection-type-literal](docs/rules/node-connection-type-literal.md) | Disallow string literals in node description `inputs`/`outputs` — use `NodeConnectionTypes` enum instead | ✅ ☑️ | | 🔧 | | |
70
+ | [node-operation-error-itemindex](docs/rules/node-operation-error-itemindex.md) | Require { itemIndex } in NodeOperationError / NodeApiError options inside item loops | ✅ ☑️ | | | | |
65
71
  | [node-usable-as-tool](docs/rules/node-usable-as-tool.md) | Ensure node classes have usableAsTool property | ✅ ☑️ | | 🔧 | | |
66
72
  | [options-sorted-alphabetically](docs/rules/options-sorted-alphabetically.md) | Enforce alphabetical ordering of options arrays in n8n node properties | | ✅ ☑️ | | | |
67
73
  | [package-name-convention](docs/rules/package-name-convention.md) | Enforce correct package naming convention for n8n community nodes | ✅ ☑️ | | | 💡 | |
@@ -70,6 +76,7 @@ export default [
70
76
  | [require-node-api-error](docs/rules/require-node-api-error.md) | Require NodeApiError or NodeOperationError for error wrapping in catch blocks. Raw errors lose HTTP context in the n8n UI. | ✅ ☑️ | | | | |
71
77
  | [require-node-description-fields](docs/rules/require-node-description-fields.md) | Node class description must define all required fields: icon, subtitle | ✅ ☑️ | | | | |
72
78
  | [resource-operation-pattern](docs/rules/resource-operation-pattern.md) | Enforce proper resource/operation pattern for better UX in n8n nodes | | ✅ ☑️ | | | |
79
+ | [valid-credential-references](docs/rules/valid-credential-references.md) | Ensure credentials referenced in node descriptions exist as credential classes in the package | ✅ ☑️ | | | 💡 | |
73
80
  | [valid-peer-dependencies](docs/rules/valid-peer-dependencies.md) | Require community node package.json peerDependencies to contain only "n8n-workflow": "*" (and optionally "ai-node-sdk") | ✅ ☑️ | | 🔧 | | |
74
81
  | [webhook-lifecycle-complete](docs/rules/webhook-lifecycle-complete.md) | Require webhook trigger nodes to implement the complete webhookMethods lifecycle (checkExists, create, delete) | ✅ ☑️ | | | | |
75
82
 
package/dist/plugin.d.ts CHANGED
@@ -18,6 +18,7 @@ declare const configs: {
18
18
  '@n8n/community-nodes/no-restricted-globals': "error";
19
19
  '@n8n/community-nodes/no-restricted-imports': "error";
20
20
  '@n8n/community-nodes/credential-password-field': "error";
21
+ '@n8n/community-nodes/n8n-object-validation': "error";
21
22
  '@n8n/community-nodes/no-deprecated-workflow-functions': "error";
22
23
  '@n8n/community-nodes/node-usable-as-tool': "error";
23
24
  '@n8n/community-nodes/package-name-convention': "error";
@@ -26,17 +27,24 @@ declare const configs: {
26
27
  '@n8n/community-nodes/no-forbidden-lifecycle-scripts': "error";
27
28
  '@n8n/community-nodes/no-http-request-with-manual-auth': "error";
28
29
  '@n8n/community-nodes/no-overrides-field': "error";
30
+ '@n8n/community-nodes/no-runtime-dependencies': "error";
31
+ '@n8n/community-nodes/no-template-placeholders': "error";
29
32
  '@n8n/community-nodes/icon-validation': "error";
30
33
  '@n8n/community-nodes/options-sorted-alphabetically': "warn";
31
34
  '@n8n/community-nodes/resource-operation-pattern': "warn";
32
35
  '@n8n/community-nodes/credential-documentation-url': "error";
33
36
  '@n8n/community-nodes/cred-class-field-icon-missing': "error";
37
+ '@n8n/community-nodes/cred-class-name-suffix': "error";
38
+ '@n8n/community-nodes/cred-class-oauth2-naming': "error";
34
39
  '@n8n/community-nodes/node-connection-type-literal': "error";
35
40
  '@n8n/community-nodes/missing-paired-item': "error";
41
+ '@n8n/community-nodes/no-builder-hint-leakage': "error";
42
+ '@n8n/community-nodes/node-operation-error-itemindex': "error";
36
43
  '@n8n/community-nodes/require-community-node-keyword': "warn";
37
44
  '@n8n/community-nodes/require-continue-on-fail': "error";
38
45
  '@n8n/community-nodes/require-node-api-error': "error";
39
46
  '@n8n/community-nodes/require-node-description-fields': "error";
47
+ '@n8n/community-nodes/valid-credential-references': "error";
40
48
  '@n8n/community-nodes/valid-peer-dependencies': "error";
41
49
  '@n8n/community-nodes/webhook-lifecycle-complete': "error";
42
50
  };
@@ -56,6 +64,7 @@ declare const configs: {
56
64
  rules: {
57
65
  '@n8n/community-nodes/ai-node-package-json': "error";
58
66
  '@n8n/community-nodes/credential-password-field': "error";
67
+ '@n8n/community-nodes/n8n-object-validation': "error";
59
68
  '@n8n/community-nodes/no-deprecated-workflow-functions': "error";
60
69
  '@n8n/community-nodes/node-usable-as-tool': "error";
61
70
  '@n8n/community-nodes/package-name-convention': "error";
@@ -64,17 +73,24 @@ declare const configs: {
64
73
  '@n8n/community-nodes/no-forbidden-lifecycle-scripts': "error";
65
74
  '@n8n/community-nodes/no-http-request-with-manual-auth': "error";
66
75
  '@n8n/community-nodes/no-overrides-field': "error";
76
+ '@n8n/community-nodes/no-runtime-dependencies': "error";
77
+ '@n8n/community-nodes/no-template-placeholders': "error";
67
78
  '@n8n/community-nodes/icon-validation': "error";
68
79
  '@n8n/community-nodes/options-sorted-alphabetically': "warn";
69
80
  '@n8n/community-nodes/credential-documentation-url': "error";
70
81
  '@n8n/community-nodes/resource-operation-pattern': "warn";
71
82
  '@n8n/community-nodes/cred-class-field-icon-missing': "error";
83
+ '@n8n/community-nodes/cred-class-name-suffix': "error";
84
+ '@n8n/community-nodes/cred-class-oauth2-naming': "error";
72
85
  '@n8n/community-nodes/node-connection-type-literal': "error";
73
86
  '@n8n/community-nodes/missing-paired-item': "error";
87
+ '@n8n/community-nodes/no-builder-hint-leakage': "error";
88
+ '@n8n/community-nodes/node-operation-error-itemindex': "error";
74
89
  '@n8n/community-nodes/require-community-node-keyword': "warn";
75
90
  '@n8n/community-nodes/require-continue-on-fail': "error";
76
91
  '@n8n/community-nodes/require-node-api-error': "error";
77
92
  '@n8n/community-nodes/require-node-description-fields': "error";
93
+ '@n8n/community-nodes/valid-credential-references': "error";
78
94
  '@n8n/community-nodes/valid-peer-dependencies': "error";
79
95
  '@n8n/community-nodes/webhook-lifecycle-complete': "error";
80
96
  };
@@ -99,6 +115,7 @@ declare const pluginWithConfigs: {
99
115
  '@n8n/community-nodes/no-restricted-globals': "error";
100
116
  '@n8n/community-nodes/no-restricted-imports': "error";
101
117
  '@n8n/community-nodes/credential-password-field': "error";
118
+ '@n8n/community-nodes/n8n-object-validation': "error";
102
119
  '@n8n/community-nodes/no-deprecated-workflow-functions': "error";
103
120
  '@n8n/community-nodes/node-usable-as-tool': "error";
104
121
  '@n8n/community-nodes/package-name-convention': "error";
@@ -107,17 +124,24 @@ declare const pluginWithConfigs: {
107
124
  '@n8n/community-nodes/no-forbidden-lifecycle-scripts': "error";
108
125
  '@n8n/community-nodes/no-http-request-with-manual-auth': "error";
109
126
  '@n8n/community-nodes/no-overrides-field': "error";
127
+ '@n8n/community-nodes/no-runtime-dependencies': "error";
128
+ '@n8n/community-nodes/no-template-placeholders': "error";
110
129
  '@n8n/community-nodes/icon-validation': "error";
111
130
  '@n8n/community-nodes/options-sorted-alphabetically': "warn";
112
131
  '@n8n/community-nodes/resource-operation-pattern': "warn";
113
132
  '@n8n/community-nodes/credential-documentation-url': "error";
114
133
  '@n8n/community-nodes/cred-class-field-icon-missing': "error";
134
+ '@n8n/community-nodes/cred-class-name-suffix': "error";
135
+ '@n8n/community-nodes/cred-class-oauth2-naming': "error";
115
136
  '@n8n/community-nodes/node-connection-type-literal': "error";
116
137
  '@n8n/community-nodes/missing-paired-item': "error";
138
+ '@n8n/community-nodes/no-builder-hint-leakage': "error";
139
+ '@n8n/community-nodes/node-operation-error-itemindex': "error";
117
140
  '@n8n/community-nodes/require-community-node-keyword': "warn";
118
141
  '@n8n/community-nodes/require-continue-on-fail': "error";
119
142
  '@n8n/community-nodes/require-node-api-error': "error";
120
143
  '@n8n/community-nodes/require-node-description-fields': "error";
144
+ '@n8n/community-nodes/valid-credential-references': "error";
121
145
  '@n8n/community-nodes/valid-peer-dependencies': "error";
122
146
  '@n8n/community-nodes/webhook-lifecycle-complete': "error";
123
147
  };
@@ -137,6 +161,7 @@ declare const pluginWithConfigs: {
137
161
  rules: {
138
162
  '@n8n/community-nodes/ai-node-package-json': "error";
139
163
  '@n8n/community-nodes/credential-password-field': "error";
164
+ '@n8n/community-nodes/n8n-object-validation': "error";
140
165
  '@n8n/community-nodes/no-deprecated-workflow-functions': "error";
141
166
  '@n8n/community-nodes/node-usable-as-tool': "error";
142
167
  '@n8n/community-nodes/package-name-convention': "error";
@@ -145,17 +170,24 @@ declare const pluginWithConfigs: {
145
170
  '@n8n/community-nodes/no-forbidden-lifecycle-scripts': "error";
146
171
  '@n8n/community-nodes/no-http-request-with-manual-auth': "error";
147
172
  '@n8n/community-nodes/no-overrides-field': "error";
173
+ '@n8n/community-nodes/no-runtime-dependencies': "error";
174
+ '@n8n/community-nodes/no-template-placeholders': "error";
148
175
  '@n8n/community-nodes/icon-validation': "error";
149
176
  '@n8n/community-nodes/options-sorted-alphabetically': "warn";
150
177
  '@n8n/community-nodes/credential-documentation-url': "error";
151
178
  '@n8n/community-nodes/resource-operation-pattern': "warn";
152
179
  '@n8n/community-nodes/cred-class-field-icon-missing': "error";
180
+ '@n8n/community-nodes/cred-class-name-suffix': "error";
181
+ '@n8n/community-nodes/cred-class-oauth2-naming': "error";
153
182
  '@n8n/community-nodes/node-connection-type-literal': "error";
154
183
  '@n8n/community-nodes/missing-paired-item': "error";
184
+ '@n8n/community-nodes/no-builder-hint-leakage': "error";
185
+ '@n8n/community-nodes/node-operation-error-itemindex': "error";
155
186
  '@n8n/community-nodes/require-community-node-keyword': "warn";
156
187
  '@n8n/community-nodes/require-continue-on-fail': "error";
157
188
  '@n8n/community-nodes/require-node-api-error': "error";
158
189
  '@n8n/community-nodes/require-node-description-fields': "error";
190
+ '@n8n/community-nodes/valid-credential-references': "error";
159
191
  '@n8n/community-nodes/valid-peer-dependencies': "error";
160
192
  '@n8n/community-nodes/webhook-lifecycle-complete': "error";
161
193
  };
@@ -187,6 +219,7 @@ declare const n8nCommunityNodesPlugin: {
187
219
  '@n8n/community-nodes/no-restricted-globals': "error";
188
220
  '@n8n/community-nodes/no-restricted-imports': "error";
189
221
  '@n8n/community-nodes/credential-password-field': "error";
222
+ '@n8n/community-nodes/n8n-object-validation': "error";
190
223
  '@n8n/community-nodes/no-deprecated-workflow-functions': "error";
191
224
  '@n8n/community-nodes/node-usable-as-tool': "error";
192
225
  '@n8n/community-nodes/package-name-convention': "error";
@@ -195,17 +228,24 @@ declare const n8nCommunityNodesPlugin: {
195
228
  '@n8n/community-nodes/no-forbidden-lifecycle-scripts': "error";
196
229
  '@n8n/community-nodes/no-http-request-with-manual-auth': "error";
197
230
  '@n8n/community-nodes/no-overrides-field': "error";
231
+ '@n8n/community-nodes/no-runtime-dependencies': "error";
232
+ '@n8n/community-nodes/no-template-placeholders': "error";
198
233
  '@n8n/community-nodes/icon-validation': "error";
199
234
  '@n8n/community-nodes/options-sorted-alphabetically': "warn";
200
235
  '@n8n/community-nodes/resource-operation-pattern': "warn";
201
236
  '@n8n/community-nodes/credential-documentation-url': "error";
202
237
  '@n8n/community-nodes/cred-class-field-icon-missing': "error";
238
+ '@n8n/community-nodes/cred-class-name-suffix': "error";
239
+ '@n8n/community-nodes/cred-class-oauth2-naming': "error";
203
240
  '@n8n/community-nodes/node-connection-type-literal': "error";
204
241
  '@n8n/community-nodes/missing-paired-item': "error";
242
+ '@n8n/community-nodes/no-builder-hint-leakage': "error";
243
+ '@n8n/community-nodes/node-operation-error-itemindex': "error";
205
244
  '@n8n/community-nodes/require-community-node-keyword': "warn";
206
245
  '@n8n/community-nodes/require-continue-on-fail': "error";
207
246
  '@n8n/community-nodes/require-node-api-error': "error";
208
247
  '@n8n/community-nodes/require-node-description-fields': "error";
248
+ '@n8n/community-nodes/valid-credential-references': "error";
209
249
  '@n8n/community-nodes/valid-peer-dependencies': "error";
210
250
  '@n8n/community-nodes/webhook-lifecycle-complete': "error";
211
251
  };
@@ -225,6 +265,7 @@ declare const n8nCommunityNodesPlugin: {
225
265
  rules: {
226
266
  '@n8n/community-nodes/ai-node-package-json': "error";
227
267
  '@n8n/community-nodes/credential-password-field': "error";
268
+ '@n8n/community-nodes/n8n-object-validation': "error";
228
269
  '@n8n/community-nodes/no-deprecated-workflow-functions': "error";
229
270
  '@n8n/community-nodes/node-usable-as-tool': "error";
230
271
  '@n8n/community-nodes/package-name-convention': "error";
@@ -233,17 +274,24 @@ declare const n8nCommunityNodesPlugin: {
233
274
  '@n8n/community-nodes/no-forbidden-lifecycle-scripts': "error";
234
275
  '@n8n/community-nodes/no-http-request-with-manual-auth': "error";
235
276
  '@n8n/community-nodes/no-overrides-field': "error";
277
+ '@n8n/community-nodes/no-runtime-dependencies': "error";
278
+ '@n8n/community-nodes/no-template-placeholders': "error";
236
279
  '@n8n/community-nodes/icon-validation': "error";
237
280
  '@n8n/community-nodes/options-sorted-alphabetically': "warn";
238
281
  '@n8n/community-nodes/credential-documentation-url': "error";
239
282
  '@n8n/community-nodes/resource-operation-pattern': "warn";
240
283
  '@n8n/community-nodes/cred-class-field-icon-missing': "error";
284
+ '@n8n/community-nodes/cred-class-name-suffix': "error";
285
+ '@n8n/community-nodes/cred-class-oauth2-naming': "error";
241
286
  '@n8n/community-nodes/node-connection-type-literal': "error";
242
287
  '@n8n/community-nodes/missing-paired-item': "error";
288
+ '@n8n/community-nodes/no-builder-hint-leakage': "error";
289
+ '@n8n/community-nodes/node-operation-error-itemindex': "error";
243
290
  '@n8n/community-nodes/require-community-node-keyword': "warn";
244
291
  '@n8n/community-nodes/require-continue-on-fail': "error";
245
292
  '@n8n/community-nodes/require-node-api-error': "error";
246
293
  '@n8n/community-nodes/require-node-description-fields': "error";
294
+ '@n8n/community-nodes/valid-credential-references': "error";
247
295
  '@n8n/community-nodes/valid-peer-dependencies': "error";
248
296
  '@n8n/community-nodes/webhook-lifecycle-complete': "error";
249
297
  };
@@ -1 +1 @@
1
- {"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAU,MAAM,QAAQ,CAAC;AAG7C,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAYzC,QAAA,MAAM,OAAO;;;;;;;;;;uBAHI,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;uBAAtB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAoEE,CAAC;AAE1C,QAAA,MAAM,iBAAiB;;;;;;;;;;;2BAtEN,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;2BAAtB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAAtB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC;CAsEiC,CAAC;AAEzE,QAAA,MAAM,uBAAuB;;;;;;;;;;;2BAxEZ,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;2BAAtB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAAtB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC;CAwEU,CAAC;AAClD,eAAe,iBAAiB,CAAC;AACjC,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,uBAAuB,EAAE,CAAC"}
1
+ {"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAU,MAAM,QAAQ,CAAC;AAG7C,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAYzC,QAAA,MAAM,OAAO;;;;;;;;;;uBAHI,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;uBAAtB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAoFE,CAAC;AAE1C,QAAA,MAAM,iBAAiB;;;;;;;;;;;2BAtFN,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;2BAAtB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAAtB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC;CAsFiC,CAAC;AAEzE,QAAA,MAAM,uBAAuB;;;;;;;;;;;2BAxFZ,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;2BAAtB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAAtB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC;CAwFU,CAAC;AAClD,eAAe,iBAAiB,CAAC;AACjC,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,uBAAuB,EAAE,CAAC"}
package/dist/plugin.js CHANGED
@@ -20,6 +20,7 @@ const configs = {
20
20
  '@n8n/community-nodes/no-restricted-globals': 'error',
21
21
  '@n8n/community-nodes/no-restricted-imports': 'error',
22
22
  '@n8n/community-nodes/credential-password-field': 'error',
23
+ '@n8n/community-nodes/n8n-object-validation': 'error',
23
24
  '@n8n/community-nodes/no-deprecated-workflow-functions': 'error',
24
25
  '@n8n/community-nodes/node-usable-as-tool': 'error',
25
26
  '@n8n/community-nodes/package-name-convention': 'error',
@@ -28,17 +29,24 @@ const configs = {
28
29
  '@n8n/community-nodes/no-forbidden-lifecycle-scripts': 'error',
29
30
  '@n8n/community-nodes/no-http-request-with-manual-auth': 'error',
30
31
  '@n8n/community-nodes/no-overrides-field': 'error',
32
+ '@n8n/community-nodes/no-runtime-dependencies': 'error',
33
+ '@n8n/community-nodes/no-template-placeholders': 'error',
31
34
  '@n8n/community-nodes/icon-validation': 'error',
32
35
  '@n8n/community-nodes/options-sorted-alphabetically': 'warn',
33
36
  '@n8n/community-nodes/resource-operation-pattern': 'warn',
34
37
  '@n8n/community-nodes/credential-documentation-url': 'error',
35
38
  '@n8n/community-nodes/cred-class-field-icon-missing': 'error',
39
+ '@n8n/community-nodes/cred-class-name-suffix': 'error',
40
+ '@n8n/community-nodes/cred-class-oauth2-naming': 'error',
36
41
  '@n8n/community-nodes/node-connection-type-literal': 'error',
37
42
  '@n8n/community-nodes/missing-paired-item': 'error',
43
+ '@n8n/community-nodes/no-builder-hint-leakage': 'error',
44
+ '@n8n/community-nodes/node-operation-error-itemindex': 'error',
38
45
  '@n8n/community-nodes/require-community-node-keyword': 'warn',
39
46
  '@n8n/community-nodes/require-continue-on-fail': 'error',
40
47
  '@n8n/community-nodes/require-node-api-error': 'error',
41
48
  '@n8n/community-nodes/require-node-description-fields': 'error',
49
+ '@n8n/community-nodes/valid-credential-references': 'error',
42
50
  '@n8n/community-nodes/valid-peer-dependencies': 'error',
43
51
  '@n8n/community-nodes/webhook-lifecycle-complete': 'error',
44
52
  },
@@ -51,6 +59,7 @@ const configs = {
51
59
  rules: {
52
60
  '@n8n/community-nodes/ai-node-package-json': 'error',
53
61
  '@n8n/community-nodes/credential-password-field': 'error',
62
+ '@n8n/community-nodes/n8n-object-validation': 'error',
54
63
  '@n8n/community-nodes/no-deprecated-workflow-functions': 'error',
55
64
  '@n8n/community-nodes/node-usable-as-tool': 'error',
56
65
  '@n8n/community-nodes/package-name-convention': 'error',
@@ -59,17 +68,24 @@ const configs = {
59
68
  '@n8n/community-nodes/no-forbidden-lifecycle-scripts': 'error',
60
69
  '@n8n/community-nodes/no-http-request-with-manual-auth': 'error',
61
70
  '@n8n/community-nodes/no-overrides-field': 'error',
71
+ '@n8n/community-nodes/no-runtime-dependencies': 'error',
72
+ '@n8n/community-nodes/no-template-placeholders': 'error',
62
73
  '@n8n/community-nodes/icon-validation': 'error',
63
74
  '@n8n/community-nodes/options-sorted-alphabetically': 'warn',
64
75
  '@n8n/community-nodes/credential-documentation-url': 'error',
65
76
  '@n8n/community-nodes/resource-operation-pattern': 'warn',
66
77
  '@n8n/community-nodes/cred-class-field-icon-missing': 'error',
78
+ '@n8n/community-nodes/cred-class-name-suffix': 'error',
79
+ '@n8n/community-nodes/cred-class-oauth2-naming': 'error',
67
80
  '@n8n/community-nodes/node-connection-type-literal': 'error',
68
81
  '@n8n/community-nodes/missing-paired-item': 'error',
82
+ '@n8n/community-nodes/no-builder-hint-leakage': 'error',
83
+ '@n8n/community-nodes/node-operation-error-itemindex': 'error',
69
84
  '@n8n/community-nodes/require-community-node-keyword': 'warn',
70
85
  '@n8n/community-nodes/require-continue-on-fail': 'error',
71
86
  '@n8n/community-nodes/require-node-api-error': 'error',
72
87
  '@n8n/community-nodes/require-node-description-fields': 'error',
88
+ '@n8n/community-nodes/valid-credential-references': 'error',
73
89
  '@n8n/community-nodes/valid-peer-dependencies': 'error',
74
90
  '@n8n/community-nodes/webhook-lifecycle-complete': 'error',
75
91
  },
@@ -1 +1 @@
1
- {"version":3,"file":"plugin.js","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAEA,OAAO,GAAG,MAAM,iBAAiB,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAC;AACxD,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAEzC,MAAM,MAAM,GAAG;IACd,IAAI,EAAE;QACL,IAAI,EAAE,GAAG,CAAC,IAAI;QACd,OAAO,EAAE,GAAG,CAAC,OAAO;QACpB,SAAS,EAAE,sBAAsB;KACjC;IACD,8EAA8E;IAC9E,KAAK,EAAE,KAA+B;CACd,CAAC;AAE1B,MAAM,OAAO,GAAG;IACf,WAAW,EAAE;QACZ,OAAO,EAAE,CAAC,+BAA+B,CAAC;QAC1C,OAAO,EAAE;YACR,sBAAsB,EAAE,MAAM;SAC9B;QACD,KAAK,EAAE;YACN,2CAA2C,EAAE,OAAO;YACpD,4CAA4C,EAAE,OAAO;YACrD,4CAA4C,EAAE,OAAO;YACrD,gDAAgD,EAAE,OAAO;YACzD,uDAAuD,EAAE,OAAO;YAChE,0CAA0C,EAAE,OAAO;YACnD,8CAA8C,EAAE,OAAO;YACvD,+CAA+C,EAAE,OAAO;YACxD,0CAA0C,EAAE,OAAO;YACnD,qDAAqD,EAAE,OAAO;YAC9D,uDAAuD,EAAE,OAAO;YAChE,yCAAyC,EAAE,OAAO;YAClD,sCAAsC,EAAE,OAAO;YAC/C,oDAAoD,EAAE,MAAM;YAC5D,iDAAiD,EAAE,MAAM;YACzD,mDAAmD,EAAE,OAAO;YAC5D,oDAAoD,EAAE,OAAO;YAC7D,mDAAmD,EAAE,OAAO;YAC5D,0CAA0C,EAAE,OAAO;YACnD,qDAAqD,EAAE,MAAM;YAC7D,+CAA+C,EAAE,OAAO;YACxD,6CAA6C,EAAE,OAAO;YACtD,sDAAsD,EAAE,OAAO;YAC/D,8CAA8C,EAAE,OAAO;YACvD,iDAAiD,EAAE,OAAO;SAC1D;KACD;IACD,iCAAiC,EAAE;QAClC,OAAO,EAAE,CAAC,+BAA+B,CAAC;QAC1C,OAAO,EAAE;YACR,sBAAsB,EAAE,MAAM;SAC9B;QACD,KAAK,EAAE;YACN,2CAA2C,EAAE,OAAO;YACpD,gDAAgD,EAAE,OAAO;YACzD,uDAAuD,EAAE,OAAO;YAChE,0CAA0C,EAAE,OAAO;YACnD,8CAA8C,EAAE,OAAO;YACvD,+CAA+C,EAAE,OAAO;YACxD,0CAA0C,EAAE,OAAO;YACnD,qDAAqD,EAAE,OAAO;YAC9D,uDAAuD,EAAE,OAAO;YAChE,yCAAyC,EAAE,OAAO;YAClD,sCAAsC,EAAE,OAAO;YAC/C,oDAAoD,EAAE,MAAM;YAC5D,mDAAmD,EAAE,OAAO;YAC5D,iDAAiD,EAAE,MAAM;YACzD,oDAAoD,EAAE,OAAO;YAC7D,mDAAmD,EAAE,OAAO;YAC5D,0CAA0C,EAAE,OAAO;YACnD,qDAAqD,EAAE,MAAM;YAC7D,+CAA+C,EAAE,OAAO;YACxD,6CAA6C,EAAE,OAAO;YACtD,sDAAsD,EAAE,OAAO;YAC/D,8CAA8C,EAAE,OAAO;YACvD,iDAAiD,EAAE,OAAO;SAC1D;KACD;CACuC,CAAC;AAE1C,MAAM,iBAAiB,GAAG,EAAE,GAAG,MAAM,EAAE,OAAO,EAA0B,CAAC;AAEzE,MAAM,uBAAuB,GAAG,iBAAiB,CAAC;AAClD,eAAe,iBAAiB,CAAC;AACjC,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,uBAAuB,EAAE,CAAC"}
1
+ {"version":3,"file":"plugin.js","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAEA,OAAO,GAAG,MAAM,iBAAiB,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAC;AACxD,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAEzC,MAAM,MAAM,GAAG;IACd,IAAI,EAAE;QACL,IAAI,EAAE,GAAG,CAAC,IAAI;QACd,OAAO,EAAE,GAAG,CAAC,OAAO;QACpB,SAAS,EAAE,sBAAsB;KACjC;IACD,8EAA8E;IAC9E,KAAK,EAAE,KAA+B;CACd,CAAC;AAE1B,MAAM,OAAO,GAAG;IACf,WAAW,EAAE;QACZ,OAAO,EAAE,CAAC,+BAA+B,CAAC;QAC1C,OAAO,EAAE;YACR,sBAAsB,EAAE,MAAM;SAC9B;QACD,KAAK,EAAE;YACN,2CAA2C,EAAE,OAAO;YACpD,4CAA4C,EAAE,OAAO;YACrD,4CAA4C,EAAE,OAAO;YACrD,gDAAgD,EAAE,OAAO;YACzD,4CAA4C,EAAE,OAAO;YACrD,uDAAuD,EAAE,OAAO;YAChE,0CAA0C,EAAE,OAAO;YACnD,8CAA8C,EAAE,OAAO;YACvD,+CAA+C,EAAE,OAAO;YACxD,0CAA0C,EAAE,OAAO;YACnD,qDAAqD,EAAE,OAAO;YAC9D,uDAAuD,EAAE,OAAO;YAChE,yCAAyC,EAAE,OAAO;YAClD,8CAA8C,EAAE,OAAO;YACvD,+CAA+C,EAAE,OAAO;YACxD,sCAAsC,EAAE,OAAO;YAC/C,oDAAoD,EAAE,MAAM;YAC5D,iDAAiD,EAAE,MAAM;YACzD,mDAAmD,EAAE,OAAO;YAC5D,oDAAoD,EAAE,OAAO;YAC7D,6CAA6C,EAAE,OAAO;YACtD,+CAA+C,EAAE,OAAO;YACxD,mDAAmD,EAAE,OAAO;YAC5D,0CAA0C,EAAE,OAAO;YACnD,8CAA8C,EAAE,OAAO;YACvD,qDAAqD,EAAE,OAAO;YAC9D,qDAAqD,EAAE,MAAM;YAC7D,+CAA+C,EAAE,OAAO;YACxD,6CAA6C,EAAE,OAAO;YACtD,sDAAsD,EAAE,OAAO;YAC/D,kDAAkD,EAAE,OAAO;YAC3D,8CAA8C,EAAE,OAAO;YACvD,iDAAiD,EAAE,OAAO;SAC1D;KACD;IACD,iCAAiC,EAAE;QAClC,OAAO,EAAE,CAAC,+BAA+B,CAAC;QAC1C,OAAO,EAAE;YACR,sBAAsB,EAAE,MAAM;SAC9B;QACD,KAAK,EAAE;YACN,2CAA2C,EAAE,OAAO;YACpD,gDAAgD,EAAE,OAAO;YACzD,4CAA4C,EAAE,OAAO;YACrD,uDAAuD,EAAE,OAAO;YAChE,0CAA0C,EAAE,OAAO;YACnD,8CAA8C,EAAE,OAAO;YACvD,+CAA+C,EAAE,OAAO;YACxD,0CAA0C,EAAE,OAAO;YACnD,qDAAqD,EAAE,OAAO;YAC9D,uDAAuD,EAAE,OAAO;YAChE,yCAAyC,EAAE,OAAO;YAClD,8CAA8C,EAAE,OAAO;YACvD,+CAA+C,EAAE,OAAO;YACxD,sCAAsC,EAAE,OAAO;YAC/C,oDAAoD,EAAE,MAAM;YAC5D,mDAAmD,EAAE,OAAO;YAC5D,iDAAiD,EAAE,MAAM;YACzD,oDAAoD,EAAE,OAAO;YAC7D,6CAA6C,EAAE,OAAO;YACtD,+CAA+C,EAAE,OAAO;YACxD,mDAAmD,EAAE,OAAO;YAC5D,0CAA0C,EAAE,OAAO;YACnD,8CAA8C,EAAE,OAAO;YACvD,qDAAqD,EAAE,OAAO;YAC9D,qDAAqD,EAAE,MAAM;YAC7D,+CAA+C,EAAE,OAAO;YACxD,6CAA6C,EAAE,OAAO;YACtD,sDAAsD,EAAE,OAAO;YAC/D,kDAAkD,EAAE,OAAO;YAC3D,8CAA8C,EAAE,OAAO;YACvD,iDAAiD,EAAE,OAAO;SAC1D;KACD;CACuC,CAAC;AAE1C,MAAM,iBAAiB,GAAG,EAAE,GAAG,MAAM,EAAE,OAAO,EAA0B,CAAC;AAEzE,MAAM,uBAAuB,GAAG,iBAAiB,CAAC;AAClD,eAAe,iBAAiB,CAAC;AACjC,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,uBAAuB,EAAE,CAAC"}
@@ -0,0 +1,2 @@
1
+ export declare const CredClassNameSuffixRule: import("@typescript-eslint/utils/ts-eslint").RuleModule<"missingSuffix", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
2
+ //# sourceMappingURL=cred-class-name-suffix.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"cred-class-name-suffix.d.ts","sourceRoot":"","sources":["../../src/rules/cred-class-name-suffix.ts"],"names":[],"mappings":"AAQA,eAAO,MAAM,uBAAuB,kJAgDlC,CAAC"}
@@ -0,0 +1,53 @@
1
+ import { isCredentialTypeClass, isFileType, createRule } from '../utils/index.js';
2
+ function addApiSuffix(name) {
3
+ if (name.endsWith('Ap'))
4
+ return `${name}i`;
5
+ if (name.endsWith('A'))
6
+ return `${name}pi`;
7
+ return `${name}Api`;
8
+ }
9
+ export const CredClassNameSuffixRule = createRule({
10
+ name: 'cred-class-name-suffix',
11
+ meta: {
12
+ type: 'problem',
13
+ docs: {
14
+ description: 'Credential class names must be suffixed with `Api`',
15
+ },
16
+ messages: {
17
+ missingSuffix: "Credential class name '{{name}}' must end with 'Api'",
18
+ },
19
+ fixable: 'code',
20
+ schema: [],
21
+ },
22
+ defaultOptions: [],
23
+ create(context) {
24
+ if (!isFileType(context.filename, '.credentials.ts')) {
25
+ return {};
26
+ }
27
+ return {
28
+ ClassDeclaration(node) {
29
+ if (!isCredentialTypeClass(node)) {
30
+ return;
31
+ }
32
+ const classNameNode = node.id;
33
+ if (!classNameNode) {
34
+ return;
35
+ }
36
+ const className = classNameNode.name;
37
+ if (className.endsWith('Api')) {
38
+ return;
39
+ }
40
+ const fixedName = addApiSuffix(className);
41
+ context.report({
42
+ node: classNameNode,
43
+ messageId: 'missingSuffix',
44
+ data: { name: className },
45
+ fix(fixer) {
46
+ return fixer.replaceText(classNameNode, fixedName);
47
+ },
48
+ });
49
+ },
50
+ };
51
+ },
52
+ });
53
+ //# sourceMappingURL=cred-class-name-suffix.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"cred-class-name-suffix.js","sourceRoot":"","sources":["../../src/rules/cred-class-name-suffix.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAElF,SAAS,YAAY,CAAC,IAAY;IACjC,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;QAAE,OAAO,GAAG,IAAI,GAAG,CAAC;IAC3C,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;QAAE,OAAO,GAAG,IAAI,IAAI,CAAC;IAC3C,OAAO,GAAG,IAAI,KAAK,CAAC;AACrB,CAAC;AAED,MAAM,CAAC,MAAM,uBAAuB,GAAG,UAAU,CAAC;IACjD,IAAI,EAAE,wBAAwB;IAC9B,IAAI,EAAE;QACL,IAAI,EAAE,SAAS;QACf,IAAI,EAAE;YACL,WAAW,EAAE,oDAAoD;SACjE;QACD,QAAQ,EAAE;YACT,aAAa,EAAE,sDAAsD;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,iBAAiB,CAAC,EAAE,CAAC;YACtD,OAAO,EAAE,CAAC;QACX,CAAC;QAED,OAAO;YACN,gBAAgB,CAAC,IAAI;gBACpB,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,EAAE,CAAC;oBAClC,OAAO;gBACR,CAAC;gBAED,MAAM,aAAa,GAAG,IAAI,CAAC,EAAE,CAAC;gBAC9B,IAAI,CAAC,aAAa,EAAE,CAAC;oBACpB,OAAO;gBACR,CAAC;gBAED,MAAM,SAAS,GAAG,aAAa,CAAC,IAAI,CAAC;gBACrC,IAAI,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;oBAC/B,OAAO;gBACR,CAAC;gBAED,MAAM,SAAS,GAAG,YAAY,CAAC,SAAS,CAAC,CAAC;gBAE1C,OAAO,CAAC,MAAM,CAAC;oBACd,IAAI,EAAE,aAAa;oBACnB,SAAS,EAAE,eAAe;oBAC1B,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;oBACzB,GAAG,CAAC,KAAK;wBACR,OAAO,KAAK,CAAC,WAAW,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;oBACpD,CAAC;iBACD,CAAC,CAAC;YACJ,CAAC;SACD,CAAC;IACH,CAAC;CACD,CAAC,CAAC"}
@@ -0,0 +1,2 @@
1
+ export declare const CredClassOAuth2NamingRule: import("@typescript-eslint/utils/ts-eslint").RuleModule<"classNameMissingOAuth2" | "nameMissingOAuth2" | "displayNameMissingOAuth2", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
2
+ //# sourceMappingURL=cred-class-oauth2-naming.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"cred-class-oauth2-naming.d.ts","sourceRoot":"","sources":["../../src/rules/cred-class-oauth2-naming.ts"],"names":[],"mappings":"AAkCA,eAAO,MAAM,yBAAyB,8MAmFpC,CAAC"}
@@ -0,0 +1,96 @@
1
+ import { AST_NODE_TYPES } from '@typescript-eslint/utils';
2
+ import { createRule, findClassProperty, getStringLiteralValue, isCredentialTypeClass, isFileType, } from '../utils/index.js';
3
+ const OAUTH2_PATTERN = /oauth2/i;
4
+ function containsOAuth2(value) {
5
+ return OAUTH2_PATTERN.test(value);
6
+ }
7
+ function getExtendsArrayValues(node) {
8
+ if (node.value?.type !== AST_NODE_TYPES.ArrayExpression)
9
+ return [];
10
+ const values = [];
11
+ for (const element of node.value.elements) {
12
+ const value = element ? getStringLiteralValue(element) : null;
13
+ if (value !== null)
14
+ values.push(value);
15
+ }
16
+ return values;
17
+ }
18
+ function suggestOAuth2ApiName(className) {
19
+ if (className.endsWith('Api')) {
20
+ return `${className.slice(0, -'Api'.length)}OAuth2Api`;
21
+ }
22
+ return `${className}OAuth2Api`;
23
+ }
24
+ export const CredClassOAuth2NamingRule = createRule({
25
+ name: 'cred-class-oauth2-naming',
26
+ meta: {
27
+ type: 'problem',
28
+ docs: {
29
+ description: 'OAuth2 credentials must include `OAuth2` in the class name, `name`, and `displayName`',
30
+ },
31
+ messages: {
32
+ classNameMissingOAuth2: "OAuth2 credential class name '{{name}}' must end with 'OAuth2Api'",
33
+ nameMissingOAuth2: "OAuth2 credential `name` field '{{value}}' must contain 'OAuth2'",
34
+ displayNameMissingOAuth2: "OAuth2 credential `displayName` field '{{value}}' must contain 'OAuth2'",
35
+ },
36
+ schema: [],
37
+ fixable: 'code',
38
+ },
39
+ defaultOptions: [],
40
+ create(context) {
41
+ if (!isFileType(context.filename, '.credentials.ts')) {
42
+ return {};
43
+ }
44
+ return {
45
+ ClassDeclaration(node) {
46
+ if (!isCredentialTypeClass(node))
47
+ return;
48
+ if (!node.id)
49
+ return;
50
+ const className = node.id.name;
51
+ const superClassName = node.superClass?.type === AST_NODE_TYPES.Identifier ? node.superClass.name : null;
52
+ const nameProperty = findClassProperty(node, 'name');
53
+ const nameValue = nameProperty?.value ? getStringLiteralValue(nameProperty.value) : null;
54
+ const displayNameProperty = findClassProperty(node, 'displayName');
55
+ const displayNameValue = displayNameProperty?.value
56
+ ? getStringLiteralValue(displayNameProperty.value)
57
+ : null;
58
+ const extendsProperty = findClassProperty(node, 'extends');
59
+ const extendsValues = extendsProperty ? getExtendsArrayValues(extendsProperty) : [];
60
+ const isOAuth2Credential = containsOAuth2(className) ||
61
+ (superClassName !== null && containsOAuth2(superClassName)) ||
62
+ extendsValues.some(containsOAuth2) ||
63
+ (nameValue !== null && containsOAuth2(nameValue)) ||
64
+ (displayNameValue !== null && containsOAuth2(displayNameValue));
65
+ if (!isOAuth2Credential)
66
+ return;
67
+ if (!className.endsWith('OAuth2Api')) {
68
+ const fixedClassName = suggestOAuth2ApiName(className);
69
+ context.report({
70
+ node: node.id,
71
+ messageId: 'classNameMissingOAuth2',
72
+ data: { name: className },
73
+ fix(fixer) {
74
+ return fixer.replaceText(node.id, fixedClassName);
75
+ },
76
+ });
77
+ }
78
+ if (nameValue !== null && !containsOAuth2(nameValue)) {
79
+ context.report({
80
+ node: nameProperty.value,
81
+ messageId: 'nameMissingOAuth2',
82
+ data: { value: nameValue },
83
+ });
84
+ }
85
+ if (displayNameValue !== null && !containsOAuth2(displayNameValue)) {
86
+ context.report({
87
+ node: displayNameProperty.value,
88
+ messageId: 'displayNameMissingOAuth2',
89
+ data: { value: displayNameValue },
90
+ });
91
+ }
92
+ },
93
+ };
94
+ },
95
+ });
96
+ //# sourceMappingURL=cred-class-oauth2-naming.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"cred-class-oauth2-naming.js","sourceRoot":"","sources":["../../src/rules/cred-class-oauth2-naming.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAE1D,OAAO,EACN,UAAU,EACV,iBAAiB,EACjB,qBAAqB,EACrB,qBAAqB,EACrB,UAAU,GACV,MAAM,mBAAmB,CAAC;AAE3B,MAAM,cAAc,GAAG,SAAS,CAAC;AAEjC,SAAS,cAAc,CAAC,KAAa;IACpC,OAAO,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AACnC,CAAC;AAED,SAAS,qBAAqB,CAAC,IAAiC;IAC/D,IAAI,IAAI,CAAC,KAAK,EAAE,IAAI,KAAK,cAAc,CAAC,eAAe;QAAE,OAAO,EAAE,CAAC;IACnE,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;QAC3C,MAAM,KAAK,GAAG,OAAO,CAAC,CAAC,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAC9D,IAAI,KAAK,KAAK,IAAI;YAAE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACxC,CAAC;IACD,OAAO,MAAM,CAAC;AACf,CAAC;AAED,SAAS,oBAAoB,CAAC,SAAiB;IAC9C,IAAI,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QAC/B,OAAO,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC;IACxD,CAAC;IACD,OAAO,GAAG,SAAS,WAAW,CAAC;AAChC,CAAC;AAED,MAAM,CAAC,MAAM,yBAAyB,GAAG,UAAU,CAAC;IACnD,IAAI,EAAE,0BAA0B;IAChC,IAAI,EAAE;QACL,IAAI,EAAE,SAAS;QACf,IAAI,EAAE;YACL,WAAW,EACV,uFAAuF;SACxF;QACD,QAAQ,EAAE;YACT,sBAAsB,EAAE,mEAAmE;YAC3F,iBAAiB,EAAE,kEAAkE;YACrF,wBAAwB,EACvB,yEAAyE;SAC1E;QACD,MAAM,EAAE,EAAE;QACV,OAAO,EAAE,MAAM;KACf;IACD,cAAc,EAAE,EAAE;IAClB,MAAM,CAAC,OAAO;QACb,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,QAAQ,EAAE,iBAAiB,CAAC,EAAE,CAAC;YACtD,OAAO,EAAE,CAAC;QACX,CAAC;QAED,OAAO;YACN,gBAAgB,CAAC,IAAI;gBACpB,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC;oBAAE,OAAO;gBACzC,IAAI,CAAC,IAAI,CAAC,EAAE;oBAAE,OAAO;gBAErB,MAAM,SAAS,GAAG,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC;gBAC/B,MAAM,cAAc,GACnB,IAAI,CAAC,UAAU,EAAE,IAAI,KAAK,cAAc,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;gBAEnF,MAAM,YAAY,GAAG,iBAAiB,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;gBACrD,MAAM,SAAS,GAAG,YAAY,EAAE,KAAK,CAAC,CAAC,CAAC,qBAAqB,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;gBAEzF,MAAM,mBAAmB,GAAG,iBAAiB,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC;gBACnE,MAAM,gBAAgB,GAAG,mBAAmB,EAAE,KAAK;oBAClD,CAAC,CAAC,qBAAqB,CAAC,mBAAmB,CAAC,KAAK,CAAC;oBAClD,CAAC,CAAC,IAAI,CAAC;gBAER,MAAM,eAAe,GAAG,iBAAiB,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;gBAC3D,MAAM,aAAa,GAAG,eAAe,CAAC,CAAC,CAAC,qBAAqB,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBAEpF,MAAM,kBAAkB,GACvB,cAAc,CAAC,SAAS,CAAC;oBACzB,CAAC,cAAc,KAAK,IAAI,IAAI,cAAc,CAAC,cAAc,CAAC,CAAC;oBAC3D,aAAa,CAAC,IAAI,CAAC,cAAc,CAAC;oBAClC,CAAC,SAAS,KAAK,IAAI,IAAI,cAAc,CAAC,SAAS,CAAC,CAAC;oBACjD,CAAC,gBAAgB,KAAK,IAAI,IAAI,cAAc,CAAC,gBAAgB,CAAC,CAAC,CAAC;gBAEjE,IAAI,CAAC,kBAAkB;oBAAE,OAAO;gBAEhC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC;oBACtC,MAAM,cAAc,GAAG,oBAAoB,CAAC,SAAS,CAAC,CAAC;oBAEvD,OAAO,CAAC,MAAM,CAAC;wBACd,IAAI,EAAE,IAAI,CAAC,EAAE;wBACb,SAAS,EAAE,wBAAwB;wBACnC,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;wBACzB,GAAG,CAAC,KAAK;4BACR,OAAO,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,EAAG,EAAE,cAAc,CAAC,CAAC;wBACpD,CAAC;qBACD,CAAC,CAAC;gBACJ,CAAC;gBAED,IAAI,SAAS,KAAK,IAAI,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,EAAE,CAAC;oBACtD,OAAO,CAAC,MAAM,CAAC;wBACd,IAAI,EAAE,YAAa,CAAC,KAAM;wBAC1B,SAAS,EAAE,mBAAmB;wBAC9B,IAAI,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE;qBAC1B,CAAC,CAAC;gBACJ,CAAC;gBAED,IAAI,gBAAgB,KAAK,IAAI,IAAI,CAAC,cAAc,CAAC,gBAAgB,CAAC,EAAE,CAAC;oBACpE,OAAO,CAAC,MAAM,CAAC;wBACd,IAAI,EAAE,mBAAoB,CAAC,KAAM;wBACjC,SAAS,EAAE,0BAA0B;wBACrC,IAAI,EAAE,EAAE,KAAK,EAAE,gBAAgB,EAAE;qBACjC,CAAC,CAAC;gBACJ,CAAC;YACF,CAAC;SACD,CAAC;IACH,CAAC;CACD,CAAC,CAAC"}
@@ -12,6 +12,8 @@ export declare const rules: {
12
12
  'no-forbidden-lifecycle-scripts': import("@typescript-eslint/utils/ts-eslint").RuleModule<"forbiddenScript", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
13
13
  'no-http-request-with-manual-auth': import("@typescript-eslint/utils/ts-eslint").RuleModule<"useHttpRequestWithAuthentication", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
14
14
  'no-overrides-field': import("@typescript-eslint/utils/ts-eslint").RuleModule<"overridesForbidden", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
15
+ 'no-runtime-dependencies': import("@typescript-eslint/utils/ts-eslint").RuleModule<"runtimeDependenciesForbidden", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
16
+ 'no-template-placeholders': import("@typescript-eslint/utils/ts-eslint").RuleModule<"unresolvedPlaceholder", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
15
17
  'icon-validation': import("@typescript-eslint/utils/ts-eslint").RuleModule<"missingIcon" | "addPlaceholder" | "iconFileNotFound" | "iconNotSvg" | "lightDarkSame" | "invalidIconPath" | "addFileProtocol" | "changeExtension" | "similarIcon", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
16
18
  'resource-operation-pattern': import("@typescript-eslint/utils/ts-eslint").RuleModule<"tooManyOperationsWithoutResources", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
17
19
  'credential-documentation-url': import("@typescript-eslint/utils/ts-eslint").RuleModule<"invalidDocumentationUrl", [{
@@ -20,13 +22,21 @@ export declare const rules: {
20
22
  }], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
21
23
  'node-class-description-icon-missing': import("@typescript-eslint/utils/ts-eslint").RuleModule<"missingIcon" | "addPlaceholder", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
22
24
  'cred-class-field-icon-missing': import("@typescript-eslint/utils/ts-eslint").RuleModule<"missingIcon" | "addPlaceholder", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
25
+ 'cred-class-name-suffix': import("@typescript-eslint/utils/ts-eslint").RuleModule<"missingSuffix", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
26
+ 'cred-class-oauth2-naming': import("@typescript-eslint/utils/ts-eslint").RuleModule<"classNameMissingOAuth2" | "nameMissingOAuth2" | "displayNameMissingOAuth2", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
23
27
  'node-connection-type-literal': import("@typescript-eslint/utils/ts-eslint").RuleModule<"stringLiteralInInputs" | "stringLiteralInOutputs" | "unknownStringLiteralInInputs" | "unknownStringLiteralInOutputs", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
28
+ 'node-operation-error-itemindex': import("@typescript-eslint/utils/ts-eslint").RuleModule<"missingItemIndex", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
24
29
  'missing-paired-item': import("@typescript-eslint/utils/ts-eslint").RuleModule<"missingPairedItem", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
30
+ 'no-builder-hint-leakage': import("@typescript-eslint/utils/ts-eslint").RuleModule<"wireExpression" | "connectionTypeLiteral", [{
31
+ scope?: "builderHint" | "all";
32
+ }], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
33
+ 'n8n-object-validation': import("@typescript-eslint/utils/ts-eslint").RuleModule<"missingN8nObject" | "wrongLocationApiVersion" | "missingNodesApiVersion" | "invalidNodesApiVersion" | "missingN8nNodes" | "n8nNodesNotArray" | "emptyN8nNodes" | "n8nCredentialsNotArray" | "nodePathNotString" | "nodePathNotInDist" | "credentialPathNotString" | "credentialPathNotInDist" | "invalidStrict", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
25
34
  'require-community-node-keyword': import("@typescript-eslint/utils/ts-eslint").RuleModule<"missingKeyword" | "missingKeywordsArray", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
26
35
  'require-continue-on-fail': import("@typescript-eslint/utils/ts-eslint").RuleModule<"missingContinueOnFail", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
27
36
  'require-node-api-error': import("@typescript-eslint/utils/ts-eslint").RuleModule<"useNodeApiError" | "useNodeApiErrorInsteadOfGeneric", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
28
37
  'require-node-description-fields': import("@typescript-eslint/utils/ts-eslint").RuleModule<"missingField" | "missingFields", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
38
+ 'valid-credential-references': import("@typescript-eslint/utils/ts-eslint").RuleModule<"didYouMean" | "credentialNotFound", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
29
39
  'valid-peer-dependencies': import("@typescript-eslint/utils/ts-eslint").RuleModule<"missingPeerDependencies" | "invalidPeerDependenciesType" | "missingN8nWorkflow" | "pinnedN8nWorkflow" | "forbiddenPeerDependency", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
30
- 'webhook-lifecycle-complete': import("@typescript-eslint/utils/ts-eslint").RuleModule<"missingWebhookMethods" | "missingLifecycleMethod", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
40
+ 'webhook-lifecycle-complete': import("@typescript-eslint/utils/ts-eslint").RuleModule<"missingWebhookMethods" | "emptyWebhookMethods" | "missingLifecycleMethod", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
31
41
  };
32
42
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/rules/index.ts"],"names":[],"mappings":"AA6BA,eAAO,MAAM,KAAK;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA2BuB,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/rules/index.ts"],"names":[],"mappings":"AAqCA,eAAO,MAAM,KAAK;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAmCuB,CAAC"}