Enforce alphabetical ordering of options arrays in n8n node properties (@n8n/community-nodes/options-sorted-alphabetically)

⚠️ This rule warns in the following configs: ✅ recommended, ☑️ recommendedWithoutN8nCloudSupport.

Rule Details

Warns when an options-type parameter has its options array not sorted alphabetically by name. Applies to all type: 'options' parameters — including resource, operation, and any other dropdowns.

Alphabetical ordering is an official n8n UI design requirement and the most frequently flagged issue in community node reviews.

Comparison is case-insensitive and locale-aware (handles non-ASCII names such as Spanish or Portuguese labels).

Examples

❌ Incorrect

  description: INodeTypeDescription = {
    displayName: 'My Service',
    name: 'myService',
    properties: [
      {
        displayName: 'Resource',
        name: 'resource',
        type: 'options',
        options: [
          { name: 'User', value: 'user' },
          { name: 'Contact', value: 'contact' }, // out of order
          { name: 'Project', value: 'project' },
        ],
        default: 'user',
      },
    ],
  };
}

✅ Correct

  description: INodeTypeDescription = {
    displayName: 'My Service',
    name: 'myService',
    properties: [
      {
        displayName: 'Resource',
        name: 'resource',
        type: 'options',
        options: [
          { name: 'Contact', value: 'contact' },
          { name: 'Project', value: 'project' },
          { name: 'User', value: 'user' },
        ],
        default: 'contact',
      },
    ],
  };
}