feat: adds possibility to trim / remove special characters before sor…

…ting

docs/content/rules/sort-array-includes.mdx

@@ -147,6 +147,16 @@ Controls whether sorting should be case-sensitive or not.
 - `true` — Ignore case when sorting alphabetically or naturally (e.g., “A” and “a” are the same).
 - `false` — Consider case when sorting (e.g., “A” comes before “a”).
 
+### specialCharacters
+
+<sub>default: `keep`</sub>
+
+Controls whether special characters should be trimmed, removed or kept before sorting.
+
+- `'keep'` — Keep special characters when sorting (e.g., “_a” comes before “a”).
+- `'trim'` — Trim special characters when sorting alphabetically or naturally (e.g., “_a” and “a” are the same).
+- `'remove'` — Remove special characters when sorting (e.g., “/a/b” and “ab” are the same).
+
 
 ### groupKind
 
@@ -229,6 +239,7 @@ Determines the matcher used for patterns in the `partitionByComment` option.
                   type: 'alphabetical',
                   order: 'asc',
                   ignoreCase: true,
+                  specialCharacters: 'keep',
                   groupKind: 'literals-first',
                   partitionByNewLine: false,
                   matcher: 'minimatch',
@@ -255,6 +266,7 @@ Determines the matcher used for patterns in the `partitionByComment` option.
                 type: 'alphabetical',
                 order: 'asc',
                 ignoreCase: true,
+                specialCharacters: 'keep',
                 groupKind: 'literals-first',
                 partitionByNewLine: false,
                 matcher: 'minimatch',

docs/content/rules/sort-astro-attributes.mdx

@@ -136,6 +136,16 @@ Controls whether sorting should be case-sensitive or not.
 - `true` — Ignore case when sorting alphabetically or naturally (e.g., “A” and “a” are the same).
 - `false` — Consider case when sorting (e.g., “A” comes before “a”).
 
+### specialCharacters
+
+<sub>default: `keep`</sub>
+
+Controls whether special characters should be trimmed, removed or kept before sorting.
+
+- `'keep'` — Keep special characters when sorting (e.g., “_a” comes before “a”).
+- `'trim'` — Trim special characters when sorting alphabetically or naturally (e.g., “_a” and “a” are the same).
+- `'remove'` — Remove special characters when sorting (e.g., “/a/b” and “ab” are the same).
+
 ### groups
 
 <sub>
@@ -310,6 +320,7 @@ In order to start using this rule, you need to install additional dependency:
                   type: 'alphabetical',
                   order: 'asc',
                   ignoreCase: true,
+                  specialCharacters: 'keep',
                   matcher: 'minimatch',
                   groups: [],
                   customGroups: {},
@@ -342,6 +353,7 @@ In order to start using this rule, you need to install additional dependency:
                 type: 'alphabetical',
                 order: 'asc',
                 ignoreCase: true,
+                specialCharacters: 'keep',
                 matcher: 'minimatch',
                 groups: [],
                 customGroups: {},

docs/content/rules/sort-classes.mdx

@@ -181,6 +181,16 @@ Controls whether sorting should be case-sensitive or not.
 - `true` — Ignore case when sorting alphabetically or naturally (e.g., “A” and “a” are the same).
 - `false` — Consider case when sorting (e.g., “A” comes before “a”).
 
+### specialCharacters
+
+<sub>default: `keep`</sub>
+
+Controls whether special characters should be trimmed, removed or kept before sorting.
+
+- `'keep'` — Keep special characters when sorting (e.g., “_a” comes before “a”).
+- `'trim'` — Trim special characters when sorting alphabetically or naturally (e.g., “_a” and “a” are the same).
+- `'remove'` — Remove special characters when sorting (e.g., “/a/b” and “ab” are the same).
+
 ### partitionByComment
 
 <sub>default: `false`</sub>
@@ -604,6 +614,7 @@ Determines the matcher used for patterns in the `partitionByComment` and `custom
                   type: 'alphabetical',
                   order: 'asc',
                   ignoreCase: true,
+                  specialCharacters: 'keep',
                   partitionByComment: false,
                   matcher: 'minimatch',
                   groups: [
@@ -645,6 +656,7 @@ Determines the matcher used for patterns in the `partitionByComment` and `custom
                 type: 'alphabetical',
                 order: 'asc',
                 ignoreCase: true,
+                specialCharacters: 'keep',
                 partitionByComment: false,
                 matcher: 'minimatch',
                 groups: [

docs/content/rules/sort-enums.mdx

@@ -112,6 +112,16 @@ Controls whether sorting should be case-sensitive or not.
 - `true` — Ignore case when sorting alphabetically or naturally (e.g., “A” and “a” are the same).
 - `false` — Consider case when sorting (e.g., “A” comes before “a”).
 
+### specialCharacters
+
+<sub>default: `keep`</sub>
+
+Controls whether special characters should be trimmed, removed or kept before sorting.
+
+- `'keep'` — Keep special characters when sorting (e.g., “_a” comes before “a”).
+- `'trim'` — Trim special characters when sorting alphabetically or naturally (e.g., “_a” and “a” are the same).
+- `'remove'` — Remove special characters when sorting (e.g., “/a/b” and “ab” are the same).
+
 ### sortByValue
 
 <sub>default: `false`</sub>
@@ -196,6 +206,7 @@ Determines the matcher used for patterns in the `partitionByComment` option.
                   type: 'alphabetical',
                   order: 'asc',
                   ignoreCase: true,
+                  specialCharacters: 'keep',
                   partitionByComment: false,
                   partitionByNewLine: false,
                   sortByValue: false,
@@ -223,6 +234,7 @@ Determines the matcher used for patterns in the `partitionByComment` option.
                 type: 'alphabetical',
                 order: 'asc',
                 ignoreCase: true,
+                specialCharacters: 'keep',
                 partitionByComment: false,
                 partitionByNewLine: false,
                 sortByValue: false,

docs/content/rules/sort-exports.mdx

@@ -106,6 +106,16 @@ Controls whether sorting should be case-sensitive or not.
 - `true` — Ignore case when sorting alphabetically or naturally (e.g., “A” and “a” are the same).
 - `false` — Consider case when sorting (e.g., “A” comes before “a”).
 
+### specialCharacters
+
+<sub>default: `keep`</sub>
+
+Controls whether special characters should be trimmed, removed or kept before sorting.
+
+- `'keep'` — Keep special characters when sorting (e.g., “_a” comes before “a”).
+- `'trim'` — Trim special characters when sorting alphabetically or naturally (e.g., “_a” and “a” are the same).
+- `'remove'` — Remove special characters when sorting (e.g., “/a/b” and “ab” are the same).
+
 ### partitionByComment
 
 <sub>default: `false`</sub>
@@ -176,6 +186,7 @@ Determines the matcher used for patterns in the `partitionByComment` option.
                   type: 'alphabetical',
                   order: 'asc',
                   ignoreCase: true,
+                  specialCharacters: 'keep',
                   partitionByComment: false,
                   partitionByNewLine: false,
                   groupKind: 'mixed',
@@ -203,6 +214,7 @@ Determines the matcher used for patterns in the `partitionByComment` option.
                 type: 'alphabetical',
                 order: 'asc',
                 ignoreCase: true,
+                specialCharacters: 'keep',
                 partitionByComment: false,
                 partitionByNewLine: false,
                 groupKind: 'mixed',

docs/content/rules/sort-imports.mdx

@@ -145,6 +145,16 @@ Controls whether sorting should be case-sensitive or not.
 - `true` — Ignore case when sorting alphabetically or naturally (e.g., “A” and “a” are the same).
 - `false` — Consider case when sorting (e.g., “A” comes before “a”).
 
+### specialCharacters
+
+<sub>default: `keep`</sub>
+
+Controls whether special characters should be trimmed, removed or kept before sorting.
+
+- `'keep'` — Keep special characters when sorting (e.g., “_a” comes before “a”).
+- `'trim'` — Trim special characters when sorting alphabetically or naturally (e.g., “_a” and “a” are the same).
+- `'remove'` — Remove special characters when sorting (e.g., “/a/b” and “ab” are the same).
+
 ### internalPattern
 
 <sub>default: `['~/**']` for `minimatch` matcher, `['^~/.*']` for `regex` matcher</sub>
@@ -349,6 +359,7 @@ Specifies which environment’s built-in modules should be recognized. If you ar
                   type: 'alphabetical',
                   order: 'asc',
                   ignoreCase: true,
+                  specialCharacters: 'keep',
                   matcher: 'minimatch',
                   internalPattern: ['~/**'],
                   newlinesBetween: 'always',
@@ -389,6 +400,7 @@ Specifies which environment’s built-in modules should be recognized. If you ar
                 type: 'alphabetical',
                 order: 'asc',
                 ignoreCase: true,
+                specialCharacters: 'keep',
                 matcher: 'minimatch',
                 internalPattern: ['~/**'],
                 newlinesBetween: 'always',

docs/content/rules/sort-interfaces.mdx

@@ -161,6 +161,16 @@ Controls whether sorting should be case-sensitive or not.
 - `true` — Ignore case when sorting alphabetically or naturally (e.g., “A” and “a” are the same).
 - `false` — Consider case when sorting (e.g., “A” comes before “a”).
 
+### specialCharacters
+
+<sub>default: `keep`</sub>
+
+Controls whether special characters should be trimmed, removed or kept before sorting.
+
+- `'keep'` — Keep special characters when sorting (e.g., “_a” comes before “a”).
+- `'trim'` — Trim special characters when sorting alphabetically or naturally (e.g., “_a” and “a” are the same).
+- `'remove'` — Remove special characters when sorting (e.g., “/a/b” and “ab” are the same).
+
 ### ignorePattern
 
 <sub>default: `[]`</sub>
@@ -348,6 +358,7 @@ Determines the matcher used for patterns in the `partitionByComment`, `ignorePat
                   type: 'alphabetical',
                   order: 'asc',
                   ignoreCase: true,
+                  specialCharacters: 'keep',
                   ignorePattern: [],
                   partitionByNewLine: false,
                   optionalityOrder: 'ignore',
@@ -377,6 +388,7 @@ Determines the matcher used for patterns in the `partitionByComment`, `ignorePat
                 type: 'alphabetical',
                 order: 'asc',
                 ignoreCase: true,
+                specialCharacters: 'keep',
                 ignorePattern: [],
                 partitionByNewLine: false,
                 optionalityOrder: 'ignore',

docs/content/rules/sort-intersection-types.mdx

@@ -102,6 +102,16 @@ Controls whether sorting should be case-sensitive or not.
 - `true` — Ignore case when sorting alphabetically or naturally (e.g., “A” and “a” are the same).
 - `false` — Consider case when sorting (e.g., “A” comes before “a”).
 
+### specialCharacters
+
+<sub>default: `keep`</sub>
+
+Controls whether special characters should be trimmed, removed or kept before sorting.
+
+- `'keep'` — Keep special characters when sorting (e.g., “_a” comes before “a”).
+- `'trim'` — Trim special characters when sorting alphabetically or naturally (e.g., “_a” and “a” are the same).
+- `'remove'` — Remove special characters when sorting (e.g., “/a/b” and “ab” are the same).
+
 ### partitionByComment
 
 <sub>default: `false`</sub>
@@ -283,6 +293,7 @@ Determines the matcher used for patterns in the `partitionByComment` option.
                   type: 'alphabetical',
                   order: 'asc',
                   ignoreCase: true,
+                  specialCharacters: 'keep',
                   partitionByNewLine: false,
                   partitionByNewLine: false,
                   matcher: 'minimatch',
@@ -310,6 +321,7 @@ Determines the matcher used for patterns in the `partitionByComment` option.
                 type: 'alphabetical',
                 order: 'asc',
                 ignoreCase: true,
+                specialCharacters: 'keep',
                 partitionByNewLine: false,
                 partitionByComment: false,
                 matcher: 'minimatch',

docs/content/rules/sort-jsx-props.mdx

@@ -162,6 +162,16 @@ Controls whether sorting should be case-sensitive or not.
 - `true` — Ignore case when sorting alphabetically or naturally (e.g., “A” and “a” are the same).
 - `false` — Consider case when sorting (e.g., “A” comes before “a”).
 
+### specialCharacters
+
+<sub>default: `keep`</sub>
+
+Controls whether special characters should be trimmed, removed or kept before sorting.
+
+- `'keep'` — Keep special characters when sorting (e.g., “_a” comes before “a”).
+- `'trim'` — Trim special characters when sorting alphabetically or naturally (e.g., “_a” and “a” are the same).
+- `'remove'` — Remove special characters when sorting (e.g., “/a/b” and “ab” are the same).
+
 ### ignorePattern
 
 <sub>default: `[]`</sub>
@@ -259,6 +269,7 @@ Determines the matcher used for patterns in the `ignorePattern` and `customGroup
                   type: 'alphabetical',
                   order: 'asc',
                   ignoreCase: true,
+                  specialCharacters: 'keep',
                   ignorePattern: [],
                   matcher: 'minimatch',
                   groups: [],
@@ -286,6 +297,7 @@ Determines the matcher used for patterns in the `ignorePattern` and `customGroup
                 type: 'alphabetical',
                 order: 'asc',
                 ignoreCase: true,
+                specialCharacters: 'keep',
                 ignorePattern: [],
                 matcher: 'minimatch',
                 groups: [],

docs/content/rules/sort-maps.mdx

@@ -107,6 +107,16 @@ Controls whether sorting should be case-sensitive or not.
 - `true` — Ignore case when sorting alphabetically or naturally (e.g., “A” and “a” are the same).
 - `false` — Consider case when sorting (e.g., “A” comes before “a”).
 
+### specialCharacters
+
+<sub>default: `keep`</sub>
+
+Controls whether special characters should be trimmed, removed or kept before sorting.
+
+- `'keep'` — Keep special characters when sorting (e.g., “_a” comes before “a”).
+- `'trim'` — Trim special characters when sorting alphabetically or naturally (e.g., “_a” and “a” are the same).
+- `'remove'` — Remove special characters when sorting (e.g., “/a/b” and “ab” are the same).
+
 ### partitionByComment
 
 <sub>default: `false`</sub>
@@ -177,6 +187,7 @@ Determines the matcher used for patterns in the `partitionByComment` option.
                   type: 'alphabetical',
                   order: 'asc',
                   ignoreCase: true,
+                  specialCharacters: 'keep',
                   partitionByNewLine: false,
                   partitionByComment: false,
                   matcher: 'minimatch',
@@ -203,6 +214,7 @@ Determines the matcher used for patterns in the `partitionByComment` option.
                 type: 'alphabetical',
                 order: 'asc',
                 ignoreCase: true,
+                specialCharacters: 'keep',
                 partitionByNewLine: false,
                 partitionByComment: false,
                 matcher: 'minimatch',

docs/content/rules/sort-named-exports.mdx

@@ -125,6 +125,16 @@ Controls whether sorting should be case-sensitive or not.
 - `true` — Ignore case when sorting alphabetically or naturally (e.g., “A” and “a” are the same).
 - `false` — Consider case when sorting (e.g., “A” comes before “a”).
 
+### specialCharacters
+
+<sub>default: `keep`</sub>
+
+Controls whether special characters should be trimmed, removed or kept before sorting.
+
+- `'keep'` — Keep special characters when sorting (e.g., “_a” comes before “a”).
+- `'trim'` — Trim special characters when sorting alphabetically or naturally (e.g., “_a” and “a” are the same).
+- `'remove'` — Remove special characters when sorting (e.g., “/a/b” and “ab” are the same).
+
 ### groupKind
 
 <sub>default: `'mixed'`</sub>
@@ -204,6 +214,7 @@ Determines the matcher used for patterns in the `partitionByComment` option.
                   type: 'alphabetical',
                   order: 'asc',
                   ignoreCase: true,
+                  specialCharacters: 'keep',
                   groupKind: 'mixed',
                   matcher: 'minimatch',
                 },
@@ -229,6 +240,7 @@ Determines the matcher used for patterns in the `partitionByComment` option.
                 type: 'alphabetical',
                 order: 'asc',
                 ignoreCase: true,
+                specialCharacters: 'keep',
                 groupKind: 'mixed',
                 matcher: 'minimatch',
               },

docs/content/rules/sort-named-imports.mdx

@@ -126,6 +126,16 @@ Controls whether sorting should be case-sensitive or not.
 - `true` — Ignore case when sorting alphabetically or naturally (e.g., “A” and “a” are the same).
 - `false` — Consider case when sorting (e.g., “A” comes before “a”).
 
+### specialCharacters
+
+<sub>default: `keep`</sub>
+
+Controls whether special characters should be trimmed, removed or kept before sorting.
+
+- `'keep'` — Keep special characters when sorting (e.g., “_a” comes before “a”).
+- `'trim'` — Trim special characters when sorting alphabetically or naturally (e.g., “_a” and “a” are the same).
+- `'remove'` — Remove special characters when sorting (e.g., “/a/b” and “ab” are the same).
+
 ### ignoreAlias
 
 <sub>default: `false`</sub>
@@ -205,6 +215,7 @@ import {
                   order: 'asc',
                   ignoreAlias: false,
                   ignoreCase: true,
+                  specialCharacters: 'keep',
                   groupKind: 'mixed',
                   partitionByNewLine: false,
                   partitionByComment: false,
@@ -233,6 +244,7 @@ import {
                 order: 'asc',
                 ignoreAlias: false,
                 ignoreCase: true,
+                specialCharacters: 'keep',
                 groupKind: 'mixed',
                 partitionByNewLine: false,
                 partitionByComment: false,