node-param-description-url-missing-protocol.md

node-param-description-url-missing-protocol

description in node parameter must include protocol e.g. https:// when containing a URL. Applicable by extension to description in option in options-type and multi-options-type node parameter.

📋 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: "Test",
	name: "test",
	type: "string",
	default: "",
	description: 'This is a <a href="github.com">link</a>',
};

const test = {
	displayName: "Test",
	name: "test",
	type: "string",
	default: "",
	description: "This is a <a href='github.com'>link</a>",
};

const test = {
	name: "Test",
	value: "test",
	description: 'This is a <a href="github.com">link</a>',
};

const test = {
	name: "Test",
	value: "test",
	description: "This is a <a href='github.com'>link</a>",
};

✅ Example of correct code:

const test = {
	displayName: "Test",
	name: "test",
	type: "string",
	default: "",
	description: 'This is a <a href="https://github.com">link</a>',
};

const test = {
	displayName: "Test",
	name: "test",
	type: "string",
	default: "",
	description: "This is a <a href='https://github.com'>link</a>",
};

const test = {
	name: "Test",
	value: "test",
	description: 'This is a <a href="https://github.com">link</a>',
};

const test = {
	name: "Test",
	value: "test",
	description: "This is a <a href='https://github.com'>link</a>",
};

Links

• Rule source
• Test source