node-param-description-unneeded-backticks.md

node-param-description-unneeded-backticks

description in node parameter must not use unneeded backticks. 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 = {
	name: "Timezone",
	value: "timezone",
	description: `Seatable server's timezone`,
};

const test = {
	name: "Timezone",
	value: "timezone",
	description: `AAA 'bbb' CCC`,
};

✅ 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 = {
	displayName: "Access Token",
	name: "accessToken",
	type: "string",
	default: "",
	description: `The access token must have the following scopes:
    <ul>
        <li>Create/modify webhooks</li>
        <li>View webhooks</li>
        <li>View surveys</li>
        <li>View collectors</li>
        <li>View responses</li>
        <li>View response details</li>
    </ul>`,
};

Links

• Rule source
• Test source