node-param-description-missing-final-period.md

node-param-description-missing-final-period

description in node parameter must end with a final period if a multiple-sentence description, unless ending with </code>. 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 a sentence. This is another",
};

const test = {
	name: "Username",
	value: "username",
	description: "First sentence. Second sentence",
};

const test = {
	name: "Username",
	value: "username",
	description: "Person's email address. Another",
};

✅ Example of correct code:

const test = {
	displayName: "Test",
	name: "test",
	type: "string",
	default: "",
	description: "This a sentence. This is another.",
};

const test = {
	displayName: "Test",
	name: "test",
	type: "string",
	default: "",
	description: "This a sentence. This is another</code>",
};

const test = {
	name: "Username",
	value: "username",
	description: "First sentence. Second sentence.",
};

const test = {
	name: "Username",
	value: "username",
	description: "Start e.g. end",
};

const test = {
	displayName: "Test",
	name: "test",
	type: "string",
	default: "",
	description:
		"Use the multiline editor. Make sure it is in standard PEM key format:-----BEGIN PRIVATE KEY-----KEY DATA GOES HERE-----END PRIVATE KEY-----",
};

Links

• Rule source
• Test source