@n8n/eslint-plugin-community-nodes 0.22.0 → 0.23.0

package/dist/rules/no-duplicate-param-options.js

@@ -0,0 +1,97 @@
+import { AST_NODE_TYPES } from '@typescript-eslint/utils';
+import { isNodeTypeClass, findClassProperty, findObjectProperty, getStringLiteralValue, getLiteralValue, isFileType, createRule, } from '../utils/index.js';
+export const NoDuplicateParamOptionsRule = createRule({
+    name: 'no-duplicate-param-options',
+    meta: {
+        type: 'problem',
+        docs: {
+            description: 'Disallow duplicate option names or values within a single node parameter',
+        },
+        messages: {
+            duplicateName: 'Duplicate option name "{{ value }}" in parameter "{{ displayName }}".',
+            duplicateValue: 'Duplicate option value "{{ value }}" in parameter "{{ displayName }}".',
+        },
+        schema: [],
+    },
+    defaultOptions: [],
+    create(context) {
+        if (!isFileType(context.filename, '.node.ts')) {
+            return {};
+        }
+        const checkProperty = (property) => {
+            const typeProperty = findObjectProperty(property, 'type');
+            const type = typeProperty ? getStringLiteralValue(typeProperty.value) : null;
+            if (type !== 'options' && type !== 'multiOptions') {
+                return;
+            }
+            const optionsProperty = findObjectProperty(property, 'options');
+            if (!optionsProperty?.value ||
+                optionsProperty.value.type !== AST_NODE_TYPES.ArrayExpression) {
+                return;
+            }
+            const displayNameProperty = findObjectProperty(property, 'displayName');
+            const displayName = (displayNameProperty ? getStringLiteralValue(displayNameProperty.value) : null) ??
+                'unknown';
+            const seenNames = new Set();
+            const seenValues = new Set();
+            for (const option of optionsProperty.value.elements) {
+                if (!option || option.type !== AST_NODE_TYPES.ObjectExpression) {
+                    continue;
+                }
+                const nameProperty = findObjectProperty(option, 'name');
+                const name = nameProperty ? getStringLiteralValue(nameProperty.value) : null;
+                if (name !== null) {
+                    if (seenNames.has(name)) {
+                        context.report({
+                            node: nameProperty.value,
+                            messageId: 'duplicateName',
+                            data: { value: name, displayName },
+                        });
+                    }
+                    seenNames.add(name);
+                }
+                const valueProperty = findObjectProperty(option, 'value');
+                const value = valueProperty ? getLiteralValue(valueProperty.value) : null;
+                if (value !== null) {
+                    if (seenValues.has(value)) {
+                        context.report({
+                            node: valueProperty.value,
+                            messageId: 'duplicateValue',
+                            data: { value: String(value), displayName },
+                        });
+                    }
+                    seenValues.add(value);
+                }
+            }
+        };
+        const analyzeNodeDescription = (descriptionValue) => {
+            if (!descriptionValue || descriptionValue.type !== AST_NODE_TYPES.ObjectExpression) {
+                return;
+            }
+            const propertiesProperty = findObjectProperty(descriptionValue, 'properties');
+            if (!propertiesProperty?.value ||
+                propertiesProperty.value.type !== AST_NODE_TYPES.ArrayExpression) {
+                return;
+            }
+            for (const property of propertiesProperty.value.elements) {
+                if (!property || property.type !== AST_NODE_TYPES.ObjectExpression) {
+                    continue;
+                }
+                checkProperty(property);
+            }
+        };
+        return {
+            ClassDeclaration(node) {
+                if (!isNodeTypeClass(node)) {
+                    return;
+                }
+                const descriptionProperty = findClassProperty(node, 'description');
+                if (!descriptionProperty) {
+                    return;
+                }
+                analyzeNodeDescription(descriptionProperty.value);
+            },
+        };
+    },
+});
+//# sourceMappingURL=no-duplicate-param-options.js.map

package/dist/rules/no-duplicate-param-options.js.map

@@ -0,0 +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"}

package/dist/rules/require-mit-license.d.ts

@@ -0,0 +1,2 @@
+export declare const RequireMitLicenseRule: import("@typescript-eslint/utils/ts-eslint").RuleModule<"missingLicense" | "wrongLicense", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+//# sourceMappingURL=require-mit-license.d.ts.map

package/dist/rules/require-mit-license.d.ts.map

@@ -0,0 +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"}

package/dist/rules/require-mit-license.js

@@ -0,0 +1,57 @@
+import { AST_NODE_TYPES } from '@typescript-eslint/utils';
+import { createRule, findJsonProperty, getStringLiteralValue } from '../utils/index.js';
+const REQUIRED_LICENSE = 'MIT';
+export const RequireMitLicenseRule = createRule({
+    name: 'require-mit-license',
+    meta: {
+        type: 'problem',
+        docs: {
+            description: 'Require the "license" field in community node package.json to be "MIT"',
+        },
+        fixable: 'code',
+        messages: {
+            missingLicense: `The package.json must have a "license" field set to "${REQUIRED_LICENSE}".`,
+            wrongLicense: `The "license" field must be "${REQUIRED_LICENSE}".`,
+        },
+        schema: [],
+    },
+    defaultOptions: [],
+    create(context) {
+        if (!context.filename.endsWith('package.json')) {
+            return {};
+        }
+        return {
+            ObjectExpression(node) {
+                if (node.parent?.type !== AST_NODE_TYPES.ExpressionStatement) {
+                    return;
+                }
+                const licenseProp = findJsonProperty(node, 'license');
+                if (!licenseProp) {
+                    context.report({
+                        node,
+                        messageId: 'missingLicense',
+                        fix(fixer) {
+                            const lastProp = node.properties[node.properties.length - 1];
+                            if (!lastProp) {
+                                return fixer.replaceText(node, `{ "license": "${REQUIRED_LICENSE}" }`);
+                            }
+                            return fixer.insertTextAfter(lastProp, `, "license": "${REQUIRED_LICENSE}"`);
+                        },
+                    });
+                    return;
+                }
+                if (getStringLiteralValue(licenseProp.value) === REQUIRED_LICENSE) {
+                    return;
+                }
+                context.report({
+                    node: licenseProp.value,
+                    messageId: 'wrongLicense',
+                    fix(fixer) {
+                        return fixer.replaceText(licenseProp.value, `"${REQUIRED_LICENSE}"`);
+                    },
+                });
+            },
+        };
+    },
+});
+//# sourceMappingURL=require-mit-license.js.map

package/dist/rules/require-mit-license.js.map

@@ -0,0 +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"}

package/dist/rules/require-param-default.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Requires every node parameter to declare a `default` property.
+ *
+ * A parameter is detected structurally: an object literal inside a node's
+ * `description` with `displayName`, `name`, and `type` all set to string
+ * literals — the shape every `INodeProperties` entry has. This avoids
+ * hardcoding the `NodePropertyTypes` union (which would silently go stale as
+ * new types are added) and naturally excludes `options`-array entries, which
+ * carry `name`/`value` but no `displayName`/`type`.
+ *
+ * Without a `default`, n8n cannot reliably initialise the parameter's value,
+ * which leads to inconsistent runtime behaviour in the editor and on execution.
+ */
+export declare const RequireParamDefaultRule: import("@typescript-eslint/utils/ts-eslint").RuleModule<"missingDefault", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+//# sourceMappingURL=require-param-default.d.ts.map

package/dist/rules/require-param-default.d.ts.map

@@ -0,0 +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"}

package/dist/rules/require-param-default.js

@@ -0,0 +1,75 @@
+/**
+ * Requires every node parameter to declare a `default` property.
+ *
+ * A parameter is detected structurally: an object literal inside a node's
+ * `description` with `displayName`, `name`, and `type` all set to string
+ * literals — the shape every `INodeProperties` entry has. This avoids
+ * hardcoding the `NodePropertyTypes` union (which would silently go stale as
+ * new types are added) and naturally excludes `options`-array entries, which
+ * carry `name`/`value` but no `displayName`/`type`.
+ *
+ * Without a `default`, n8n cannot reliably initialise the parameter's value,
+ * which leads to inconsistent runtime behaviour in the editor and on execution.
+ */
+import { simpleTraverse } from '@typescript-eslint/typescript-estree';
+import { AST_NODE_TYPES } from '@typescript-eslint/utils';
+import { createRule, findClassProperty, findObjectProperty, getStringLiteralValue, isFileType, isNodeTypeClass, } from '../utils/index.js';
+/** Property keys an `INodeProperties` parameter always carries as string literals. */
+const REQUIRED_PARAM_KEYS = ['displayName', 'name', 'type'];
+/** Returns true when the object literal has the shape of a node parameter. */
+function isNodeParameter(node) {
+    return REQUIRED_PARAM_KEYS.every((key) => {
+        const property = findObjectProperty(node, key);
+        return property !== null && getStringLiteralValue(property.value) !== null;
+    });
+}
+export const RequireParamDefaultRule = createRule({
+    name: 'require-param-default',
+    meta: {
+        type: 'problem',
+        docs: {
+            description: 'Require every node parameter to declare a default value.',
+        },
+        messages: {
+            missingDefault: "Node parameter '{{ name }}' is missing a `default` value. Add a `default` property so the parameter initialises consistently.",
+        },
+        schema: [],
+    },
+    defaultOptions: [],
+    create(context) {
+        if (!isFileType(context.filename, '.node.ts')) {
+            return {};
+        }
+        const reportIfMissingDefault = (node) => {
+            if (!isNodeParameter(node) || findObjectProperty(node, 'default') !== null) {
+                return;
+            }
+            const nameProperty = findObjectProperty(node, 'name');
+            context.report({
+                node,
+                messageId: 'missingDefault',
+                data: { name: getStringLiteralValue(nameProperty?.value ?? null) ?? '' },
+            });
+        };
+        return {
+            // Scope to an INodeType class's `description`, then walk only that
+            // subtree, so helper classes and object literals elsewhere in the file
+            // (e.g. in method bodies) that share the parameter shape are ignored.
+            ClassDeclaration(node) {
+                if (!isNodeTypeClass(node))
+                    return;
+                const description = findClassProperty(node, 'description');
+                if (description?.value?.type !== AST_NODE_TYPES.ObjectExpression)
+                    return;
+                simpleTraverse(description.value, {
+                    enter(child) {
+                        if (child.type === AST_NODE_TYPES.ObjectExpression) {
+                            reportIfMissingDefault(child);
+                        }
+                    },
+                });
+            },
+        };
+    },
+});
+//# sourceMappingURL=require-param-default.js.map

package/dist/rules/require-param-default.js.map

@@ -0,0 +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"}

package/dist/rules/trigger-node-conventions.d.ts

@@ -0,0 +1,2 @@
+export declare const TriggerNodeConventionsRule: import("@typescript-eslint/utils/ts-eslint").RuleModule<"nameMissingSuffix" | "displayNameMissingTrigger" | "inputsNotEmpty", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+//# sourceMappingURL=trigger-node-conventions.d.ts.map

package/dist/rules/trigger-node-conventions.d.ts.map

@@ -0,0 +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"}

package/dist/rules/trigger-node-conventions.js

@@ -0,0 +1,70 @@
+import { TSESTree } from '@typescript-eslint/utils';
+import { isNodeTypeClass, findClassProperty, findObjectProperty, getStringLiteralValue, isFileType, createRule, } from '../utils/index.js';
+export const TriggerNodeConventionsRule = createRule({
+    name: 'trigger-node-conventions',
+    meta: {
+        type: 'problem',
+        docs: {
+            description: 'Trigger nodes (class name ends with `Trigger`) must label themselves consistently as triggers',
+        },
+        messages: {
+            nameMissingSuffix: "Trigger node `description.name` '{{value}}' must end with 'Trigger'",
+            displayNameMissingTrigger: "Trigger node `description.displayName` '{{value}}' must contain 'Trigger'",
+            inputsNotEmpty: 'Trigger node `description.inputs` must be an empty array `[]`',
+        },
+        schema: [],
+    },
+    defaultOptions: [],
+    create(context) {
+        if (!isFileType(context.filename, '.node.ts')) {
+            return {};
+        }
+        return {
+            ClassDeclaration(node) {
+                if (!isNodeTypeClass(node)) {
+                    return;
+                }
+                if (!node.id?.name.endsWith('Trigger')) {
+                    return;
+                }
+                const descriptionProperty = findClassProperty(node, 'description');
+                if (descriptionProperty?.value?.type !== TSESTree.AST_NODE_TYPES.ObjectExpression) {
+                    return;
+                }
+                const description = descriptionProperty.value;
+                const displayNameProperty = findObjectProperty(description, 'displayName');
+                const displayNameValue = displayNameProperty
+                    ? getStringLiteralValue(displayNameProperty.value)
+                    : null;
+                if (displayNameProperty &&
+                    displayNameValue !== null &&
+                    !displayNameValue.includes('Trigger')) {
+                    context.report({
+                        node: displayNameProperty.value,
+                        messageId: 'displayNameMissingTrigger',
+                        data: { value: displayNameValue },
+                    });
+                }
+                const nameProperty = findObjectProperty(description, 'name');
+                const nameValue = nameProperty ? getStringLiteralValue(nameProperty.value) : null;
+                if (nameProperty && nameValue !== null && !nameValue.endsWith('Trigger')) {
+                    context.report({
+                        node: nameProperty.value,
+                        messageId: 'nameMissingSuffix',
+                        data: { value: nameValue },
+                    });
+                }
+                const inputsProperty = findObjectProperty(description, 'inputs');
+                if (inputsProperty &&
+                    !(inputsProperty.value.type === TSESTree.AST_NODE_TYPES.ArrayExpression &&
+                        inputsProperty.value.elements.length === 0)) {
+                    context.report({
+                        node: inputsProperty.value,
+                        messageId: 'inputsNotEmpty',
+                    });
+                }
+            },
+        };
+    },
+});
+//# sourceMappingURL=trigger-node-conventions.js.map

package/dist/rules/trigger-node-conventions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"trigger-node-conventions.js","sourceRoot":"","sources":["../../src/rules/trigger-node-conventions.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,MAAM,CAAC,MAAM,0BAA0B,GAAG,UAAU,CAAC;IACpD,IAAI,EAAE,0BAA0B;IAChC,IAAI,EAAE;QACL,IAAI,EAAE,SAAS;QACf,IAAI,EAAE;YACL,WAAW,EACV,+FAA+F;SAChG;QACD,QAAQ,EAAE;YACT,iBAAiB,EAAE,qEAAqE;YACxF,yBAAyB,EACxB,2EAA2E;YAC5E,cAAc,EAAE,+DAA+D;SAC/E;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,OAAO;YACN,gBAAgB,CAAC,IAAI;gBACpB,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC;oBAC5B,OAAO;gBACR,CAAC;gBAED,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;oBACxC,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;gBACD,MAAM,WAAW,GAAG,mBAAmB,CAAC,KAAK,CAAC;gBAE9C,MAAM,mBAAmB,GAAG,kBAAkB,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC;gBAC3E,MAAM,gBAAgB,GAAG,mBAAmB;oBAC3C,CAAC,CAAC,qBAAqB,CAAC,mBAAmB,CAAC,KAAK,CAAC;oBAClD,CAAC,CAAC,IAAI,CAAC;gBACR,IACC,mBAAmB;oBACnB,gBAAgB,KAAK,IAAI;oBACzB,CAAC,gBAAgB,CAAC,QAAQ,CAAC,SAAS,CAAC,EACpC,CAAC;oBACF,OAAO,CAAC,MAAM,CAAC;wBACd,IAAI,EAAE,mBAAmB,CAAC,KAAK;wBAC/B,SAAS,EAAE,2BAA2B;wBACtC,IAAI,EAAE,EAAE,KAAK,EAAE,gBAAgB,EAAE;qBACjC,CAAC,CAAC;gBACJ,CAAC;gBAED,MAAM,YAAY,GAAG,kBAAkB,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;gBAC7D,MAAM,SAAS,GAAG,YAAY,CAAC,CAAC,CAAC,qBAAqB,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;gBAClF,IAAI,YAAY,IAAI,SAAS,KAAK,IAAI,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;oBAC1E,OAAO,CAAC,MAAM,CAAC;wBACd,IAAI,EAAE,YAAY,CAAC,KAAK;wBACxB,SAAS,EAAE,mBAAmB;wBAC9B,IAAI,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE;qBAC1B,CAAC,CAAC;gBACJ,CAAC;gBAED,MAAM,cAAc,GAAG,kBAAkB,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;gBACjE,IACC,cAAc;oBACd,CAAC,CACA,cAAc,CAAC,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAC,cAAc,CAAC,eAAe;wBACrE,cAAc,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,CAC1C,EACA,CAAC;oBACF,OAAO,CAAC,MAAM,CAAC;wBACd,IAAI,EAAE,cAAc,CAAC,KAAK;wBAC1B,SAAS,EAAE,gBAAgB;qBAC3B,CAAC,CAAC;gBACJ,CAAC;YACF,CAAC;SACD,CAAC;IACH,CAAC;CACD,CAAC,CAAC"}