eslint-plugin-perfectionist 3.5.0 → 3.7.0

package/dist/index.d.ts

@@ -108,10 +108,13 @@ declare const _default: {
   }
   rules: {
     'sort-variable-declarations': RuleModule<
-      'unexpectedVariableDeclarationsOrder',
+      | 'unexpectedVariableDeclarationsDependencyOrder'
+      | 'unexpectedVariableDeclarationsOrder',
       [
         Partial<{
           type: 'alphabetical' | 'line-length' | 'natural'
+          partitionByComment: string[] | boolean | string
+          partitionByNewLine: boolean
           order: 'desc' | 'asc'
           ignoreCase: boolean
         }>,
@@ -120,10 +123,12 @@ declare const _default: {
       RuleListener
     >
     'sort-intersection-types': RuleModule<
-      'unexpectedIntersectionTypesOrder',
+      | 'unexpectedIntersectionTypesGroupOrder'
+      | 'unexpectedIntersectionTypesOrder',
       [
         Partial<{
           type: 'alphabetical' | 'line-length' | 'natural'
+          partitionByComment: string[] | boolean | string
           groups: (
             | (
                 | 'object'
@@ -156,6 +161,7 @@ declare const _default: {
                 | 'union'
               )
           )[]
+          partitionByNewLine: boolean
           order: 'desc' | 'asc'
           ignoreCase: boolean
         }>,
@@ -164,7 +170,8 @@ declare const _default: {
       RuleListener
     >
     'sort-svelte-attributes': RuleModule<
-      'unexpectedSvelteAttributesOrder',
+      | 'unexpectedSvelteAttributesGroupOrder'
+      | 'unexpectedSvelteAttributesOrder',
       [
         Partial<{
           customGroups: {
@@ -180,7 +187,7 @@ declare const _default: {
       RuleListener
     >
     'sort-astro-attributes': RuleModule<
-      'unexpectedAstroAttributesOrder',
+      'unexpectedAstroAttributesGroupOrder' | 'unexpectedAstroAttributesOrder',
       [
         Partial<{
           customGroups: {
@@ -196,7 +203,7 @@ declare const _default: {
       RuleListener
     >
     'sort-vue-attributes': RuleModule<
-      'unexpectedVueAttributesOrder',
+      'unexpectedVueAttributesGroupOrder' | 'unexpectedVueAttributesOrder',
       [
         Partial<{
           customGroups: {
@@ -223,6 +230,8 @@ declare const _default: {
         Partial<{
           groupKind: 'values-first' | 'types-first' | 'mixed'
           type: 'alphabetical' | 'line-length' | 'natural'
+          partitionByComment: string[] | boolean | string
+          partitionByNewLine: boolean
           order: 'desc' | 'asc'
           ignoreAlias: boolean
           ignoreCase: boolean
@@ -237,6 +246,8 @@ declare const _default: {
         Partial<{
           groupKind: 'values-first' | 'types-first' | 'mixed'
           type: 'alphabetical' | 'line-length' | 'natural'
+          partitionByComment: string[] | boolean | string
+          partitionByNewLine: boolean
           order: 'desc' | 'asc'
           ignoreCase: boolean
         }>,
@@ -245,7 +256,7 @@ declare const _default: {
       RuleListener
     >
     'sort-object-types': RuleModule<
-      'unexpectedObjectTypesOrder',
+      'unexpectedObjectTypesGroupOrder' | 'unexpectedObjectTypesOrder',
       [
         Partial<{
           groupKind: 'required-first' | 'optional-first' | 'mixed'
@@ -253,6 +264,7 @@ declare const _default: {
             [x: string]: string | string[]
           }
           type: 'alphabetical' | 'line-length' | 'natural'
+          partitionByComment: string[] | boolean | string
           groups: (string | string[])[]
           partitionByNewLine: boolean
           order: 'desc' | 'asc'
@@ -263,10 +275,11 @@ declare const _default: {
       RuleListener
     >
     'sort-union-types': RuleModule<
-      'unexpectedUnionTypesOrder',
+      'unexpectedUnionTypesGroupOrder' | 'unexpectedUnionTypesOrder',
       [
         Partial<{
           type: 'alphabetical' | 'line-length' | 'natural'
+          partitionByComment: string[] | boolean | string
           groups: (
             | (
                 | 'object'
@@ -299,6 +312,7 @@ declare const _default: {
                 | 'union'
               )
           )[]
+          partitionByNewLine: boolean
           order: 'desc' | 'asc'
           ignoreCase: boolean
         }>,
@@ -319,7 +333,8 @@ declare const _default: {
       RuleListener
     >
     'sort-interfaces': RuleModule<
-      'unexpectedInterfacePropertiesOrder',
+      | 'unexpectedInterfacePropertiesGroupOrder'
+      | 'unexpectedInterfacePropertiesOrder',
       [
         Partial<{
           groupKind: 'optional-first' | 'required-first' | 'mixed'
@@ -327,6 +342,7 @@ declare const _default: {
             [key: string]: string[] | string
           }
           type: 'alphabetical' | 'line-length' | 'natural'
+          partitionByComment: string[] | boolean | string
           groups: (string | string[])[]
           partitionByNewLine: boolean
           ignorePattern: string[]
@@ -338,7 +354,7 @@ declare const _default: {
       RuleListener
     >
     'sort-jsx-props': RuleModule<
-      'unexpectedJSXPropsOrder',
+      'unexpectedJSXPropsGroupOrder' | 'unexpectedJSXPropsOrder',
       [
         Partial<{
           customGroups: {
@@ -355,13 +371,16 @@ declare const _default: {
       RuleListener
     >
     'sort-classes': RuleModule<
-      'unexpectedClassesGroupOrder' | 'unexpectedClassesOrder',
+      | 'unexpectedClassesDependencyOrder'
+      | 'unexpectedClassesGroupOrder'
+      | 'unexpectedClassesOrder',
       SortClassesOptions,
       unknown,
       RuleListener
     >
     'sort-imports': RuleModule<
       | 'missedSpacingBetweenImports'
+      | 'unexpectedImportsGroupOrder'
       | 'extraSpacingBetweenImports'
       | 'unexpectedImportsOrder',
       [
@@ -396,7 +415,10 @@ declare const _default: {
       'unexpectedExportsOrder',
       [
         Partial<{
+          groupKind: 'values-first' | 'types-first' | 'mixed'
           type: 'alphabetical' | 'line-length' | 'natural'
+          partitionByComment: string[] | boolean | string
+          partitionByNewLine: boolean
           order: 'desc' | 'asc'
           ignoreCase: boolean
         }>,
@@ -405,7 +427,9 @@ declare const _default: {
       RuleListener
     >
     'sort-objects': RuleModule<
-      'unexpectedObjectsOrder',
+      | 'unexpectedObjectsDependencyOrder'
+      | 'unexpectedObjectsGroupOrder'
+      | 'unexpectedObjectsOrder',
       [
         Partial<{
           customGroups: {
@@ -426,7 +450,7 @@ declare const _default: {
       RuleListener
     >
     'sort-enums': RuleModule<
-      'unexpectedEnumsOrder',
+      'unexpectedEnumsDependencyOrder' | 'unexpectedEnumsOrder',
       Options_2,
       unknown,
       RuleListener
@@ -442,6 +466,8 @@ declare const _default: {
       [
         Partial<{
           type: 'alphabetical' | 'line-length' | 'natural'
+          partitionByComment: string[] | boolean | string
+          partitionByNewLine: boolean
           order: 'desc' | 'asc'
           ignoreCase: boolean
         }>,
@@ -507,6 +533,8 @@ declare type Options = [
   Partial<{
     groupKind: 'literals-first' | 'spreads-first' | 'mixed'
     type: 'alphabetical' | 'line-length' | 'natural'
+    partitionByComment: string[] | boolean | string
+    partitionByNewLine: boolean
     order: 'desc' | 'asc'
     ignoreCase: boolean
   }>,
@@ -516,6 +544,7 @@ declare type Options_2 = [
   Partial<{
     type: 'alphabetical' | 'line-length' | 'natural'
     partitionByComment: string[] | boolean | string
+    partitionByNewLine: boolean
     forceNumericSort: boolean
     order: 'desc' | 'asc'
     sortByValue: boolean

package/dist/rules/sort-array-includes.js

@@ -3,7 +3,10 @@ Object.defineProperties(exports, {
   __esModule: { value: true },
   [Symbol.toStringTag]: { value: 'Module' },
 })
+const isPartitionComment = require('../utils/is-partition-comment.js')
+const getCommentsBefore = require('../utils/get-comments-before.js')
 const createEslintRule = require('../utils/create-eslint-rule.js')
+const getLinesBetween = require('../utils/get-lines-between.js')
 const getGroupNumber = require('../utils/get-group-number.js')
 const getSourceCode = require('../utils/get-source-code.js')
 const toSingleLine = require('../utils/to-single-line.js')
@@ -38,6 +41,29 @@ let jsonSchema = {
       enum: ['mixed', 'literals-first', 'spreads-first'],
       type: 'string',
     },
+    partitionByComment: {
+      description:
+        'Allows you to use comments to separate the array members into logical groups.',
+      anyOf: [
+        {
+          type: 'array',
+          items: {
+            type: 'string',
+          },
+        },
+        {
+          type: 'boolean',
+        },
+        {
+          type: 'string',
+        },
+      ],
+    },
+    partitionByNewLine: {
+      description:
+        'Allows to use spaces to separate the nodes into logical groups.',
+      type: 'boolean',
+    },
   },
   additionalProperties: false,
 }
@@ -61,6 +87,8 @@ const sortArrayIncludes = createEslintRule.createEslintRule({
       order: 'asc',
       ignoreCase: true,
       groupKind: 'literals-first',
+      partitionByComment: false,
+      partitionByNewLine: false,
     },
   ],
   create: context => ({
@@ -88,69 +116,99 @@ let sortArray = (context, messageId, elements) => {
       type: 'alphabetical',
       ignoreCase: true,
       order: 'asc',
+      partitionByComment: false,
+      partitionByNewLine: false,
     })
     let sourceCode = getSourceCode.getSourceCode(context)
-    let nodes = elements
-      .reduce(
-        (accumulator, element) => {
-          if (element !== null) {
-            let group = 'unknown'
-            if (typeof options.groupKind === 'string') {
-              group = element.type === 'SpreadElement' ? 'spread' : 'literal'
-            }
-            accumulator.at(0).push({
-              name:
-                element.type === 'Literal'
-                  ? `${element.value}`
-                  : sourceCode.text.slice(...element.range),
-              size: rangeToDiff.rangeToDiff(element.range),
-              type: element.type,
-              node: element,
-              group,
-            })
+    let partitionComment = options.partitionByComment
+    let formattedMembers = elements.reduce(
+      (accumulator, element) => {
+        var _a
+        if (element !== null) {
+          let group = 'unknown'
+          if (typeof options.groupKind === 'string') {
+            group = element.type === 'SpreadElement' ? 'spread' : 'literal'
           }
-          return accumulator
-        },
-        [[], []],
-      )
-      .flat()
-    pairwise.pairwise(nodes, (left, right) => {
-      let groupKindOrder = ['unknown']
-      if (typeof options.groupKind === 'string') {
-        groupKindOrder =
-          options.groupKind === 'literals-first'
-            ? ['literal', 'spread']
-            : ['spread', 'literal']
-      }
-      let leftNum = getGroupNumber.getGroupNumber(groupKindOrder, left)
-      let rightNum = getGroupNumber.getGroupNumber(groupKindOrder, right)
-      if (
-        (options.groupKind !== 'mixed' && leftNum > rightNum) ||
-        ((options.groupKind === 'mixed' || leftNum === rightNum) &&
-          isPositive.isPositive(compare.compare(left, right, options)))
-      ) {
-        context.report({
-          messageId,
-          data: {
-            left: toSingleLine.toSingleLine(left.name),
-            right: toSingleLine.toSingleLine(right.name),
-          },
-          node: right.node,
-          fix: fixer => {
-            let sortedNodes =
-              options.groupKind !== 'mixed'
-                ? groupKindOrder
-                    .map(group => nodes.filter(n => n.group === group))
-                    .map(groupedNodes =>
-                      sortNodes.sortNodes(groupedNodes, options),
-                    )
-                    .flat()
-                : sortNodes.sortNodes(nodes, options)
-            return makeFixes.makeFixes(fixer, nodes, sortedNodes, sourceCode)
-          },
-        })
-      }
-    })
+          let lastSortingNode =
+            (_a = accumulator.at(-1)) == null ? void 0 : _a.at(-1)
+          let sortingNode = {
+            name:
+              element.type === 'Literal'
+                ? `${element.value}`
+                : sourceCode.text.slice(...element.range),
+            size: rangeToDiff.rangeToDiff(element.range),
+            node: element,
+            group,
+          }
+          if (
+            (partitionComment &&
+              isPartitionComment.hasPartitionComment(
+                partitionComment,
+                getCommentsBefore.getCommentsBefore(element, sourceCode),
+              )) ||
+            (options.partitionByNewLine &&
+              lastSortingNode &&
+              getLinesBetween.getLinesBetween(
+                sourceCode,
+                lastSortingNode,
+                sortingNode,
+              ))
+          ) {
+            accumulator.push([])
+          }
+          accumulator.at(-1).push(sortingNode)
+        }
+        return accumulator
+      },
+      [[]],
+    )
+    for (let nodes of formattedMembers) {
+      pairwise.pairwise(nodes, (left, right) => {
+        let groupKindOrder = ['unknown']
+        if (typeof options.groupKind === 'string') {
+          groupKindOrder =
+            options.groupKind === 'literals-first'
+              ? ['literal', 'spread']
+              : ['spread', 'literal']
+        }
+        let leftNum = getGroupNumber.getGroupNumber(groupKindOrder, left)
+        let rightNum = getGroupNumber.getGroupNumber(groupKindOrder, right)
+        if (
+          (options.groupKind !== 'mixed' && leftNum > rightNum) ||
+          ((options.groupKind === 'mixed' || leftNum === rightNum) &&
+            isPositive.isPositive(compare.compare(left, right, options)))
+        ) {
+          context.report({
+            messageId,
+            data: {
+              left: toSingleLine.toSingleLine(left.name),
+              right: toSingleLine.toSingleLine(right.name),
+            },
+            node: right.node,
+            fix: fixer => {
+              let sortedNodes =
+                options.groupKind !== 'mixed'
+                  ? groupKindOrder
+                      .map(group => nodes.filter(n => n.group === group))
+                      .map(groupedNodes =>
+                        sortNodes.sortNodes(groupedNodes, options),
+                      )
+                      .flat()
+                  : sortNodes.sortNodes(nodes, options)
+              return makeFixes.makeFixes(
+                fixer,
+                nodes,
+                sortedNodes,
+                sourceCode,
+                {
+                  partitionComment,
+                },
+              )
+            },
+          })
+        }
+      })
+    }
   }
 }
 exports.default = sortArrayIncludes

package/dist/rules/sort-array-includes.mjs

@@ -1,4 +1,7 @@
+import { hasPartitionComment } from '../utils/is-partition-comment.mjs'
+import { getCommentsBefore } from '../utils/get-comments-before.mjs'
 import { createEslintRule } from '../utils/create-eslint-rule.mjs'
+import { getLinesBetween } from '../utils/get-lines-between.mjs'
 import { getGroupNumber } from '../utils/get-group-number.mjs'
 import { getSourceCode } from '../utils/get-source-code.mjs'
 import { toSingleLine } from '../utils/to-single-line.mjs'
@@ -33,6 +36,29 @@ let jsonSchema = {
       enum: ['mixed', 'literals-first', 'spreads-first'],
       type: 'string',
     },
+    partitionByComment: {
+      description:
+        'Allows you to use comments to separate the array members into logical groups.',
+      anyOf: [
+        {
+          type: 'array',
+          items: {
+            type: 'string',
+          },
+        },
+        {
+          type: 'boolean',
+        },
+        {
+          type: 'string',
+        },
+      ],
+    },
+    partitionByNewLine: {
+      description:
+        'Allows to use spaces to separate the nodes into logical groups.',
+      type: 'boolean',
+    },
   },
   additionalProperties: false,
 }
@@ -56,6 +82,8 @@ const sortArrayIncludes = createEslintRule({
       order: 'asc',
       ignoreCase: true,
       groupKind: 'literals-first',
+      partitionByComment: false,
+      partitionByNewLine: false,
     },
   ],
   create: context => ({
@@ -83,67 +111,87 @@ let sortArray = (context, messageId, elements) => {
       type: 'alphabetical',
       ignoreCase: true,
       order: 'asc',
+      partitionByComment: false,
+      partitionByNewLine: false,
     })
     let sourceCode = getSourceCode(context)
-    let nodes = elements
-      .reduce(
-        (accumulator, element) => {
-          if (element !== null) {
-            let group = 'unknown'
-            if (typeof options.groupKind === 'string') {
-              group = element.type === 'SpreadElement' ? 'spread' : 'literal'
-            }
-            accumulator.at(0).push({
-              name:
-                element.type === 'Literal'
-                  ? `${element.value}`
-                  : sourceCode.text.slice(...element.range),
-              size: rangeToDiff(element.range),
-              type: element.type,
-              node: element,
-              group,
-            })
+    let partitionComment = options.partitionByComment
+    let formattedMembers = elements.reduce(
+      (accumulator, element) => {
+        var _a
+        if (element !== null) {
+          let group = 'unknown'
+          if (typeof options.groupKind === 'string') {
+            group = element.type === 'SpreadElement' ? 'spread' : 'literal'
           }
-          return accumulator
-        },
-        [[], []],
-      )
-      .flat()
-    pairwise(nodes, (left, right) => {
-      let groupKindOrder = ['unknown']
-      if (typeof options.groupKind === 'string') {
-        groupKindOrder =
-          options.groupKind === 'literals-first'
-            ? ['literal', 'spread']
-            : ['spread', 'literal']
-      }
-      let leftNum = getGroupNumber(groupKindOrder, left)
-      let rightNum = getGroupNumber(groupKindOrder, right)
-      if (
-        (options.groupKind !== 'mixed' && leftNum > rightNum) ||
-        ((options.groupKind === 'mixed' || leftNum === rightNum) &&
-          isPositive(compare(left, right, options)))
-      ) {
-        context.report({
-          messageId,
-          data: {
-            left: toSingleLine(left.name),
-            right: toSingleLine(right.name),
-          },
-          node: right.node,
-          fix: fixer => {
-            let sortedNodes =
-              options.groupKind !== 'mixed'
-                ? groupKindOrder
-                    .map(group => nodes.filter(n => n.group === group))
-                    .map(groupedNodes => sortNodes(groupedNodes, options))
-                    .flat()
-                : sortNodes(nodes, options)
-            return makeFixes(fixer, nodes, sortedNodes, sourceCode)
-          },
-        })
-      }
-    })
+          let lastSortingNode =
+            (_a = accumulator.at(-1)) == null ? void 0 : _a.at(-1)
+          let sortingNode = {
+            name:
+              element.type === 'Literal'
+                ? `${element.value}`
+                : sourceCode.text.slice(...element.range),
+            size: rangeToDiff(element.range),
+            node: element,
+            group,
+          }
+          if (
+            (partitionComment &&
+              hasPartitionComment(
+                partitionComment,
+                getCommentsBefore(element, sourceCode),
+              )) ||
+            (options.partitionByNewLine &&
+              lastSortingNode &&
+              getLinesBetween(sourceCode, lastSortingNode, sortingNode))
+          ) {
+            accumulator.push([])
+          }
+          accumulator.at(-1).push(sortingNode)
+        }
+        return accumulator
+      },
+      [[]],
+    )
+    for (let nodes of formattedMembers) {
+      pairwise(nodes, (left, right) => {
+        let groupKindOrder = ['unknown']
+        if (typeof options.groupKind === 'string') {
+          groupKindOrder =
+            options.groupKind === 'literals-first'
+              ? ['literal', 'spread']
+              : ['spread', 'literal']
+        }
+        let leftNum = getGroupNumber(groupKindOrder, left)
+        let rightNum = getGroupNumber(groupKindOrder, right)
+        if (
+          (options.groupKind !== 'mixed' && leftNum > rightNum) ||
+          ((options.groupKind === 'mixed' || leftNum === rightNum) &&
+            isPositive(compare(left, right, options)))
+        ) {
+          context.report({
+            messageId,
+            data: {
+              left: toSingleLine(left.name),
+              right: toSingleLine(right.name),
+            },
+            node: right.node,
+            fix: fixer => {
+              let sortedNodes =
+                options.groupKind !== 'mixed'
+                  ? groupKindOrder
+                      .map(group => nodes.filter(n => n.group === group))
+                      .map(groupedNodes => sortNodes(groupedNodes, options))
+                      .flat()
+                  : sortNodes(nodes, options)
+              return makeFixes(fixer, nodes, sortedNodes, sourceCode, {
+                partitionComment,
+              })
+            },
+          })
+        }
+      })
+    }
   }
 }
 export { sortArrayIncludes as default, jsonSchema, sortArray }