node-param-description-miscased-json.md

node-param-description-miscased-json

JSON in description in node parameter must be fully uppercased. 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: "JSON",
	name: "json",
	type: "string",
	default: "",
	description: "The json to send",
};

const test = {
	displayName: "JSON",
	name: "json",
	type: "string",
	default: "",
	description: "The Json to send",
};

const test = {
	name: "JSON",
	value: "json",
	description: "The json to send",
};

const test = {
	name: "JSON",
	value: "json",
	description: "The json to send. The json to send.",
};

const test = {
	name: "JSON",
	value: "json",
	description: "The Json to send",
};

✅ Example of correct code:

const test = {
	displayName: "JSON",
	name: "json",
	type: "string",
	default: "",
	description: "The JSON to send",
};

const test = {
	name: "JSON",
	value: "json",
	description: "The JSON",
};

Links

• Rule source
• Test source