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

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,10 @@ npx prettier --write "src/**/*.{js,ts,jsx,tsx}"
 ### Basic Sorting
 
 ```typescript
-
+import React, { useEffect, useState } from "react"
+import { Button } from "antd"
+import { sum } from "./utils"
+import "./styles.css"
 ```
 
 ### Custom Grouping and Sorting
@@ -78,6 +81,13 @@ export default {
 Result:
 
 ```typescript
+import React, { useState } from "react"
+
+import { Button } from "antd"
+import { format } from "date-fns"
+
+import { Header } from "./components/Header"
+import { sum } from "./utils"
 import "./styles.css"
 ```
 
@@ -438,7 +448,13 @@ 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 +473,11 @@ createPlugin({
 ```
 
 ```typescript
-
+import {
+    API_KEY,
+    type User,
+    getUser,
+} from "api"
 ```
 
 ### Import Statement Sorting
@@ -465,7 +485,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 +495,14 @@ Import statements are sorted alphabetically by module path:
 Comments follow the import statements they are attached to:
 
 ```typescript
+// React related imports
+import React from "react"
+
+// UI components
+import { Button } from "antd"
 
+// 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,10 @@ npx prettier --write "src/**/*.{js,ts,jsx,tsx}"
 ### 基本排序
 
 ```typescript
-
+import React, { useEffect, useState } from "react"
+import { Button } from "antd"
+import { sum } from "./utils"
+import "./styles.css"
 ```
 
 ### 自定义分组和排序
@@ -77,6 +80,13 @@ export default {
 结果：
 
 ```typescript
+import React, { useState } from "react"
+
+import { Button } from "antd"
+import { format } from "date-fns"
+
+import { Header } from "./components/Header"
+import { sum } from "./utils"
 import "./styles.css"
 ```
 
@@ -430,7 +440,13 @@ separator: (group, index) => {
 3. 命名导入按照 `type` 类型优先，然后按最终导入名称字母顺序排序
 
 ```typescript
-
+import Default, * as Namespace from "module"
+import {
+    type TypeA,
+    type TypeB,
+    VariableA,
+    VariableB,
+} from "module"
 ```
 
 **自定义行为**：
@@ -449,7 +465,11 @@ createPlugin({
 ```
 
 ```typescript
-
+import {
+    API_KEY,
+    type User,
+    getUser,
+} from "api"
 ```
 
 ### 导入语句排序
@@ -457,7 +477,9 @@ createPlugin({
 导入语句按模块路径的字母顺序排序：
 
 ```typescript
-
+import { a } from "a-module"
+import { b } from "b-module"
+import { c } from "c-module"
 ```
 
 ### 注释处理
@@ -465,7 +487,14 @@ createPlugin({
 注释会跟随它们所附加的导入语句一起移动：
 
 ```typescript
+// React 相关导入
+import React from "react"
+
+// UI 组件
+import { Button } from "antd"
 
+// 工具函数
+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,7 +1,7 @@
 {
     "name": "@1adybug/prettier-plugin-sort-imports",
     "type": "module",
-    "version": "0.0.16",
+    "version": "0.0.17",
     "description": "一个 Prettier 插件，用于对 JavaScript/TypeScript 文件的导入语句进行分组和排序",
     "keywords": [
         "prettier",
@@ -47,7 +47,8 @@
         "format": "prettier --write .",
         "test": "bun test",
         "test:watch": "bun test --watch",
-        "fg": "npm run format && git add . && git commit -m \"✨feature: format\""
+        "fg": "npm run format && git add . && git commit -m \"✨feature: format\"",
+        "ucr": "npx zixulu acr"
     },
     "devDependencies": {
         "@rslib/core": "^0.15.0",