mirror of
https://github.com/n8n-io/n8n.git
synced 2026-06-01 17:27:14 +02:00
1.2 KiB
1.2 KiB
Node class description must have an icon property defined (@n8n/community-nodes/node-class-description-icon-missing)
❌ This rule is deprecated. Use require-node-description-fields instead.
💡 This rule is manually fixable by editor suggestions.
Rule Details
Validates that node classes define an icon property in their description object. Icons are required for nodes to display correctly in the n8n editor.
Examples
❌ Incorrect
export class MyNode implements INodeType {
description: INodeTypeDescription = {
displayName: 'My Node',
name: 'myNode',
// Missing icon property
};
}
✅ Correct
export class MyNode implements INodeType {
description: INodeTypeDescription = {
displayName: 'My Node',
name: 'myNode',
icon: 'file:myNode.svg',
// ...
};
}
export class MyNode implements INodeType {
description: INodeTypeDescription = {
displayName: 'My Node',
name: 'myNode',
icon: {
light: 'file:myNode.svg',
dark: 'file:myNode.dark.svg',
},
// ...
};
}