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

node-param-description-excess-final-period

description in node parameter must end without a final period if a single-sentence description. 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.",
};

const test = {
	name: "User ID",
	value: "userId",
	description: "The ID of the user.",
};

const test = {
	displayName: "Address",
	name: "address",
	type: "string",
	default: "",
	description: "Person's email address.",
};

const test = {
	displayName: "Name",
	name: "name",
	type: "string",
	default: "",
	description: `Custom Field\'s name.`,
};

✅ Example of correct code:

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

const test = {
	name: "User ID",
	value: "userId",
	description: "The ID of the user",
};

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

Links

• Rule source
• Test source