node-param-description-boolean-without-whether

description in a boolean node parameter must start with Whether.

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

Examples

❌ Example of incorrect code:

const test = {
	displayName: "Test",
	name: "test",
	type: "boolean",
	default: true,
	description: "This is wrong",
};

✅ Example of correct code:

const test = {
	displayName: "Test",
	name: "test",
	type: "boolean",
	default: true,
	description: "Whether to do something",
};