feat!: rename optionality order option to group kind in sort-interfaces rule

Author: azat-io

docs/content/rules/sort-interfaces.mdx

@@ -195,15 +195,15 @@ interface User {
 
 In this example, the partitionByNewLine option will cause the rule to treat each group of members (separated by empty lines) independently, preserving their order within each group.
 
-### optionalityOrder
+### groupKind
 
-<sub>default: `'ignore'`</sub>
+<sub>default: `'mixed'`</sub>
 
 Specifies how optional and required members should be ordered in TypeScript interfaces.
 
 - `'optional-first'` — Put all optional members before required members.
 - `'required-first'` — Put all required members before optional members.
-- `'ignore'` — Do not enforce any specific order based on optionality.
+- `'mixed'` — Do not enforce any specific order based on optionality.
 
 ### groups
 

rules/sort-interfaces.ts

@@ -23,7 +23,7 @@ type Group<T extends string[]> = 'multiline' | 'unknown' | T[number]
 
 type Options<T extends string[]> = [
   Partial<{
-    optionalityOrder: 'optional-first' | 'required-first' | 'ignore'
+    groupKind: 'optional-first' | 'required-first' | 'mixed'
     customGroups: { [key: string]: string[] | string }
     type: 'alphabetical' | 'line-length' | 'natural'
     groups: (Group<T>[] | Group<T>)[]
@@ -75,9 +75,9 @@ export default createEslintRule<Options<string[]>, MESSAGE_ID>({
               'Allows to use spaces to separate the nodes into logical groups.',
             type: 'boolean',
           },
-          optionalityOrder: {
+          groupKind: {
             description: 'Specifies the order of optional and required nodes.',
-            enum: ['ignore', 'optional-first', 'required-first'],
+            enum: ['mixed', 'optional-first', 'required-first'],
             type: 'string',
           },
           groups: {
@@ -130,7 +130,7 @@ export default createEslintRule<Options<string[]>, MESSAGE_ID>({
       ignoreCase: true,
       ignorePattern: [],
       partitionByNewLine: false,
-      optionalityOrder: 'ignore',
+      groupKind: 'mixed',
       groups: [],
       customGroups: {},
     },
@@ -139,9 +139,9 @@ export default createEslintRule<Options<string[]>, MESSAGE_ID>({
     TSInterfaceDeclaration: node => {
       if (node.body.body.length > 1) {
         let options = complete(context.options.at(0), {
-          optionalityOrder: 'ignore',
           partitionByNewLine: false,
           type: 'alphabetical',
+          groupKind: 'mixed',
           ignorePattern: [],
           ignoreCase: true,
           customGroups: {},
@@ -266,15 +266,15 @@ export default createEslintRule<Options<string[]>, MESSAGE_ID>({
             )
           }
 
-          let { optionalityOrder } = options
+          let { groupKind } = options
 
           let checkOrder = (
             members: SortingNode[],
             left: SortingNode,
             right: SortingNode,
             iteration: number,
           ) => {
-            if (optionalityOrder === 'ignore') {
+            if (groupKind === 'mixed') {
               return checkGroupSort(left, right)
             }
 
@@ -291,8 +291,7 @@ export default createEslintRule<Options<string[]>, MESSAGE_ID>({
 
             if (isMemberOptional(left.node) !== isMemberOptional(right.node)) {
               return (
-                isMemberOptional(left.node) !==
-                (optionalityOrder === 'optional-first')
+                isMemberOptional(left.node) !== (groupKind === 'optional-first')
               )
             }
 
@@ -312,7 +311,7 @@ export default createEslintRule<Options<string[]>, MESSAGE_ID>({
                   fix: fixer => {
                     let sortedNodes
 
-                    if (optionalityOrder !== 'ignore') {
+                    if (groupKind !== 'mixed') {
                       let optionalNodes = nodes.filter(member =>
                         isMemberOptional(member.node),
                       )
@@ -321,7 +320,7 @@ export default createEslintRule<Options<string[]>, MESSAGE_ID>({
                       )
 
                       sortedNodes =
-                        optionalityOrder === 'optional-first'
+                        groupKind === 'optional-first'
                           ? [
                               ...toSorted(optionalNodes),
                               ...toSorted(requiredNodes),

test/sort-interfaces.test.ts

@@ -670,7 +670,7 @@ describe(ruleName, () => {
           options: [
             {
               ...options,
-              optionalityOrder: 'optional-first',
+              groupKind: 'optional-first',
             },
           ],
         },
@@ -698,7 +698,7 @@ describe(ruleName, () => {
           options: [
             {
               ...options,
-              optionalityOrder: 'optional-first',
+              groupKind: 'optional-first',
             },
           ],
           errors: [
@@ -746,7 +746,7 @@ describe(ruleName, () => {
                   last: 'a',
                 },
                 groups: ['unknown', 'last'],
-                optionalityOrder: 'optional-first',
+                groupKind: 'optional-first',
               },
             ],
             errors: [
@@ -1338,7 +1338,7 @@ describe(ruleName, () => {
           options: [
             {
               ...options,
-              optionalityOrder: 'optional-first',
+              groupKind: 'optional-first',
             },
           ],
         },
@@ -1366,7 +1366,7 @@ describe(ruleName, () => {
           options: [
             {
               ...options,
-              optionalityOrder: 'optional-first',
+              groupKind: 'optional-first',
             },
           ],
           errors: [
@@ -1969,7 +1969,7 @@ describe(ruleName, () => {
           options: [
             {
               ...options,
-              optionalityOrder: 'optional-first',
+              groupKind: 'optional-first',
             },
           ],
         },
@@ -1997,7 +1997,7 @@ describe(ruleName, () => {
           options: [
             {
               ...options,
-              optionalityOrder: 'optional-first',
+              groupKind: 'optional-first',
             },
           ],
           errors: [
@@ -2025,7 +2025,7 @@ describe(ruleName, () => {
           options: [
             {
               ...options,
-              optionalityOrder: 'required-first',
+              groupKind: 'required-first',
             },
           ],
         },
@@ -2053,7 +2053,7 @@ describe(ruleName, () => {
           options: [
             {
               ...options,
-              optionalityOrder: 'required-first',
+              groupKind: 'required-first',
             },
           ],
           errors: [
@@ -2108,7 +2108,7 @@ describe(ruleName, () => {
                   callback: 'on*',
                 },
                 groups: ['unknown', 'callback'],
-                optionalityOrder: 'required-first',
+                groupKind: 'required-first',
               },
             ],
             errors: [
@@ -2172,7 +2172,7 @@ describe(ruleName, () => {
             options: [
               {
                 ...options,
-                optionalityOrder: 'required-first',
+                groupKind: 'required-first',
                 partitionByNewLine: true,
               },
             ],