@1adybug/prettier-plugin-sort-imports 0.0.16 → 0.0.18

package/README.md

@@ -1,4 +1,4 @@
-# Prettier Plugin Import Sorts
+# Prettier Plugin Sort Imports
 
 [中文文档](https://github.com/1adybug/prettier-plugin-sort-imports/blob/main/README.zh-CN.md)
 
@@ -44,7 +44,12 @@ npx prettier --write "src/**/*.{js,ts,jsx,tsx}"
 ### Basic Sorting
 
 ```typescript
+import { Button } from "antd"
+import React, { useEffect, useState } from "react"
+
+import { sum } from "./utils"
 
+import "./styles.css"
 ```
 
 ### Custom Grouping and Sorting
@@ -78,6 +83,14 @@ export default {
 Result:
 
 ```typescript
+import { Button } from "antd"
+import { format } from "date-fns"
+import React, { useState } from "react"
+
+import { Header } from "./components/Header"
+
+import { sum } from "./utils"
+
 import "./styles.css"
 ```
 
@@ -191,12 +204,8 @@ export default {
 
                 return order.indexOf(a.name) - order.indexOf(b.name)
             },
-            sortImportStatement: (a, b) => {
-                return a.path.localeCompare(b.path)
-            },
-            sortImportContent: (a, b) => {
-                return a.name.localeCompare(b.name)
-            },
+            sortImportStatement: (a, b) => a.path.localeCompare(b.path),
+            sortImportContent: (a, b) => a.name.localeCompare(b.name),
 
             // Configuration
             separator: "\n",
@@ -438,7 +447,8 @@ separator: (group, index) => {
 3. Named imports are sorted by `type` priority, then alphabetically by final import name
 
 ```typescript
-
+import Default, * as Namespace from "module"
+import { type TypeA, type TypeB, VariableA, VariableB } from "module"
 ```
 
 **Custom behavior**:
@@ -457,7 +467,7 @@ createPlugin({
 ```
 
 ```typescript
-
+import { type User, API_KEY, getUser } from "api"
 ```
 
 ### Import Statement Sorting
@@ -465,7 +475,9 @@ createPlugin({
 Import statements are sorted alphabetically by module path:
 
 ```typescript
-
+import { a } from "a-module"
+import { b } from "b-module"
+import { c } from "c-module"
 ```
 
 ### Comment Handling
@@ -473,7 +485,13 @@ Import statements are sorted alphabetically by module path:
 Comments follow the import statements they are attached to:
 
 ```typescript
+// UI components
+import { Button } from "antd"
+// React related imports
+import React from "react"
 
+// Utilities
+import { sum } from "./utils"
 ```
 
 ## Implementation Details

package/README.zh-CN.md

@@ -1,4 +1,4 @@
-# Prettier Plugin Import Sorts
+# Prettier Plugin Sort Imports
 
 [English](https://github.com/1adybug/prettier-plugin-sort-imports/blob/main/README.md)
 
@@ -43,7 +43,12 @@ npx prettier --write "src/**/*.{js,ts,jsx,tsx}"
 ### 基本排序
 
 ```typescript
+import { Button } from "antd"
+import React, { useEffect, useState } from "react"
+
+import { sum } from "./utils"
 
+import "./styles.css"
 ```
 
 ### 自定义分组和排序
@@ -77,6 +82,14 @@ export default {
 结果：
 
 ```typescript
+import { Button } from "antd"
+import { format } from "date-fns"
+import React, { useState } from "react"
+
+import { Header } from "./components/Header"
+
+import { sum } from "./utils"
+
 import "./styles.css"
 ```
 
@@ -430,7 +443,8 @@ separator: (group, index) => {
 3. 命名导入按照 `type` 类型优先，然后按最终导入名称字母顺序排序
 
 ```typescript
-
+import Default, * as Namespace from "module"
+import { type TypeA, type TypeB, VariableA, VariableB } from "module"
 ```
 
 **自定义行为**：
@@ -449,7 +463,7 @@ createPlugin({
 ```
 
 ```typescript
-
+import { type User, API_KEY, getUser } from "api"
 ```
 
 ### 导入语句排序
@@ -457,7 +471,9 @@ createPlugin({
 导入语句按模块路径的字母顺序排序：
 
 ```typescript
-
+import { a } from "a-module"
+import { b } from "b-module"
+import { c } from "c-module"
 ```
 
 ### 注释处理
@@ -465,7 +481,13 @@ createPlugin({
 注释会跟随它们所附加的导入语句一起移动：
 
 ```typescript
+// UI 组件
+import { Button } from "antd"
+// React 相关导入
+import React from "react"
 
+// 工具函数
+import { sum } from "./utils"
 ```
 
 ## 实现细节

package/dist/index.js

@@ -459,13 +459,16 @@ function groupImports(imports, userConfig) {
     const groupMap = new Map();
     for (const statement of imports){
         const groupName = config.getGroup(statement);
-        const statements = groupMap.get(groupName) ?? [];
+        const key = `${groupName}|||${statement.isSideEffect}`;
+        const statements = groupMap.get(key) ?? [];
         statements.push(statement);
-        groupMap.set(groupName, statements);
+        groupMap.set(key, statements);
     }
     const groups = [];
-    for (const [name, statements] of Array.from(groupMap.entries())){
-        const isSideEffect = statements.every((s)=>s.isSideEffect);
+    for (const [key, statements] of Array.from(groupMap.entries())){
+        const separatorIndex = key.lastIndexOf("|||");
+        const name = key.slice(0, separatorIndex);
+        const isSideEffect = "true" === key.slice(separatorIndex + 3);
         groups.push({
             name,
             isSideEffect,

package/dist/sorter.d.ts

@@ -6,7 +6,7 @@ export interface MergedConfig extends Omit<Required<PluginConfig>, "separator" |
 }
 /** 对导入语句进行排序 */
 export declare function sortImports(imports: ImportStatement[], userConfig: PluginConfig): ImportStatement[];
-/** 对导入语句进行分组 */
+/** 对导入语句进行分组，同时根据 name 和 isSideEffect 区分 */
 export declare function groupImports(imports: ImportStatement[], userConfig: PluginConfig): Group[];
 /** 对分组进行排序 */
 export declare function sortGroups(groups: Group[], userConfig: PluginConfig): Group[];

package/package.json

@@ -1,73 +1,67 @@
 {
-    "name": "@1adybug/prettier-plugin-sort-imports",
-    "type": "module",
-    "version": "0.0.16",
-    "description": "一个 Prettier 插件，用于对 JavaScript/TypeScript 文件的导入语句进行分组和排序",
-    "keywords": [
-        "prettier",
-        "plugin",
-        "import",
-        "sort",
-        "organize",
-        "typescript",
-        "javascript"
-    ],
-    "author": "1adybug <lurongv@qq.com>",
-    "license": "MIT",
-    "repository": {
-        "type": "git",
-        "url": "git+https://github.com/1adybug/prettier-plugin-sort-imports.git"
-    },
-    "homepage": "https://github.com/1adybug/prettier-plugin-sort-imports#readme",
-    "bugs": {
-        "url": "https://github.com/1adybug/prettier-plugin-sort-imports/issues"
-    },
-    "sideEffects": false,
-    "publishConfig": {
-        "access": "public",
-        "registry": "https://registry.npmjs.com/"
-    },
-    "exports": {
-        ".": {
-            "types": "./dist/index.d.ts",
-            "import": "./dist/index.js",
-            "require": "./dist/index.js"
-        }
-    },
-    "main": "./dist/index.js",
-    "module": "./dist/index.js",
-    "types": "./dist/index.d.ts",
-    "files": [
-        "dist"
-    ],
-    "scripts": {
-        "build": "rslib build",
-        "dev": "rslib build --watch",
-        "prepublishOnly": "npm run build",
-        "format": "prettier --write .",
-        "test": "bun test",
-        "test:watch": "bun test --watch",
-        "fg": "npm run format && git add . && git commit -m \"✨feature: format\""
-    },
-    "devDependencies": {
-        "@rslib/core": "^0.15.0",
-        "@types/babel__core": "^7.20.5",
-        "@types/bun": "latest",
-        "@types/node": "^22.18.6",
-        "json5": "^2.2.3",
-        "prettier": "^3.6.2",
-        "prettier-plugin-block-padding": "^0.0.6",
-        "prettier-plugin-tailwindcss": "^0.7.0",
-        "supports-color": "^10.2.2",
-        "typescript": "^5.9.2"
-    },
-    "peerDependencies": {
-        "prettier": "^3.0.0"
-    },
-    "dependencies": {
-        "@babel/core": "^7.28.4",
-        "@babel/parser": "^7.28.4",
-        "@babel/traverse": "^7.28.4",
-        "@babel/types": "^7.28.4"
+  "name": "@1adybug/prettier-plugin-sort-imports",
+  "version": "0.0.18",
+  "description": "一个 Prettier 插件，用于对 JavaScript/TypeScript 文件的导入语句进行分组和排序",
+  "keywords": [
+    "prettier",
+    "plugin",
+    "import",
+    "sort",
+    "organize",
+    "typescript",
+    "javascript"
+  ],
+  "author": "1adybug <lurongv@qq.com>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/1adybug/prettier.git"
+  },
+  "homepage": "https://github.com/1adybug/prettier/tree/main/packages/prettier-plugin-sort-imports",
+  "bugs": {
+    "url": "https://github.com/1adybug/prettier/issues"
+  },
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.js"
     }
-}
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "sideEffects": false,
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.com/"
+  },
+  "dependencies": {
+    "@babel/core": "^7.28.4",
+    "@babel/parser": "^7.28.4",
+    "@babel/traverse": "^7.28.4",
+    "@babel/types": "^7.28.4"
+  },
+  "devDependencies": {
+    "@rslib/core": "^0.15.0",
+    "@types/babel__core": "^7.20.5",
+    "@types/bun": "latest",
+    "@types/node": "^22.18.6",
+    "json5": "^2.2.3",
+    "supports-color": "^10.2.2",
+    "typescript": "^5.9.2"
+  },
+  "peerDependencies": {
+    "prettier": "^3.0.0"
+  },
+  "scripts": {
+    "build": "rslib build",
+    "dev": "rslib build --watch",
+    "test": "bun test",
+    "test:watch": "bun test --watch"
+  }
+}