@n8n/eslint-plugin-community-nodes 0.17.0 → 0.19.0

package/src/rules/node-usable-as-tool.ts

@@ -1,4 +1,4 @@
-import { TSESTree } from '@typescript-eslint/types';
+import { TSESTree } from '@typescript-eslint/utils';
 
 import {
 	isNodeTypeClass,

package/src/rules/package-name-convention.test.ts

@@ -26,11 +26,6 @@ ruleTester.run('package-name-convention', PackageNameConventionRule, {
 			filename: 'package.json',
 			code: '{ "name": "@author/n8n-nodes-service", "version": "1.0.0" }',
 		},
-		{
-			name: 'object without name property',
-			filename: 'package.json',
-			code: '{ "version": "1.0.0", "description": "test" }',
-		},
 		{
 			name: 'non-package.json file ignored',
 			filename: 'some-config.json',
@@ -185,5 +180,37 @@ ruleTester.run('package-name-convention', PackageNameConventionRule, {
 				},
 			],
 		},
+		{
+			name: 'missing name property',
+			filename: 'package.json',
+			code: '{ "version": "1.0.0", "description": "test" }',
+			errors: [
+				{
+					messageId: 'missingName',
+				},
+			],
+		},
+		{
+			name: 'default placeholder name',
+			filename: 'package.json',
+			code: '{ "name": "n8n-nodes-<...>", "version": "1.0.0" }',
+			errors: [
+				{
+					messageId: 'defaultPlaceholderName',
+					data: { packageName: 'n8n-nodes-<...>' },
+				},
+			],
+		},
+		{
+			name: 'name containing default placeholder',
+			filename: 'package.json',
+			code: '{ "name": "@company/n8n-nodes-<...>", "version": "1.0.0" }',
+			errors: [
+				{
+					messageId: 'defaultPlaceholderName',
+					data: { packageName: '@company/n8n-nodes-<...>' },
+				},
+			],
+		},
 	],
 });

package/src/rules/package-name-convention.ts

@@ -15,6 +15,10 @@ export const PackageNameConventionRule = createRule({
 			renameTo: "Rename to '{{suggestedName}}'",
 			invalidPackageName:
 				'Package name "{{ packageName }}" must follow the convention "n8n-nodes-[PACKAGE-NAME]" or "@[AUTHOR]/n8n-nodes-[PACKAGE-NAME]"',
+			missingName:
+				'Package name is missing. Add a "name" field following the convention "n8n-nodes-[PACKAGE-NAME]" or "@[AUTHOR]/n8n-nodes-[PACKAGE-NAME]"',
+			defaultPlaceholderName:
+				'Package name "{{ packageName }}" still contains the default placeholder. Replace "<...>" with your package name',
 		},
 		schema: [],
 		hasSuggestions: true,
@@ -34,6 +38,10 @@ export const PackageNameConventionRule = createRule({
 				const nameProperty = findJsonProperty(node, 'name');
 
 				if (!nameProperty) {
+					context.report({
+						node,
+						messageId: 'missingName',
+					});
 					return;
 				}
 
@@ -44,6 +52,17 @@ export const PackageNameConventionRule = createRule({
 				const packageName = nameProperty.value.value;
 				const packageNameStr = typeof packageName === 'string' ? packageName : null;
 
+				if (packageNameStr && isDefaultPlaceholderName(packageNameStr)) {
+					context.report({
+						node: nameProperty,
+						messageId: 'defaultPlaceholderName',
+						data: {
+							packageName: packageNameStr,
+						},
+					});
+					return;
+				}
+
 				if (!packageNameStr || !isValidPackageName(packageNameStr)) {
 					const suggestions: ReportSuggestionArray<'invalidPackageName' | 'renameTo'> = [];
 
@@ -75,6 +94,10 @@ export const PackageNameConventionRule = createRule({
 	},
 });
 
+function isDefaultPlaceholderName(name: string): boolean {
+	return name.includes('<...>');
+}
+
 function isValidPackageName(name: string): boolean {
 	const unscoped = /^n8n-nodes-.+$/;
 	const scoped = /^@.+\/n8n-nodes-.+$/;

package/src/rules/require-node-api-error.ts

@@ -1,5 +1,4 @@
-import { DefinitionType } from '@typescript-eslint/scope-manager';
-import { AST_NODE_TYPES, type TSESTree } from '@typescript-eslint/utils';
+import { AST_NODE_TYPES, TSESLint, type TSESTree } from '@typescript-eslint/utils';
 
 import { isFileType } from '../utils/index.js';
 import { createRule } from '../utils/rule-creator.js';
@@ -68,7 +67,9 @@ export const RequireNodeApiErrorRule = createRule({
 					const scope = context.sourceCode.getScope(node);
 					const ref = scope.references.find((r) => r.identifier === argument);
 					const isCatchParam =
-						ref?.resolved?.defs.some((def) => def.type === DefinitionType.CatchClause) ?? false;
+						ref?.resolved?.defs.some(
+							(def) => def.type === TSESLint.Scope.DefinitionType.CatchClause,
+						) ?? false;
 
 					if (isCatchParam) {
 						context.report({ node, messageId: 'useNodeApiError' });

package/src/rules/valid-credential-references.ts

@@ -1,4 +1,4 @@
-import { TSESTree } from '@typescript-eslint/types';
+import { TSESTree } from '@typescript-eslint/utils';
 import type { ReportSuggestionArray } from '@typescript-eslint/utils/ts-eslint';
 
 import {

package/src/rules/valid-description.test.ts

@@ -0,0 +1,56 @@
+import { RuleTester } from '@typescript-eslint/rule-tester';
+
+import { ValidDescriptionRule } from './valid-description.js';
+
+const ruleTester = new RuleTester();
+
+ruleTester.run('valid-description', ValidDescriptionRule, {
+	valid: [
+		{
+			name: 'description is a non-empty string',
+			filename: 'package.json',
+			code: '{ "name": "n8n-nodes-example", "description": "Nodes for talking to Acme Corp\'s API" }',
+		},
+		{
+			name: 'non-package.json file is ignored',
+			filename: 'some-config.json',
+			code: '{ "name": "n8n-nodes-example" }',
+		},
+		{
+			name: 'nested objects with empty description are not checked',
+			filename: 'package.json',
+			code: '{ "name": "n8n-nodes-example", "description": "Real description", "config": { "description": "" } }',
+		},
+		{
+			name: 'objects inside arrays (e.g. contributors) are not flagged',
+			filename: 'package.json',
+			code: `{
+				"name": "n8n-nodes-example",
+				"description": "Real description",
+				"contributors": [
+					{ "name": "Alice", "description": "" }
+				]
+			}`,
+		},
+	],
+	invalid: [
+		{
+			name: 'description field is missing entirely',
+			filename: 'package.json',
+			code: '{ "name": "n8n-nodes-example", "version": "1.0.0" }',
+			errors: [{ messageId: 'missingDescription' }],
+		},
+		{
+			name: 'description is an empty string (starter template default)',
+			filename: 'package.json',
+			code: '{ "name": "n8n-nodes-example", "description": "" }',
+			errors: [{ messageId: 'emptyDescription' }],
+		},
+		{
+			name: 'empty package.json object',
+			filename: 'package.json',
+			code: '{}',
+			errors: [{ messageId: 'missingDescription' }],
+		},
+	],
+});

package/src/rules/valid-description.ts

@@ -0,0 +1,57 @@
+import type { TSESTree } from '@typescript-eslint/utils';
+import { AST_NODE_TYPES } from '@typescript-eslint/utils';
+
+import { createRule, findJsonProperty } from '../utils/index.js';
+
+export const ValidDescriptionRule = createRule({
+	name: 'valid-description',
+	meta: {
+		type: 'problem',
+		docs: {
+			description: 'Require a non-empty "description" field in community node package.json',
+		},
+		messages: {
+			missingDescription:
+				'The package.json must have a "description" field describing what the community node package does.',
+			emptyDescription:
+				'The "description" field must be a non-empty string. Replace the placeholder with a real description of your community node package.',
+		},
+		schema: [],
+	},
+	defaultOptions: [],
+	create(context) {
+		if (!context.filename.endsWith('package.json')) {
+			return {};
+		}
+
+		return {
+			ObjectExpression(node: TSESTree.ObjectExpression) {
+				if (node.parent?.type !== AST_NODE_TYPES.ExpressionStatement) {
+					return;
+				}
+
+				const descriptionProp = findJsonProperty(node, 'description');
+
+				if (!descriptionProp) {
+					context.report({
+						node,
+						messageId: 'missingDescription',
+					});
+					return;
+				}
+
+				if (descriptionProp.value.type !== AST_NODE_TYPES.Literal) {
+					return;
+				}
+
+				const value = descriptionProp.value.value;
+				if (typeof value !== 'string' || value === '') {
+					context.report({
+						node: descriptionProp,
+						messageId: 'emptyDescription',
+					});
+				}
+			},
+		};
+	},
+});