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

package/README.md

@@ -44,9 +44,10 @@ npx prettier --write "src/**/*.{js,ts,jsx,tsx}"
 ### Basic Sorting
 
 ```typescript
-import { Button } from "antd"
 import React, { useEffect, useState } from "react"
 
+import { Button } from "antd"
+
 import { sum } from "./utils"
 
 import "./styles.css"
@@ -83,9 +84,10 @@ export default {
 Result:
 
 ```typescript
+import React, { useState } from "react"
+
 import { Button } from "antd"
 import { format } from "date-fns"
-import React, { useState } from "react"
 
 import { Header } from "./components/Header"
 
@@ -232,29 +234,19 @@ export default createPlugin({
         const path = statement.path
 
         // React and related libraries
-        if (path.startsWith("react") || path.startsWith("@react")) {
-            return "react"
-        }
+        if (path.startsWith("react") || path.startsWith("@react")) return "react"
 
         // UI libraries
-        if (path.includes("antd") || path.includes("@mui") || path.includes("chakra")) {
-            return "ui"
-        }
+        if (path.includes("antd") || path.includes("@mui") || path.includes("chakra")) return "ui"
 
         // Utility libraries
-        if (path.includes("lodash") || path.includes("ramda") || path.includes("date-fns")) {
-            return "utils"
-        }
+        if (path.includes("lodash") || path.includes("ramda") || path.includes("date-fns")) return "utils"
 
         // External packages (node_modules)
-        if (!path.startsWith(".") && !path.startsWith("@/")) {
-            return "external"
-        }
+        if (!path.startsWith(".") && !path.startsWith("@/")) return "external"
 
         // Internal aliases (@/)
-        if (path.startsWith("@/")) {
-            return "internal"
-        }
+        if (path.startsWith("@/")) return "internal"
 
         // Relative imports
         return "relative"
@@ -270,9 +262,7 @@ export default createPlugin({
     // Custom import content sorting
     sortImportContent: (a, b) => {
         // Types first, then variables
-        if (a.type !== b.type) {
-            return a.type === "type" ? -1 : 1
-        }
+        if (a.type !== b.type) return a.type === "type" ? -1 : 1
 
         // Alphabetical order within same type
         const aName = a.alias ?? a.name
@@ -485,11 +475,12 @@ import { c } from "c-module"
 Comments follow the import statements they are attached to:
 
 ```typescript
-// UI components
-import { Button } from "antd"
 // React related imports
 import React from "react"
 
+// UI components
+import { Button } from "antd"
+
 // Utilities
 import { sum } from "./utils"
 ```

package/README.zh-CN.md

@@ -43,9 +43,10 @@ npx prettier --write "src/**/*.{js,ts,jsx,tsx}"
 ### 基本排序
 
 ```typescript
-import { Button } from "antd"
 import React, { useEffect, useState } from "react"
 
+import { Button } from "antd"
+
 import { sum } from "./utils"
 
 import "./styles.css"
@@ -82,9 +83,10 @@ export default {
 结果：
 
 ```typescript
+import React, { useState } from "react"
+
 import { Button } from "antd"
 import { format } from "date-fns"
-import React, { useState } from "react"
 
 import { Header } from "./components/Header"
 
@@ -228,29 +230,19 @@ export default createPlugin({
         const path = statement.path
 
         // React 及相关库
-        if (path.startsWith("react") || path.startsWith("@react")) {
-            return "react"
-        }
+        if (path.startsWith("react") || path.startsWith("@react")) return "react"
 
         // UI 库
-        if (path.includes("antd") || path.includes("@mui") || path.includes("chakra")) {
-            return "ui"
-        }
+        if (path.includes("antd") || path.includes("@mui") || path.includes("chakra")) return "ui"
 
         // 工具库
-        if (path.includes("lodash") || path.includes("ramda") || path.includes("date-fns")) {
-            return "utils"
-        }
+        if (path.includes("lodash") || path.includes("ramda") || path.includes("date-fns")) return "utils"
 
         // 外部包 (node_modules)
-        if (!path.startsWith(".") && !path.startsWith("@/")) {
-            return "external"
-        }
+        if (!path.startsWith(".") && !path.startsWith("@/")) return "external"
 
         // 内部别名 (@/)
-        if (path.startsWith("@/")) {
-            return "internal"
-        }
+        if (path.startsWith("@/")) return "internal"
 
         // 相对导入
         return "relative"
@@ -266,9 +258,7 @@ export default createPlugin({
     // 自定义导入内容排序
     sortImportContent: (a, b) => {
         // 类型在前，变量在后
-        if (a.type !== b.type) {
-            return a.type === "type" ? -1 : 1
-        }
+        if (a.type !== b.type) return a.type === "type" ? -1 : 1
 
         // 同类型内按字母顺序
         const aName = a.alias ?? a.name
@@ -481,11 +471,12 @@ import { c } from "c-module"
 注释会跟随它们所附加的导入语句一起移动：
 
 ```typescript
-// UI 组件
-import { Button } from "antd"
 // React 相关导入
 import React from "react"
 
+// UI 组件
+import { Button } from "antd"
+
 // 工具函数
 import { sum } from "./utils"
 ```

package/dist/index.js

@@ -1,4 +1,5 @@
 import { createRequire } from "module";
+import { relative } from "path";
 import { parse } from "@babel/parser";
 import traverse from "@babel/traverse";
 const analyzer_traverse = "function" == typeof traverse ? traverse : traverse["default"];
@@ -170,7 +171,7 @@ function formatGroups(groups, config) {
 function formatImportStatements(statements) {
     return statements.map(formatImportStatement).join("\n");
 }
-function parseImports(code) {
+function parseImports(code, filepath) {
     const hasImportOrExport = /^\s*(import|export)\s/m.test(code);
     if (!hasImportOrExport) return [];
     const ast = parse(code, {
@@ -187,17 +188,15 @@ function parseImports(code) {
     const usedComments = new Set();
     let isFirstImport = true;
     for (const node of body)if ("ImportDeclaration" === node.type || "ExportNamedDeclaration" === node.type && node.source || "ExportAllDeclaration" === node.type) {
-        const statement = parseImportNode(node, ast.comments ?? [], usedComments, code, isFirstImport);
+        const statement = parseImportNode(node, ast.comments ?? [], usedComments, code, isFirstImport, filepath);
         importStatements.push(statement);
         isFirstImport = false;
     } else break;
     return importStatements;
 }
-function parseImportNode(node, comments, usedComments, code, isFirstImport) {
-    node.type;
+function parseImportNode(node, comments, usedComments, code, isFirstImport, filepath) {
     const source = node.source?.value ?? "";
     const nodeStartLine = node.loc?.start.line ?? 0;
-    node.loc?.end.line;
     const nodeStart = node.start ?? 0;
     let nodeEnd = node.end ?? 0;
     const leadingComments = [];
@@ -242,6 +241,7 @@ function parseImportNode(node, comments, usedComments, code, isFirstImport) {
         const importContents = parseImportSpecifiers(node, isTypeOnlyImport);
         const isSideEffect = 0 === importContents.length;
         return {
+            filepath,
             path: source,
             isExport: false,
             isSideEffect,
@@ -254,6 +254,7 @@ function parseImportNode(node, comments, usedComments, code, isFirstImport) {
         };
     }
     if ("ExportAllDeclaration" === node.type) return {
+        filepath,
         path: source,
         isExport: true,
         isSideEffect: true,
@@ -267,6 +268,7 @@ function parseImportNode(node, comments, usedComments, code, isFirstImport) {
     const isTypeOnlyExport = "type" === node.exportKind;
     const importContents = parseExportSpecifiers(node, isTypeOnlyExport);
     return {
+        filepath,
         path: source,
         isExport: true,
         isSideEffect: false,
@@ -459,19 +461,23 @@ function groupImports(imports, userConfig) {
     const groupMap = new Map();
     for (const statement of imports){
         const groupName = config.getGroup(statement);
-        const key = `${groupName}|||${statement.isSideEffect}`;
+        const key = `${groupName}|||${statement.isSideEffect}|||${statement.isExport}`;
         const statements = groupMap.get(key) ?? [];
         statements.push(statement);
         groupMap.set(key, statements);
     }
     const groups = [];
     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);
+        const parts = key.split("|||");
+        const isExport = "true" === parts.pop();
+        const isSideEffect = "true" === parts.pop();
+        const name = parts.join("|||");
+        const filepath = statements[0].filepath;
         groups.push({
+            filepath,
             name,
             isSideEffect,
+            isExport,
             importStatements: statements
         });
     }
@@ -568,7 +574,9 @@ function preprocessImports(text, options, config = {}) {
             "babel-ts"
         ];
         if (!parser || !supportedParsers.includes(parser)) return text;
-        const imports = parseImports(text);
+        const absoluteFilepath = options.filepath;
+        const relativeFilepath = absoluteFilepath ? `./${relative(process.cwd(), absoluteFilepath).replace(/\\/g, "/")}` : void 0;
+        const imports = parseImports(text, relativeFilepath);
         if (0 === imports.length) return text;
         const optionsConfig = options;
         const finalConfig = {

package/dist/parser.d.ts

@@ -1,3 +1,3 @@
 import { ImportStatement } from "./types";
 /** 解析导入语句 */
-export declare function parseImports(code: string): ImportStatement[];
+export declare function parseImports(code: string, filepath?: string): ImportStatement[];

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 区分 */
+/** 对导入语句进行分组，同时根据 name、isSideEffect 和 isExport 区分 */
 export declare function groupImports(imports: ImportStatement[], userConfig: PluginConfig): Group[];
 /** 对分组进行排序 */
 export declare function sortGroups(groups: Group[], userConfig: PluginConfig): Group[];

package/dist/types.d.ts

@@ -14,6 +14,8 @@ export interface ImportContent {
 }
 /** 导入语句 */
 export interface ImportStatement {
+    /** 当前文件相对于当前路径的位置 */
+    filepath?: string;
     /** 导入的模块路径，可以是相对路径或绝对路径，比如 react, react-dom 或者 ./utils/index，@/utils/index 等 */
     path: string;
     /** 是否是导出语句，默认为 false */
@@ -37,10 +39,14 @@ export interface ImportStatement {
 }
 /** 分组 */
 export interface Group {
+    /** 当前文件相对于当前路径的位置 */
+    filepath?: string;
     /** 分组名称，默认为 default */
     name: string;
     /** 是否是副作用分组，默认为 false */
     isSideEffect: boolean;
+    /** 是否是导出分组，默认为 false */
+    isExport: boolean;
     /** 分组对应的导入语句列表 */
     importStatements: ImportStatement[];
 }

package/package.json

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