eslint-plugin-perfectionist 4.1.2 → 4.2.0

package/dist/utils/common-json-schemas.js

@@ -96,7 +96,85 @@ let newlinesBetweenJsonSchema = {
   enum: ['ignore', 'always', 'never'],
   type: 'string',
 }
+let customGroupSortJsonSchema = {
+  type: {
+    enum: ['alphabetical', 'line-length', 'natural', 'unsorted'],
+    description: 'Custom group sort type.',
+    type: 'string',
+  },
+  order: {
+    description: 'Custom group sort order.',
+    enum: ['desc', 'asc'],
+    type: 'string',
+  },
+}
+let customGroupNameJsonSchema = {
+  groupName: {
+    description: 'Custom group name.',
+    type: 'string',
+  },
+}
+let buildCustomGroupsArrayJsonSchema = ({ singleCustomGroupJsonSchema }) => ({
+  items: {
+    oneOf: [
+      {
+        properties: {
+          ...customGroupNameJsonSchema,
+          ...customGroupSortJsonSchema,
+          anyOf: {
+            items: {
+              properties: {
+                ...singleCustomGroupJsonSchema,
+              },
+              description: 'Custom group.',
+              additionalProperties: false,
+              type: 'object',
+            },
+            type: 'array',
+          },
+        },
+        description: 'Custom group block.',
+        additionalProperties: false,
+        type: 'object',
+      },
+      {
+        properties: {
+          ...customGroupNameJsonSchema,
+          ...customGroupSortJsonSchema,
+          ...singleCustomGroupJsonSchema,
+        },
+        description: 'Custom group.',
+        additionalProperties: false,
+        type: 'object',
+      },
+    ],
+  },
+  description: 'Specifies custom groups.',
+  type: 'array',
+})
+let buildCustomGroupModifiersJsonSchema = modifiers => ({
+  items: {
+    enum: modifiers,
+    type: 'string',
+  },
+  description: 'Modifier filters.',
+  type: 'array',
+})
+let buildCustomGroupSelectorJsonSchema = selectors => ({
+  description: 'Selector filter.',
+  enum: selectors,
+  type: 'string',
+})
+let elementNamePatternJsonSchema = {
+  description: 'Element name pattern filter.',
+  type: 'string',
+}
+exports.buildCustomGroupModifiersJsonSchema =
+  buildCustomGroupModifiersJsonSchema
+exports.buildCustomGroupSelectorJsonSchema = buildCustomGroupSelectorJsonSchema
+exports.buildCustomGroupsArrayJsonSchema = buildCustomGroupsArrayJsonSchema
 exports.customGroupsJsonSchema = customGroupsJsonSchema
+exports.elementNamePatternJsonSchema = elementNamePatternJsonSchema
 exports.groupsJsonSchema = groupsJsonSchema
 exports.ignoreCaseJsonSchema = ignoreCaseJsonSchema
 exports.localesJsonSchema = localesJsonSchema

package/dist/utils/compare.js

@@ -18,7 +18,6 @@ let compare = (a, b, options) => {
   } else if (options.type === 'natural') {
     let naturalCompare = naturalOrderby.compare({
       locale: options.locales.toString(),
-      order: options.order,
     })
     let formatString = getFormatStringFunction(
       options.ignoreCase,

package/dist/utils/get-comments-before.js

@@ -1,8 +1,8 @@
 'use strict'
 Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' })
-let getCommentsBefore = (node, source, tokenValueToIgnoreBefore) => {
-  let commentsBefore = getCommentsBeforeNodeOrToken(source, node)
-  let tokenBeforeNode = source.getTokenBefore(node)
+let getCommentsBefore = ({ tokenValueToIgnoreBefore, sourceCode, node }) => {
+  let commentsBefore = getCommentsBeforeNodeOrToken(sourceCode, node)
+  let tokenBeforeNode = sourceCode.getTokenBefore(node)
   if (
     commentsBefore.length ||
     !tokenValueToIgnoreBefore ||
@@ -11,7 +11,7 @@ let getCommentsBefore = (node, source, tokenValueToIgnoreBefore) => {
   ) {
     return commentsBefore
   }
-  return getCommentsBeforeNodeOrToken(source, tokenBeforeNode)
+  return getCommentsBeforeNodeOrToken(sourceCode, tokenBeforeNode)
 }
 let getCommentsBeforeNodeOrToken = (source, node) =>
   source.getCommentsBefore(node).filter(comment => {

package/dist/utils/get-node-range.js

@@ -4,7 +4,12 @@ const utils = require('@typescript-eslint/utils')
 const getEslintDisabledRules = require('./get-eslint-disabled-rules.js')
 const isPartitionComment = require('./is-partition-comment.js')
 const getCommentsBefore = require('./get-comments-before.js')
-let getNodeRange = (node, sourceCode, additionalOptions) => {
+let getNodeRange = ({
+  ignoreHighestBlockComment,
+  sourceCode,
+  options,
+  node,
+}) => {
   let start = node.range.at(0)
   let end = node.range.at(1)
   if (utils.ASTUtils.isParenthesized(node, sourceCode)) {
@@ -19,11 +24,11 @@ let getNodeRange = (node, sourceCode, additionalOptions) => {
     start = bodyOpeningParen.range.at(0)
     end = bodyClosingParen.range.at(1)
   }
-  let comments = getCommentsBefore.getCommentsBefore(node, sourceCode)
-  let partitionComment =
-    (additionalOptions == null
-      ? void 0
-      : additionalOptions.partitionByComment) ?? false
+  let comments = getCommentsBefore.getCommentsBefore({
+    sourceCode,
+    node,
+  })
+  let highestBlockComment = comments.find(comment => comment.type === 'Block')
   let relevantTopComment
   for (let i = comments.length - 1; i >= 0; i--) {
     let comment = comments[i]
@@ -31,7 +36,10 @@ let getNodeRange = (node, sourceCode, additionalOptions) => {
       comment.value,
     )
     if (
-      isPartitionComment.isPartitionComment(partitionComment, comment.value) ||
+      isPartitionComment.isPartitionComment(
+        (options == null ? void 0 : options.partitionByComment) ?? false,
+        comment.value,
+      ) ||
       (eslintDisabledRules == null
         ? void 0
         : eslintDisabledRules.eslintDisableDirective) === 'eslint-disable' ||
@@ -48,6 +56,9 @@ let getNodeRange = (node, sourceCode, additionalOptions) => {
     if (comment.loc.end.line !== previousCommentOrNodeStartLine - 1) {
       break
     }
+    if (ignoreHighestBlockComment && comment === highestBlockComment) {
+      break
+    }
     relevantTopComment = comment
   }
   if (relevantTopComment) {

package/dist/utils/make-fixes.js

@@ -2,18 +2,33 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' })
 const makeCommentAfterFixes = require('./make-comment-after-fixes.js')
 const getNodeRange = require('./get-node-range.js')
-let makeFixes = ({ sortedNodes, sourceCode, options, fixer, nodes }) => {
+let makeFixes = ({
+  ignoreFirstNodeHighestBlockComment,
+  sortedNodes,
+  sourceCode,
+  options,
+  fixer,
+  nodes,
+}) => {
   let fixes = []
   for (let max = nodes.length, i = 0; i < max; i++) {
     let sortingNode = nodes.at(i)
     let sortedSortingNode = sortedNodes.at(i)
     let { node } = sortingNode
     let { addSafetySemicolonWhenInline, node: sortedNode } = sortedSortingNode
+    let isNodeFirstNode = node === nodes.at(0).node
+    let isSortedNodeFirstNode = sortedNode === nodes.at(0).node
     if (node === sortedNode) {
       continue
     }
     let sortedNodeCode = sourceCode.text.slice(
-      ...getNodeRange.getNodeRange(sortedNode, sourceCode, options),
+      ...getNodeRange.getNodeRange({
+        ignoreHighestBlockComment:
+          ignoreFirstNodeHighestBlockComment && isSortedNodeFirstNode,
+        node: sortedNode,
+        sourceCode,
+        options,
+      }),
     )
     let sortedNodeText = sourceCode.getText(sortedNode)
     let tokensAfter = sourceCode.getTokensAfter(node, {
@@ -39,7 +54,13 @@ let makeFixes = ({ sortedNodes, sourceCode, options, fixer, nodes }) => {
     }
     fixes.push(
       fixer.replaceTextRange(
-        getNodeRange.getNodeRange(node, sourceCode, options),
+        getNodeRange.getNodeRange({
+          ignoreHighestBlockComment:
+            ignoreFirstNodeHighestBlockComment && isNodeFirstNode,
+          sourceCode,
+          options,
+          node,
+        }),
         sortedNodeCode,
       ),
     )

package/dist/utils/make-newlines-fixes.js

@@ -25,12 +25,15 @@ let makeNewlinesFixes = ({
       options.groups,
       nextSortingNode,
     )
-    let currentNodeRange = getNodeRange.getNodeRange(
-      nodes.at(i).node,
+    let currentNodeRange = getNodeRange.getNodeRange({
+      node: nodes.at(i).node,
       sourceCode,
-    )
+    })
     let nextNodeRangeStart = getNodeRange
-      .getNodeRange(nodes.at(i + 1).node, sourceCode)
+      .getNodeRange({
+        node: nodes.at(i + 1).node,
+        sourceCode,
+      })
       .at(0)
     let rangeToReplace = [currentNodeRange.at(1), nextNodeRangeStart]
     let textBetweenNodes = sourceCode.text.slice(

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-perfectionist",
-  "version": "4.1.2",
+  "version": "4.2.0",
   "description": "ESLint plugin for sorting various data such as objects, imports, types, enums, JSX props, etc.",
   "keywords": [
     "eslint",
@@ -14,8 +14,8 @@
   "type": "commonjs",
   "exports": {
     ".": {
-      "default": "./dist/index.js",
-      "types": "./dist/index.d.ts"
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
     },
     "./package.json": "./package.json"
   },
@@ -23,8 +23,8 @@
     "./dist"
   ],
   "dependencies": {
-    "@typescript-eslint/types": "^8.16.0",
-    "@typescript-eslint/utils": "^8.16.0",
+    "@typescript-eslint/types": "^8.17.0",
+    "@typescript-eslint/utils": "^8.17.0",
     "natural-orderby": "^5.0.0"
   },
   "peerDependencies": {