node-param-description-wrong-for-dynamic-multi-options.md

node-param-description-wrong-for-dynamic-multi-options

description in dynamic-multi-options-type node parameter must be Choose from the list, or specify IDs using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>

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

🔧 Run ESLint with --fix option to autofix the issue flagged by this rule.

Examples

❌ Example of incorrect code:

const test = {
	displayName: "Field Name or ID",
	name: "field",
	type: "multiOptions",
	typeOptions: {
		loadOptionsMethod: "getFields",
	},
	default: [],
	description: "This is a sentence",
};

const test = {
	displayName: "Field Name or ID",
	name: "field",
	type: "multiOptions",
	typeOptions: {
		loadOptionsMethod: "getFields",
	},
	default: [],
	description: "This is a sentence. This is another.",
};

✅ Example of correct code:

const test = {
	displayName: "Field Name or ID",
	name: "field",
	type: "multiOptions",
	typeOptions: {
		loadOptionsMethod: "getFields",
	},
	default: [],
	description:
		'Choose from the list, or specify IDs using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>',
};

const test = {
	displayName: "Field Name or ID",
	name: "field",
	type: "multiOptions",
	typeOptions: {
		loadOptionsMethod: "getFields",
	},
	default: [],
	description:
		'This is a sentence. Choose from the list, or specify IDs using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
};

Links

• Rule source
• Test source