feat: add ability to disable or enable side effect imports sorting

azat-io · Sep 7, 2024 · ae02009 · ae02009
1 parent 4e0e6d8
commit ae02009
Show file tree

Hide file tree

Showing 3 changed files with 421 additions and 5 deletions.
diff --git a/docs/content/rules/sort-imports.mdx b/docs/content/rules/sort-imports.mdx
@@ -153,6 +153,15 @@ Allows you to specify a pattern for identifying internal imports. This is useful
 
 You can use glob patterns to define these internal imports.
 
+### sortSideEffects
+
+<sub>default: `false`</sub>
+
+Specifies whether side effect imports should be sorted. By default, sorting side-effect imports is disabled for security reasons.
+
+- `true` — Sort side effect imports.
+- `false` — Do not sort side effect imports.
+
 ### newlinesBetween
 
 <sub>default: `'always'`</sub>

diff --git a/rules/sort-imports.ts b/rules/sort-imports.ts
@@ -59,6 +59,7 @@ type Options<T extends string[]> = [
  groups: (Group<T>[] | Group<T>)[]
  environment: 'node' | 'bun'
  internalPattern: string[]
+ sortSideEffects: boolean
  maxLineLength?: number
  order: 'desc' | 'asc'
  ignoreCase: boolean
@@ -101,6 +102,11 @@ export default createEslintRule<Options<string[]>, MESSAGE_ID>({
  },
  type: 'array',
  },
+ sortSideEffects: {
+ description:
+ 'Controls whether side-effect imports should be sorted.',
+ type: 'boolean',
+ },
  newlinesBetween: {
  description:
  'Specifies how new lines should be handled between import groups.',
@@ -197,6 +203,7 @@ export default createEslintRule<Options<string[]>, MESSAGE_ID>({
  order: 'asc',
  ignoreCase: true,
  internalPattern: ['~/**'],
+ sortSideEffects: false,
  newlinesBetween: 'always',
  maxLineLength: undefined,
  groups: [
@@ -230,6 +237,7 @@ export default createEslintRule<Options<string[]>, MESSAGE_ID>({
  customGroups: { type: {}, value: {} },
  internalPattern: ['~/**'],
  newlinesBetween: 'always',
+ sortSideEffects: false,
  type: 'alphabetical',
  environment: 'node',
  ignoreCase: true,
@@ -524,10 +532,14 @@ export default createEslintRule<Options<string[]>, MESSAGE_ID>({
  if (!(groupNum in grouped)) {
  grouped[groupNum] = [node]
  } else {
- grouped[groupNum] = sortNodes(
- [...grouped[groupNum], node],
- options,
- )
+ if (!options.sortSideEffects && isSideEffectImport(node.node)) {
+ grouped[groupNum] = [...grouped[groupNum], node]
+ } else {
+ grouped[groupNum] = sortNodes(
+ [...grouped[groupNum], node],
+ options,
+ )
+ }
  }
  }
 
@@ -643,7 +655,9 @@ export default createEslintRule<Options<string[]>, MESSAGE_ID>({
 
  if (
  !(
- isSideEffectImport(left.node) && isSideEffectImport(right.node)
+ !options.sortSideEffects &&
+ isSideEffectImport(left.node) &&
+ isSideEffectImport(right.node)
  ) &&
  !hasContentBetweenNodes(left, right) &&
  (leftNum > rightNum ||