node-class-description-empty-string.md

node-class-description-empty-string

description in node class description must be filled out.

📋 This rule is part of the plugin:n8n-nodes-base/nodes config.

Examples

❌ Example of incorrect code:

class TestNode {
	description = {
		displayName: "TestTrigger",
		name: "testTrigger",
		icon: "file:test.svg",
		group: ["transform"],
		version: 1,
		subtitle: '={{ $parameter["operation"] + ": " + $parameter["resource"] }}',
		description: "",
		defaults: {
			name: "Test",
		},
		inputs: ["main"],
		outputs: ["main"],
	};
}

✅ Example of correct code:

class TestNode {
	description = {
		displayName: "TestTrigger",
		name: "testTrigger",
		icon: "file:test.svg",
		group: ["transform"],
		version: 1,
		subtitle: '={{ $parameter["operation"] + ": " + $parameter["resource"] }}',
		description: "This is a sentence",
		defaults: {
			name: "Test",
		},
		inputs: ["main"],
		outputs: ["main"],
	};
}

Links

• Rule source
• Test source