eslint-plugin-perfectionist 4.5.0 → 4.6.0

package/dist/rules/sort-imports.js

@@ -97,7 +97,7 @@ const sortImports = createEslintRule.createEslintRule({
         })
       : null
     let isSideEffectOnlyGroup = group => {
-      if (!group) {
+      if (!group || (typeof group === 'object' && 'newlinesBetween' in group)) {
         return false
       }
       if (typeof group === 'string') {

package/dist/rules/sort-objects/get-first-node-parent-with-type.js

@@ -1,7 +1,10 @@
 'use strict'
 Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' })
-let getFirstNodeParentWithType = ({ allowedTypes, node }) => {
+let getFirstNodeParentWithType = ({ onlyFirstParent, allowedTypes, node }) => {
   let { parent } = node
+  if (onlyFirstParent) {
+    return parent && allowedTypes.includes(parent.type) ? parent : null
+  }
   while (parent) {
     if (allowedTypes.includes(parent.type)) {
       return parent

package/dist/rules/sort-objects.js

@@ -55,7 +55,10 @@ const sortObjects = createEslintRule.createEslintRule({
       if (!isSortable.isSortable(nodeObject.properties)) {
         return
       }
-      let objectParent = getObjectParent({ node: nodeObject })
+      let objectParent = getObjectParent({
+        onlyFirstParent: true,
+        node: nodeObject,
+      })
       let matchedContextOptions = getMatchingContextOptions
         .getMatchingContextOptions({
           nodeNames: nodeObject.properties
@@ -114,10 +117,16 @@ const sortObjects = createEslintRule.createEslintRule({
       } else if (options.destructureOnly || !options.objectDeclarations) {
         return
       }
+      let objectParentForIgnorePattern = getObjectParent({
+        onlyFirstParent: false,
+        node: nodeObject,
+      })
       if (
-        (objectParent == null ? void 0 : objectParent.name) &&
+        (objectParentForIgnorePattern == null
+          ? void 0
+          : objectParentForIgnorePattern.name) &&
         options.ignorePattern.some(pattern =>
-          matches.matches(objectParent.name, pattern),
+          matches.matches(objectParentForIgnorePattern.name, pattern),
         )
       ) {
         return
@@ -501,15 +510,18 @@ let getNodeName = ({ sourceCode, property }) => {
   }
   return sourceCode.getText(property.key)
 }
-let getObjectParent = ({ node }) => {
-  let variableParentName = getVariableParentName({ node })
+let getObjectParent = ({ onlyFirstParent, node }) => {
+  let variableParentName = getVariableParentName({ onlyFirstParent, node })
   if (variableParentName) {
     return {
       type: 'VariableDeclarator',
       name: variableParentName,
     }
   }
-  let callParentName = getCallExpressionParentName({ node })
+  let callParentName = getCallExpressionParentName({
+    onlyFirstParent,
+    node,
+  })
   if (callParentName) {
     return {
       type: 'CallExpression',
@@ -518,12 +530,13 @@ let getObjectParent = ({ node }) => {
   }
   return null
 }
-let getVariableParentName = ({ node }) => {
+let getVariableParentName = ({ onlyFirstParent, node }) => {
   let variableParent = getFirstNodeParentWithType.getFirstNodeParentWithType({
     allowedTypes: [
       types.TSESTree.AST_NODE_TYPES.VariableDeclarator,
       types.TSESTree.AST_NODE_TYPES.Property,
     ],
+    onlyFirstParent,
     node,
   })
   if (!variableParent) {
@@ -539,9 +552,10 @@ let getVariableParentName = ({ node }) => {
   }
   return parentId.type === 'Identifier' ? parentId.name : null
 }
-let getCallExpressionParentName = ({ node }) => {
+let getCallExpressionParentName = ({ onlyFirstParent, node }) => {
   let callParent = getFirstNodeParentWithType.getFirstNodeParentWithType({
     allowedTypes: [types.TSESTree.AST_NODE_TYPES.CallExpression],
+    onlyFirstParent,
     node,
   })
   if (!callParent) {

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

@@ -45,6 +45,11 @@ let specialCharactersJsonSchema = {
   enum: ['remove', 'trim', 'keep'],
   type: 'string',
 }
+let newlinesBetweenJsonSchema = {
+  description: 'Specifies how new lines should be handled between groups.',
+  enum: ['ignore', 'always', 'never'],
+  type: 'string',
+}
 let groupsJsonSchema = {
   items: {
     oneOf: [
@@ -57,6 +62,12 @@ let groupsJsonSchema = {
         },
         type: 'array',
       },
+      {
+        properties: {
+          newlinesBetween: newlinesBetweenJsonSchema,
+        },
+        type: 'object',
+      },
     ],
   },
   description: 'Specifies the order of the groups.',
@@ -114,11 +125,6 @@ let partitionByNewLineJsonSchema = {
     'Allows to use newlines to separate the nodes into logical groups.',
   type: 'boolean',
 }
-let newlinesBetweenJsonSchema = {
-  description: 'Specifies how new lines should be handled between groups.',
-  enum: ['ignore', 'always', 'never'],
-  type: 'string',
-}
 let buildUseConfigurationIfJsonSchema = ({ additionalProperties } = {}) => ({
   properties: {
     allNamesMatchPattern: {

package/dist/utils/get-newlines-between-option.js

@@ -15,26 +15,33 @@ let getNewlinesBetweenOption = ({ nextSortingNode, sortingNode, options }) => {
     nextNodeGroupNumber,
     nodeGroupNumber,
   })
-  if (!options.customGroups || !Array.isArray(options.customGroups)) {
-    return globalNewlinesBetweenOption
-  }
   let nodeGroup = options.groups[nodeGroupNumber]
   let nextNodeGroup = options.groups[nextNodeGroupNumber]
-  if (Array.isArray(nodeGroup) || Array.isArray(nextNodeGroup)) {
-    return globalNewlinesBetweenOption
-  }
-  let nodeCustomGroup = options.customGroups.find(
-    customGroup => customGroup.groupName === nodeGroup,
-  )
-  let nextNodeCustomGroup = options.customGroups.find(
-    customGroup => customGroup.groupName === nextNodeGroup,
-  )
   if (
-    nodeCustomGroup &&
-    nextNodeCustomGroup &&
-    nodeCustomGroup.groupName === nextNodeCustomGroup.groupName
+    Array.isArray(options.customGroups) &&
+    typeof nodeGroup === 'string' &&
+    typeof nextNodeGroup === 'string' &&
+    nodeGroup === nextNodeGroup
   ) {
-    return nodeCustomGroup.newlinesInside ?? globalNewlinesBetweenOption
+    let nodeCustomGroup = options.customGroups.find(
+      customGroup => customGroup.groupName === nodeGroup,
+    )
+    let nextNodeCustomGroup = options.customGroups.find(
+      customGroup => customGroup.groupName === nextNodeGroup,
+    )
+    if (
+      nodeCustomGroup &&
+      nextNodeCustomGroup &&
+      nodeCustomGroup.groupName === nextNodeCustomGroup.groupName
+    ) {
+      return nodeCustomGroup.newlinesInside ?? globalNewlinesBetweenOption
+    }
+  }
+  if (nextNodeGroupNumber === nodeGroupNumber + 2) {
+    let groupBetween = options.groups[nodeGroupNumber + 1]
+    if (typeof groupBetween === 'object' && 'newlinesBetween' in groupBetween) {
+      return groupBetween.newlinesBetween
+    }
   }
   return globalNewlinesBetweenOption
 }

package/dist/utils/get-options-with-clean-groups.js

@@ -3,9 +3,9 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' })
 let getOptionsWithCleanGroups = options => ({
   ...options,
   groups: options.groups
-    .filter(group => group.length > 0)
+    .filter(group => !Array.isArray(group) || group.length > 0)
     .map(group =>
-      typeof group === 'string' ? group : getCleanedNestedGroups(group),
+      Array.isArray(group) ? getCleanedNestedGroups(group) : group,
     ),
 })
 let getCleanedNestedGroups = nestedGroup =>

package/dist/utils/validate-generated-groups-configuration.js

@@ -14,6 +14,7 @@ let validateGeneratedGroupsConfiguration = ({
   )
   let invalidGroups = groups
     .flat()
+    .filter(group => typeof group === 'string')
     .filter(
       group =>
         !isPredefinedGroup(selectors, modifiers, group) &&

package/dist/utils/validate-groups-configuration.js

@@ -9,9 +9,26 @@ let validateGroupsConfiguration = (
     ...allowedPredefinedGroups,
     ...allowedCustomGroups,
   ])
-  let invalidGroups = groups
-    .flat()
-    .filter(group => !allowedGroupsSet.has(group))
+  let invalidGroups = []
+  let isPreviousElementNewlinesBetween = false
+  for (let groupElement of groups) {
+    if (typeof groupElement === 'object' && 'newlinesBetween' in groupElement) {
+      if (isPreviousElementNewlinesBetween) {
+        throw new Error("Consecutive 'newlinesBetween' objects are not allowed")
+      }
+      isPreviousElementNewlinesBetween = true
+    } else {
+      isPreviousElementNewlinesBetween = false
+      let groupElements = Array.isArray(groupElement)
+        ? groupElement
+        : [groupElement]
+      for (let group of groupElements) {
+        if (!allowedGroupsSet.has(group)) {
+          invalidGroups.push(group)
+        }
+      }
+    }
+  }
   if (invalidGroups.length) {
     throw new Error(`Invalid group(s): ${invalidGroups.join(', ')}`)
   }
@@ -22,6 +39,9 @@ let validateNoDuplicatedGroups = groups => {
   let seenGroups = /* @__PURE__ */ new Set()
   let duplicatedGroups = /* @__PURE__ */ new Set()
   for (let group of flattenGroups) {
+    if (typeof group === 'object' && 'newlinesBetween' in group) {
+      continue
+    }
     if (seenGroups.has(group)) {
       duplicatedGroups.add(group)
     } else {

package/dist/utils/validate-newlines-and-partition-configuration.js

@@ -3,12 +3,24 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' })
 let validateNewlinesAndPartitionConfiguration = ({
   partitionByNewLine,
   newlinesBetween,
+  groups,
 }) => {
-  if (!!partitionByNewLine && newlinesBetween !== 'ignore') {
+  if (!partitionByNewLine) {
+    return
+  }
+  if (newlinesBetween !== 'ignore') {
     throw new Error(
       "The 'partitionByNewLine' and 'newlinesBetween' options cannot be used together",
     )
   }
+  let hasNewlinesBetweenGroup = groups.some(
+    group => typeof group === 'object' && 'newlinesBetween' in group,
+  )
+  if (hasNewlinesBetweenGroup) {
+    throw new Error(
+      "'newlinesBetween' objects can not be used in 'groups' alongside 'partitionByNewLine'",
+    )
+  }
 }
 exports.validateNewlinesAndPartitionConfiguration =
   validateNewlinesAndPartitionConfiguration

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-perfectionist",
-  "version": "4.5.0",
+  "version": "4.6.0",
   "description": "ESLint plugin for sorting various data such as objects, imports, types, enums, JSX props, etc.",
   "keywords": [
     "eslint",