feat: add new lines between to settings

hugop95 · web-flow · commit ae36860e469d · 2025-12-21T10:29:45.000+03:00
diff --git a/docs/content/guide/getting-started.mdx b/docs/content/guide/getting-started.mdx
@@ -140,15 +140,16 @@ The highest priority is given to the settings of a particular rule. Next comes t
 
 In settings, you can set the following options:
 
-- `type` — The type of sorting. Possible values are `'alphabetical'`, `'natural'`, `'line-length'` and `custom`.
+- `type` — The type of sorting. Possible values are `'alphabetical'`, `'natural'`, `'line-length'`, `'custom'` or `'unsorted'`.
 - `order` — The order of sorting. Possible values are `'asc'` and `'desc'`.
 - `fallbackSort` — The fallback sorting type and order to use when two elements are equal.
-- `alphabet` — The custom alphabet to use when `type` is `custom`.
+- `alphabet` — The custom alphabet to use when `type` is `'custom'`.
 - `ignoreCase` — Ignore case when sorting.
 - `specialCharacters` — Control whether special characters should be kept, trimmed or removed before sorting. Values can be `'keep'`, `'trim'` or `'remove'`.
 - `locales` - The locales of sorting. Values can be a string with a BCP 47 language tag, or an array of such strings. See [String.prototype.localeCompare() - locales](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/localeCompare#locales).
 - `partitionByComment` — Partition the sorted elements by comments. Values can be `true`, `false` or regexp pattern.
 - `partitionByNewLine` — Partition the sorted elements by newlines. Values can be `true` or `false`.
+- `newlinesBetween` — Specifies how to handle newlines between groups. Values can be `'ignore'` or a number.
 
 Example:
 
diff --git a/docs/content/rules/sort-array-includes.mdx b/docs/content/rules/sort-array-includes.mdx
@@ -435,7 +435,7 @@ An array element will match a `CustomGroupAnyOfDefinition` group if it matches a
 - `groupName` — The group's name, which needs to be put in the [`groups`](#groups) option.
 - `selector` — Filter on the `selector` of the element.
 - `elementNamePattern` — If entered, will check that the name of the element matches the pattern entered.
-- `type` — Overrides the [`type`](#type) option for that custom group. `unsorted` will not sort the group.
+- `type` — Overrides the [`type`](#type) option for that custom group. `'unsorted'` will not sort the group.
 - `order` — Overrides the [`order`](#order) option for that custom group.
 - `fallbackSort` — Overrides the [`fallbackSort`](#fallbacksort) option for that custom group.
 - `newlinesInside` — Enforces a specific newline behavior between elements of the group.
diff --git a/docs/content/rules/sort-classes.mdx b/docs/content/rules/sort-classes.mdx
@@ -723,7 +723,7 @@ A class member will match a `CustomGroupAnyOfDefinition` group if it matches all
 - `elementNamePattern` — If entered, will check that the name of the element matches the pattern entered.
 - `elementValuePattern` — Only for non-function properties. If entered, will check that the value of the property matches the pattern entered.
 - `decoratorNamePattern` — If entered, will check that at least one `decorator` matches the pattern entered.
-- `type` — Overrides the [`type`](#type) option for that custom group. `unsorted` will not sort the group.
+- `type` — Overrides the [`type`](#type) option for that custom group. `'unsorted'` will not sort the group.
 - `order` — Overrides the [`order`](#order) option for that custom group.
 - `fallbackSort` — Overrides the [`fallbackSort`](#fallbacksort) option for that custom group.
 - `newlinesInside` — Enforces a specific newline behavior between elements of the group.
diff --git a/docs/content/rules/sort-decorators.mdx b/docs/content/rules/sort-decorators.mdx
@@ -412,7 +412,7 @@ A declaration will match a `CustomGroupAnyOfDefinition` group if it matches all
 
 - `groupName` — The group's name, which needs to be put in the [`groups`](#groups) option.
 - `elementNamePattern` — If entered, will check that the name of the element matches the pattern entered.
-- `type` — Overrides the [`type`](#type) option for that custom group. `unsorted` will not sort the group.
+- `type` — Overrides the [`type`](#type) option for that custom group. `'unsorted'` will not sort the group.
 - `order` — Overrides the [`order`](#order) option for that custom group.
 - `fallbackSort` — Overrides the [`fallbackSort`](#fallbacksort) option for that custom group.
 - `newlinesInside` — Enforces a specific newline behavior between elements of the group.
diff --git a/docs/content/rules/sort-enums.mdx b/docs/content/rules/sort-enums.mdx
@@ -341,7 +341,7 @@ An enum member will match a `CustomGroupAnyOfDefinition` group if it matches all
 - `groupName` — The group's name, which needs to be put in the [`groups`](#groups) option.
 - `elementNamePattern` — If entered, will check that the name of the element matches the pattern entered.
 - `elementValuePattern` — If entered, will check that the value of the element matches the pattern entered.
-- `type` — Overrides the [`type`](#type) option for that custom group. `unsorted` will not sort the group.
+- `type` — Overrides the [`type`](#type) option for that custom group. `'unsorted'` will not sort the group.
 - `order` — Overrides the [`order`](#order) option for that custom group.
 - `fallbackSort` — Overrides the [`fallbackSort`](#fallbacksort) option for that custom group.
 - `newlinesInside` — Enforces a specific newline behavior between elements of the group.
diff --git a/docs/content/rules/sort-exports.mdx b/docs/content/rules/sort-exports.mdx
@@ -357,7 +357,7 @@ An export will match a `CustomGroupAnyOfDefinition` group if it matches all the
 - `groupName` — The group's name, which needs to be put in the [`groups`](#groups) option.
 - `selector` — Filter on the `selector` of the element.
 - `elementNamePattern` — If entered, will check that the name of the element matches the pattern entered.
-- `type` — Overrides the [`type`](#type) option for that custom group. `unsorted` will not sort the group.
+- `type` — Overrides the [`type`](#type) option for that custom group. `'unsorted'` will not sort the group.
 - `order` — Overrides the [`order`](#order) option for that custom group.
 - `fallbackSort` — Overrides the [`fallbackSort`](#fallbacksort) option for that custom group.
 - `newlinesInside` — Enforces a specific newline behavior between elements of the group.
diff --git a/docs/content/rules/sort-heritage-clauses.mdx b/docs/content/rules/sort-heritage-clauses.mdx
@@ -325,7 +325,7 @@ A declaration will match a `CustomGroupAnyOfDefinition` group if it matches all
 
 - `groupName` — The group's name, which needs to be put in the [`groups`](#groups) option.
 - `elementNamePattern` — If entered, will check that the name of the element matches the pattern entered.
-- `type` — Overrides the [`type`](#type) option for that custom group. `unsorted` will not sort the group.
+- `type` — Overrides the [`type`](#type) option for that custom group. `'unsorted'` will not sort the group.
 - `order` — Overrides the [`order`](#order) option for that custom group.
 - `fallbackSort` — Overrides the [`fallbackSort`](#fallbacksort) option for that custom group.
 - `newlinesInside` — Enforces a specific newline behavior between elements of the group.
diff --git a/docs/content/rules/sort-imports.mdx b/docs/content/rules/sort-imports.mdx
@@ -616,7 +616,7 @@ An import will match a `CustomGroupAnyOfDefinition` group if it matches all the
 - `selector` — Filter on the `selector` of the element.
 - `modifiers` — Filter on the `modifiers` of the element. (All the modifiers of the element must be present in that list)
 - `elementNamePattern` — If entered, will check that the name of the element matches the pattern entered.
-- `type` — Overrides the [`type`](#type) option for that custom group. `unsorted` will not sort the group.
+- `type` — Overrides the [`type`](#type) option for that custom group. `'unsorted'` will not sort the group.
 - `order` — Overrides the [`order`](#order) option for that custom group.
 - `fallbackSort` — Overrides the [`fallbackSort`](#fallbacksort) option for that custom group.
 - `newlinesInside` — Enforces a specific newline behavior between elements of the group.
diff --git a/docs/content/rules/sort-interfaces.mdx b/docs/content/rules/sort-interfaces.mdx
@@ -677,7 +677,7 @@ An interface member will match a `CustomGroupAnyOfDefinition` group if it matche
 - `modifiers` — Filter on the `modifiers` of the element. (All the modifiers of the element must be present in that list)
 - `elementNamePattern` — If entered, will check that the name of the element matches the pattern entered.
 - `elementValuePattern` — Only for properties. If entered, will check that the value of the property matches the pattern entered.
-- `type` — Overrides the [`type`](#type) option for that custom group. `unsorted` will not sort the group.
+- `type` — Overrides the [`type`](#type) option for that custom group. `'unsorted'` will not sort the group.
 - `order` — Overrides the [`order`](#order) option for that custom group.
 - `fallbackSort` — Overrides the [`fallbackSort`](#fallbacksort) option for that custom group.
 - `sortBy` — Overrides the `sortBy` option for that custom group
diff --git a/docs/content/rules/sort-intersection-types.mdx b/docs/content/rules/sort-intersection-types.mdx
@@ -426,7 +426,7 @@ An type member will match a `CustomGroupAnyOfDefinition` group if it matches all
 - `groupName` — The group's name, which needs to be put in the [`groups`](#groups) option.
 - `selector` — Filter on the `selector` of the element.
 - `elementNamePattern` — If entered, will check that the name of the element matches the pattern entered.
-- `type` — Overrides the [`type`](#type) option for that custom group. `unsorted` will not sort the group.
+- `type` — Overrides the [`type`](#type) option for that custom group. `'unsorted'` will not sort the group.
 - `order` — Overrides the [`order`](#order) option for that custom group.
 - `fallbackSort` — Overrides the [`fallbackSort`](#fallbacksort) option for that custom group.
 - `newlinesInside` — Enforces a specific newline behavior between elements of the group.
diff --git a/docs/content/rules/sort-jsx-props.mdx b/docs/content/rules/sort-jsx-props.mdx
@@ -480,7 +480,7 @@ A JSX prop will match a `CustomGroupAnyOfDefinition` group if it matches all the
 - `modifiers` — Filter on the `modifiers` of the element. (All the modifiers of the element must be present in that list)
 - `elementNamePattern` — If entered, will check that the name of the element matches the pattern entered.
 - `elementValuePattern` — If entered, will check that the value of the element matches the pattern entered.
-- `type` — Overrides the [`type`](#type) option for that custom group. `unsorted` will not sort the group.
+- `type` — Overrides the [`type`](#type) option for that custom group. `'unsorted'` will not sort the group.
 - `order` — Overrides the [`order`](#order) option for that custom group.
 - `fallbackSort` — Overrides the [`fallbackSort`](#fallbacksort) option for that custom group.
 - `newlinesInside` — Enforces a specific newline behavior between elements of the group.
diff --git a/docs/content/rules/sort-maps.mdx b/docs/content/rules/sort-maps.mdx
@@ -384,7 +384,7 @@ A map element will match a `CustomGroupAnyOfDefinition` group if it matches all
 
 - `groupName` — The group's name, which needs to be put in the [`groups`](#groups) option.
 - `elementNamePattern` — If entered, will check that the name of the element matches the pattern entered.
-- `type` — Overrides the [`type`](#type) option for that custom group. `unsorted` will not sort the group.
+- `type` — Overrides the [`type`](#type) option for that custom group. `'unsorted'` will not sort the group.
 - `order` — Overrides the [`order`](#order) option for that custom group.
 - `fallbackSort` — Overrides the [`fallbackSort`](#fallbacksort) option for that custom group.
 - `newlinesInside` — Enforces a specific newline behavior between elements of the group.
diff --git a/docs/content/rules/sort-modules.mdx b/docs/content/rules/sort-modules.mdx
@@ -484,7 +484,7 @@ A module member will match a `CustomGroupAnyOfDefinition` group if it matches al
 - `modifiers` — Filter on the `modifiers` of the element. (All the modifiers of the element must be present in that list)
 - `elementNamePattern` — If entered, will check that the name of the element matches the pattern entered.
 - `decoratorNamePattern` — If entered, will check that at least one `decorator` matches the pattern entered.
-- `type` — Overrides the [`type`](#type) option for that custom group. `unsorted` will not sort the group.
+- `type` — Overrides the [`type`](#type) option for that custom group. `'unsorted'` will not sort the group.
 - `order` — Overrides the [`order`](#order) option for that custom group.
 - `fallbackSort` — Overrides the [`fallbackSort`](#fallbacksort) option for that custom group.
 - `newlinesInside` — Enforces a specific newline behavior between elements of the group.
diff --git a/docs/content/rules/sort-named-exports.mdx b/docs/content/rules/sort-named-exports.mdx
@@ -380,7 +380,7 @@ A named export will match a `CustomGroupAnyOfDefinition` group if it matches all
 - `groupName` — The group's name, which needs to be put in the [`groups`](#groups) option.
 - `selector` — Filter on the `selector` of the element.
 - `elementNamePattern` — If entered, will check that the name of the element matches the pattern entered.
-- `type` — Overrides the [`type`](#type) option for that custom group. `unsorted` will not sort the group.
+- `type` — Overrides the [`type`](#type) option for that custom group. `'unsorted'` will not sort the group.
 - `order` — Overrides the [`order`](#order) option for that custom group.
 - `fallbackSort` — Overrides the [`fallbackSort`](#fallbacksort) option for that custom group.
 - `newlinesInside` — Enforces a specific newline behavior between elements of the group.
diff --git a/docs/content/rules/sort-named-imports.mdx b/docs/content/rules/sort-named-imports.mdx
@@ -379,7 +379,7 @@ A named import will match a `CustomGroupAnyOfDefinition` group if it matches all
 - `groupName` — The group's name, which needs to be put in the [`groups`](#groups) option.
 - `selector` — Filter on the `selector` of the element.
 - `elementNamePattern` — If entered, will check that the name of the element matches the pattern entered.
-- `type` — Overrides the [`type`](#type) option for that custom group. `unsorted` will not sort the group.
+- `type` — Overrides the [`type`](#type) option for that custom group. `'unsorted'` will not sort the group.
 - `order` — Overrides the [`order`](#order) option for that custom group.
 - `fallbackSort` — Overrides the [`fallbackSort`](#fallbacksort) option for that custom group.
 - `newlinesInside` — Enforces a specific newline behavior between elements of the group.
diff --git a/docs/content/rules/sort-object-types.mdx b/docs/content/rules/sort-object-types.mdx
@@ -645,7 +645,7 @@ An object type will match a `CustomGroupAnyOfDefinition` group if it matches all
 - `modifiers` — Filter on the `modifiers` of the element. (All the modifiers of the element must be present in that list)
 - `elementNamePattern` — If entered, will check that the name of the element matches the pattern entered.
 - `elementValuePattern` — Only for properties. If entered, will check that the value of the property matches the pattern entered.
-- `type` — Overrides the [`type`](#type) option for that custom group. `unsorted` will not sort the group.
+- `type` — Overrides the [`type`](#type) option for that custom group. `'unsorted'` will not sort the group.
 - `order` — Overrides the [`order`](#order) option for that custom group.
 - `fallbackSort` — Overrides the [`fallbackSort`](#fallbacksort) option for that custom group.
 - `sortBy` — Overrides the `sortBy` option for that custom group
diff --git a/docs/content/rules/sort-objects.mdx b/docs/content/rules/sort-objects.mdx
@@ -698,7 +698,7 @@ An object will match a `CustomGroupAnyOfDefinition` group if it matches all the
 - `modifiers` — Filter on the `modifiers` of the element. (All the modifiers of the element must be present in that list)
 - `elementNamePattern` — If entered, will check that the name of the element matches the pattern entered.
 - `elementValuePattern` — Only for non-function properties. If entered, will check that the value of the property matches the pattern entered.
-- `type` — Overrides the [`type`](#type) option for that custom group. `unsorted` will not sort the group.
+- `type` — Overrides the [`type`](#type) option for that custom group. `'unsorted'` will not sort the group.
 - `order` — Overrides the [`order`](#order) option for that custom group.
 - `fallbackSort` — Overrides the [`fallbackSort`](#fallbacksort) option for that custom group.
 - `newlinesInside` — Enforces a specific newline behavior between elements of the group.
diff --git a/docs/content/rules/sort-sets.mdx b/docs/content/rules/sort-sets.mdx
@@ -439,7 +439,7 @@ A set element will match a `CustomGroupAnyOfDefinition` group if it matches all
 - `groupName` — The group's name, which needs to be put in the [`groups`](#groups) option.
 - `selector` — Filter on the `selector` of the element.
 - `elementNamePattern` — If entered, will check that the name of the element matches the pattern entered.
-- `type` — Overrides the [`type`](#type) option for that custom group. `unsorted` will not sort the group.
+- `type` — Overrides the [`type`](#type) option for that custom group. `'unsorted'` will not sort the group.
 - `order` — Overrides the [`order`](#order) option for that custom group.
 - `fallbackSort` — Overrides the [`fallbackSort`](#fallbacksort) option for that custom group.
 - `newlinesInside` — Enforces a specific newline behavior between elements of the group.
diff --git a/docs/content/rules/sort-union-types.mdx b/docs/content/rules/sort-union-types.mdx
@@ -448,7 +448,7 @@ An type member will match a `CustomGroupAnyOfDefinition` group if it matches all
 - `groupName` — The group's name, which needs to be put in the [`groups`](#groups) option.
 - `selector` — Filter on the `selector` of the element.
 - `elementNamePattern` — If entered, will check that the name of the element matches the pattern entered.
-- `type` — Overrides the [`type`](#type) option for that custom group. `unsorted` will not sort the group.
+- `type` — Overrides the [`type`](#type) option for that custom group. `'unsorted'` will not sort the group.
 - `order` — Overrides the [`order`](#order) option for that custom group.
 - `fallbackSort` — Overrides the [`fallbackSort`](#fallbacksort) option for that custom group.
 - `newlinesInside` — Enforces a specific newline behavior between elements of the group.
diff --git a/docs/content/rules/sort-variable-declarations.mdx b/docs/content/rules/sort-variable-declarations.mdx
@@ -333,7 +333,7 @@ A declaration will match a `CustomGroupAnyOfDefinition` group if it matches all
 - `groupName` — The group's name, which needs to be put in the [`groups`](#groups) option.
 - `selector` — Filter on the `selector` of the element.
 - `elementNamePattern` — If entered, will check that the name of the element matches the pattern entered.
-- `type` — Overrides the [`type`](#type) option for that custom group. `unsorted` will not sort the group.
+- `type` — Overrides the [`type`](#type) option for that custom group. `'unsorted'` will not sort the group.
 - `order` — Overrides the [`order`](#order) option for that custom group.
 - `fallbackSort` — Overrides the [`fallbackSort`](#fallbacksort) option for that custom group.
 - `newlinesInside` — Enforces a specific newline behavior between elements of the group.
diff --git a/test/utils/get-settings.test.ts b/test/utils/get-settings.test.ts
@@ -25,6 +25,7 @@ describe('get-settings', () => {
       specialCharacters: 'keep',
       partitionByNewLine: true,
       type: 'alphabetical',
+      newlinesBetween: 1,
       ignoreCase: true,
       locales: 'en-US',
       alphabet: '',
diff --git a/utils/get-settings.ts b/utils/get-settings.ts
@@ -1,6 +1,7 @@
 import type { TSESLint } from '@typescript-eslint/utils'
 
-import type { PartitionByCommentOption } from '../types/common-partition-options'
+import type { CommonPartitionOptions } from '../types/common-partition-options'
+import type { CommonGroupsOptions } from '../types/common-groups-options'
 import type { CommonOptions } from '../types/common-options'
 
 /**
@@ -10,18 +11,11 @@ import type { CommonOptions } from '../types/common-options'
  * 'perfectionist' key and apply to all Perfectionist rules unless overridden by
  * rule-specific options.
  */
-export type Settings = Partial<{
-  /**
-   * Configuration for partition comments that separate code sections. Can be
-   * boolean, string, array of strings, or object with block/line specific
-   * settings.
-   */
-  partitionByComment: PartitionByCommentOption
-
-  /** Whether to create partitions at newlines. */
-  partitionByNewLine: boolean
-}> &
-  Partial<CommonOptions>
+export type Settings = Partial<
+  Pick<CommonGroupsOptions<unknown, unknown, string>, 'newlinesBetween'> &
+    CommonPartitionOptions &
+    CommonOptions
+>
 
 /**
  * Extracts and validates Perfectionist settings from ESLint configuration.
@@ -71,6 +65,7 @@ export function getSettings(
       'partitionByComment',
       'partitionByNewLine',
       'specialCharacters',
+      'newlinesBetween',
       'fallbackSort',
       'ignoreCase',
       'alphabet',
