n8n/packages/@n8n/eslint-plugin-community-nodes/docs/rules/node-class-description-icon-missing.md

1.3 KiB

Node class description must have an icon property defined. Deprecated: use require-node-description-fields instead (@n8n/community-nodes/node-class-description-icon-missing)

This rule is deprecated.

💡 This rule is manually fixable by editor suggestions.

Deprecated: Use require-node-description-fields instead.

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',
    },
    // ...
  };
}