@1adybug/prettier-plugin-sort-imports 0.0.22 → 0.0.23

package/README.md

@@ -44,12 +44,6 @@ 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"
 ```
 
@@ -75,7 +69,7 @@ export default {
                 return order.indexOf(a.name) - order.indexOf(b.name)
             },
             // Add blank lines between groups
-            separator: "",
+            groupSeparator: "",
         }),
     ],
 }
@@ -84,15 +78,6 @@ 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"
 ```
 
@@ -162,7 +147,7 @@ interface PluginConfig {
     /** Custom import content sorting function */
     sortImportContent?: (a: ImportContent, b: ImportContent) => number
     /** Separator between groups */
-    separator?: string | ((group: Group, index: number) => string | undefined)
+    groupSeparator?: string | ((group: Group, index: number) => string | undefined)
     /** Whether to sort side effect imports, defaults to false */
     sortSideEffect?: boolean
     /** Whether to remove unused imports, defaults to false */
@@ -179,9 +164,9 @@ Use the default plugin with basic options:
 ```javascript
 export default {
     plugins: ["@1adybug/prettier-plugin-sort-imports"],
-    importSortSideEffect: false, // Whether to sort side effect imports
-    importSortSeparator: "", // Group separator
-    importSortRemoveUnused: false, // Whether to remove unused imports
+    sortSideEffect: false, // Whether to sort side effect imports
+    groupSeparator: "", // Group separator
+    removeUnusedImports: false, // Whether to remove unused imports
 }
 ```
 
@@ -210,7 +195,7 @@ export default {
             sortImportContent: (a, b) => a.name.localeCompare(b.name),
 
             // Configuration
-            separator: "\n",
+            groupSeparator: "\n",
             sortSideEffect: true,
             removeUnusedImports: false,
         }),
@@ -271,7 +256,7 @@ export default createPlugin({
     },
 
     // Add blank lines between groups
-    separator: "\n",
+    groupSeparator: "\n",
 
     // Sort side effects
     sortSideEffect: true,
@@ -314,7 +299,7 @@ export default {
                 if (!statement.path.startsWith(".")) return "external"
                 return "local"
             },
-            separator: "\n",
+            groupSeparator: "\n",
 
             // Other Prettier plugins to combine with (Plugin objects only)
             otherPlugins: [
@@ -352,7 +337,7 @@ export default {
 - Options in `prettierOptions` are passed to all other plugins
 - This allows other plugins to receive their configuration even when merged
 
-### importSortRemoveUnused
+### removeUnusedImports
 
 Whether to remove unused imports, defaults to `false`.
 
@@ -360,11 +345,11 @@ Whether to remove unused imports, defaults to `false`.
 
 **When enabled (true)**: Automatically analyzes code and removes unused imports.
 
-```typescript
+```tsx
 // Before sorting
-import React, { useState, useEffect } from "react"
-import { Button, Input } from "antd"
-import { helper } from "./utils"
+import { useState } from "react"
+
+import { Button } from "antd"
 
 function MyComponent() {
     const [count, setCount] = useState(0)
@@ -388,7 +373,7 @@ function MyComponent() {
 - Analysis is AST-based and identifies actually used identifiers in code
 - Supports identifying JSX components, TypeScript type references, etc.
 
-### importSortSideEffect
+### sortSideEffect
 
 Whether to sort side effect imports, defaults to `false`.
 
@@ -406,7 +391,7 @@ import "f-side-effect"
 import "f-side-effect"
 ```
 
-### separator
+### groupSeparator
 
 Separator between groups, defaults to `undefined` (no separator).
 
@@ -414,10 +399,10 @@ Can be a string or function:
 
 ```javascript
 // String: add blank lines between all groups
-separator: ""
+groupSeparator: ""
 
 // Function: flexible control
-separator: (group, index) => {
+groupSeparator: (group, index) => {
     // No separator for the first group
     if (index === 0) return undefined
 
@@ -437,8 +422,7 @@ 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 +441,7 @@ createPlugin({
 ```
 
 ```typescript
-import { type User, API_KEY, getUser } from "api"
+
 ```
 
 ### Import Statement Sorting
@@ -465,9 +449,7 @@ import { type User, API_KEY, getUser } from "api"
 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
@@ -475,14 +457,7 @@ import { c } from "c-module"
 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
@@ -520,7 +495,7 @@ Converts sorted import statements back to code strings:
 - Generate corresponding import/export code from `ImportStatement`
 - Handle formatting of default imports, named imports, namespace imports
 - Handle `type` import formatting
-- Insert separators between groups according to `separator` configuration
+- Insert separators between groups according to `groupSeparator` configuration
 - Maintain comment associations
 
 #### 5. Plugin Entry (`src/index.ts`)

package/README.zh-CN.md

@@ -43,12 +43,6 @@ 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"
 ```
 
@@ -74,7 +68,7 @@ export default {
                 return order.indexOf(a.name) - order.indexOf(b.name)
             },
             // 在分组之间添加空行
-            separator: "",
+            groupSeparator: "",
         }),
     ],
 }
@@ -83,15 +77,6 @@ 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"
 ```
 
@@ -161,7 +146,7 @@ interface PluginConfig {
     /** 自定义导入内容排序函数 */
     sortImportContent?: (a: ImportContent, b: ImportContent) => number
     /** 分组之间的分隔符 */
-    separator?: string | ((group: Group, index: number) => string | undefined)
+    groupSeparator?: string | ((group: Group, index: number) => string | undefined)
     /** 是否对副作用导入进行排序，默认为 false */
     sortSideEffect?: boolean
     /** 是否删除未使用的导入，默认为 false */
@@ -178,9 +163,9 @@ interface PluginConfig {
 ```javascript
 export default {
     plugins: ["@1adybug/prettier-plugin-sort-imports"],
-    importSortSideEffect: false, // 是否对副作用导入排序
-    importSortSeparator: "", // 分组分隔符
-    importSortRemoveUnused: false, // 是否删除未使用的导入
+    sortSideEffect: false, // 是否对副作用导入排序
+    groupSeparator: "", // 分组分隔符
+    removeUnusedImports: false, // 是否删除未使用的导入
 }
 ```
 
@@ -206,7 +191,7 @@ export default {
             sortImportContent: (a, b) => {
                 /* 自定义排序 */
             },
-            separator: "",
+            groupSeparator: "",
             sortSideEffect: true,
             removeUnusedImports: false,
         }),
@@ -267,7 +252,7 @@ export default createPlugin({
     },
 
     // 在分组间添加空行
-    separator: "\n",
+    groupSeparator: "\n",
 
     // 排序副作用导入
     sortSideEffect: true,
@@ -310,7 +295,7 @@ export default {
                 if (!statement.path.startsWith(".")) return "external"
                 return "local"
             },
-            separator: "\n",
+            groupSeparator: "\n",
 
             // 要合并的其他 Prettier 插件（仅支持 Plugin 对象）
             otherPlugins: [
@@ -348,7 +333,7 @@ export default {
 - `prettierOptions` 中的选项会传递给所有其他插件
 - 这允许其他插件即使在合并时也能接收到它们的配置
 
-### importSortRemoveUnused
+### removeUnusedImports
 
 是否删除未使用的导入，默认为 `false`。
 
@@ -356,11 +341,11 @@ export default {
 
 **开启后（true）**：自动分析代码并删除未使用的导入。
 
-```typescript
+```tsx
 // 排序前
-import React, { useState, useEffect } from "react"
-import { Button, Input } from "antd"
-import { helper } from "./utils"
+import { useState } from "react"
+
+import { Button } from "antd"
 
 function MyComponent() {
     const [count, setCount] = useState(0)
@@ -384,7 +369,7 @@ function MyComponent() {
 - 分析基于 AST，会识别代码中实际使用的标识符
 - 支持识别 JSX 组件、TypeScript 类型引用等
 
-### importSortSideEffect
+### sortSideEffect
 
 是否对副作用导入进行排序，默认为 `false`。
 
@@ -402,7 +387,7 @@ import "f-side-effect"
 import "f-side-effect"
 ```
 
-### separator
+### groupSeparator
 
 分组之间的分隔符，默认为 `undefined`（无分隔符）。
 
@@ -410,10 +395,10 @@ import "f-side-effect"
 
 ```javascript
 // 字符串：在所有分组间添加空行
-separator: ""
+groupSeparator: ""
 
 // 函数：灵活控制
-separator: (group, index) => {
+groupSeparator: (group, index) => {
     // 第一个分组不添加分隔符
     if (index === 0) return undefined
 
@@ -433,8 +418,7 @@ separator: (group, index) => {
 3. 命名导入按照 `type` 类型优先，然后按最终导入名称字母顺序排序
 
 ```typescript
-import Default, * as Namespace from "module"
-import { type TypeA, type TypeB, VariableA, VariableB } from "module"
+
 ```
 
 **自定义行为**：
@@ -453,7 +437,7 @@ createPlugin({
 ```
 
 ```typescript
-import { type User, API_KEY, getUser } from "api"
+
 ```
 
 ### 导入语句排序
@@ -461,9 +445,7 @@ import { type User, API_KEY, getUser } from "api"
 导入语句按模块路径的字母顺序排序：
 
 ```typescript
-import { a } from "a-module"
-import { b } from "b-module"
-import { c } from "c-module"
+
 ```
 
 ### 注释处理
@@ -471,14 +453,7 @@ import { c } from "c-module"
 注释会跟随它们所附加的导入语句一起移动：
 
 ```typescript
-// React 相关导入
-import React from "react"
-
-// UI 组件
-import { Button } from "antd"
 
-// 工具函数
-import { sum } from "./utils"
 ```
 
 ## 实现细节
@@ -516,7 +491,7 @@ import { sum } from "./utils"
 - 根据 `ImportStatement` 生成对应的 import/export 代码
 - 处理默认导入、命名导入、命名空间导入的格式
 - 处理 `type` 导入的格式
-- 根据 `separator` 配置在分组之间插入分隔符
+- 根据 `groupSeparator` 配置在分组之间插入分隔符
 - 保持注释关联
 
 #### 5. 插件入口 (`src/index.ts`)

package/dist/index.js

@@ -153,7 +153,7 @@ function formatImportStatement(statement) {
 }
 function formatGroups(groups, config) {
     const lines = [];
-    const separator = config.separator;
+    const separator = config.groupSeparator;
     for(let i = 0; i < groups.length; i++){
         const group = groups[i];
         if (void 0 !== separator && i > 0) {
@@ -399,7 +399,7 @@ function mergeConfig(userConfig) {
         sortGroup: userConfig.sortGroup ?? DEFAULT_CONFIG.sortGroup,
         sortImportStatement: userConfig.sortImportStatement ?? DEFAULT_CONFIG.sortImportStatement,
         sortImportContent: userConfig.sortImportContent ?? DEFAULT_CONFIG.sortImportContent,
-        separator: userConfig.separator,
+        groupSeparator: userConfig.groupSeparator,
         sortSideEffect: userConfig.sortSideEffect ?? DEFAULT_CONFIG.sortSideEffect,
         removeUnusedImports: userConfig.removeUnusedImports ?? false
     };
@@ -583,9 +583,9 @@ function preprocessImports(text, options, config = {}) {
             sortGroup: config.sortGroup ?? optionsConfig.sortGroup,
             sortImportStatement: config.sortImportStatement ?? optionsConfig.sortImportStatement,
             sortImportContent: config.sortImportContent ?? optionsConfig.sortImportContent,
-            separator: config.separator ?? optionsConfig.importSortSeparator ?? optionsConfig.separator,
-            sortSideEffect: config.sortSideEffect ?? optionsConfig.importSortSideEffect ?? false,
-            removeUnusedImports: config.removeUnusedImports ?? optionsConfig.importSortRemoveUnused ?? false
+            groupSeparator: config.groupSeparator ?? optionsConfig.groupSeparator,
+            sortSideEffect: config.sortSideEffect ?? optionsConfig.sortSideEffect ?? false,
+            removeUnusedImports: config.removeUnusedImports ?? optionsConfig.removeUnusedImports ?? false
         };
         let processedImports = imports;
         if (finalConfig.removeUnusedImports) {
@@ -642,21 +642,21 @@ function createCombinedPreprocess(parserName, config) {
 }
 function createPluginInstance(config = {}) {
     const baseOptions = {
-        importSortSeparator: {
+        groupSeparator: {
             type: "string",
             category: "Import Sort",
-            description: "分组之间的分隔符"
+            description: "����֮��ķָ���"
         },
-        importSortSideEffect: {
+        sortSideEffect: {
             type: "boolean",
             category: "Import Sort",
-            description: "是否对副作用导入进行排序",
+            description: "�Ƿ�Ը����õ����������",
             default: false
         },
-        importSortRemoveUnused: {
+        removeUnusedImports: {
             type: "boolean",
             category: "Import Sort",
-            description: "是否删除未使用的导入",
+            description: "�Ƿ�ɾ��δʹ�õĵ���",
             default: false
         }
     };

package/dist/sorter.d.ts

@@ -1,7 +1,7 @@
 import { Group, ImportContent, ImportStatement, PluginConfig } from "./types";
 /** 合并后的配置 */
-export interface MergedConfig extends Omit<Required<PluginConfig>, "separator" | "removeUnusedImports" | "otherPlugins" | "prettierOptions"> {
-    separator: PluginConfig["separator"];
+export interface MergedConfig extends Omit<Required<PluginConfig>, "groupSeparator" | "removeUnusedImports" | "otherPlugins" | "prettierOptions"> {
+    groupSeparator: PluginConfig["groupSeparator"];
     removeUnusedImports: boolean;
 }
 /** 对导入语句进行排序 */

package/dist/types.d.ts

@@ -59,7 +59,7 @@ export type SortImportStatementFunction = (a: ImportStatement, b: ImportStatemen
 /** 导入内容排序函数 */
 export type SortImportContentFunction = (a: ImportContent, b: ImportContent) => number;
 /** 分隔符函数 */
-export type SeparatorFunction = (group: Group, index: number) => string | undefined;
+export type GroupSeparatorFunction = (group: Group, index: number) => string | undefined;
 /** 插件配置 */
 export interface PluginConfig {
     /** 可选的，获取分组名称 */
@@ -71,7 +71,7 @@ export interface PluginConfig {
     /** 可选的，默认按照导入内容的 name 的字母顺序排序，默认按照优先 type 类型在前，其次按照最终导入的内容名称的字母顺序排序 */
     sortImportContent?: SortImportContentFunction;
     /** 分隔符，分组之间的分隔符，默认为 undefined */
-    separator?: string | SeparatorFunction;
+    groupSeparator?: string | GroupSeparatorFunction;
     /** 是否对副作用导入进行排序，默认为 false */
     sortSideEffect?: boolean;
     /** 是否删除未使用的导入，默认为 false */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@1adybug/prettier-plugin-sort-imports",
-  "version": "0.0.22",
+  "version": "0.0.23",
   "description": "一个 Prettier 插件，用于对 JavaScript/TypeScript 文件的导入语句进行分组和排序",
   "keywords": [
     "prettier",