@1adybug/prettier-plugin-sort-imports 0.0.7 → 0.0.9

package/README.md

@@ -65,6 +65,7 @@ export default {
             // Specify group order
             sortGroup: (a, b) => {
                 const order = ["react", "external", "local"]
+
                 return order.indexOf(a.name) - order.indexOf(b.name)
             },
             // Add blank lines between groups
@@ -187,6 +188,7 @@ export default {
             },
             sortGroup: (a, b) => {
                 const order = ["react", "external", "local"]
+
                 return order.indexOf(a.name) - order.indexOf(b.name)
             },
             sortImportStatement: (a, b) => {
@@ -252,6 +254,7 @@ export default createPlugin({
     // Define group order
     sortGroup: (a, b) => {
         const order = ["react", "external", "ui", "utils", "internal", "relative"]
+
         return order.indexOf(a.name) - order.indexOf(b.name)
     },
 
@@ -418,6 +421,7 @@ separator: ""
 separator: (group, index) => {
     // No separator for the first group
     if (index === 0) return undefined
+
     // Add blank lines for other groups
     return ""
 }

package/README.zh-CN.md

@@ -64,6 +64,7 @@ export default {
             // 指定分组顺序
             sortGroup: (a, b) => {
                 const order = ["react", "external", "local"]
+
                 return order.indexOf(a.name) - order.indexOf(b.name)
             },
             // 在分组之间添加空行
@@ -245,6 +246,7 @@ export default createPlugin({
     // 定义分组顺序
     sortGroup: (a, b) => {
         const order = ["react", "external", "ui", "utils", "internal", "relative"]
+
         return order.indexOf(a.name) - order.indexOf(b.name)
     },
 
@@ -411,6 +413,7 @@ separator: ""
 separator: (group, index) => {
     // 第一个分组不添加分隔符
     if (index === 0) return undefined
+
     // 其他分组添加空行
     return ""
 }

package/dist/analyzer.d.ts

@@ -1,4 +1,5 @@
-import { ImportStatement } from "./types"; /** 分析代码中使用的标识符 */
+import { ImportStatement } from "./types";
+/** 分析代码中使用的标识符 */
 export declare function analyzeUsedIdentifiers(code: string): Set<string>;
 /** 过滤未使用的导入内容 */
 export declare function filterUnusedImports(importStatement: ImportStatement, usedIdentifiers: Set<string>): ImportStatement;

package/dist/index.js

@@ -1,6 +1,7 @@
 import { createRequire } from "module";
 import { parse } from "@babel/parser";
 import traverse from "@babel/traverse";
+const analyzer_traverse = "function" == typeof traverse ? traverse : traverse["default"];
 function analyzeUsedIdentifiers(code) {
     const usedIdentifiers = new Set();
     try {
@@ -12,7 +13,7 @@ function analyzeUsedIdentifiers(code) {
             ],
             errorRecovery: true
         });
-        traverse(ast, {
+        analyzer_traverse(ast, {
             Identifier (path) {
                 const node = path.node;
                 const parent = path.parent;
@@ -72,9 +73,13 @@ function removeUnusedImportsFromStatements(importStatements, code) {
     return filteredStatements;
 }
 function formatImportStatement(statement) {
-    const { path, isExport, isSideEffect, importContents, leadingComments, trailingComments, removedTrailingComments } = statement;
+    const { path, isExport, isSideEffect, importContents, leadingComments, trailingComments, removedTrailingComments, emptyLinesAfterComments } = statement;
     const lines = [];
-    if (leadingComments && leadingComments.length > 0) lines.push(...leadingComments);
+    if (leadingComments && leadingComments.length > 0) {
+        lines.push(...leadingComments);
+        const emptyLines = emptyLinesAfterComments ?? 0;
+        for(let i = 0; i < emptyLines; i++)lines.push("");
+    }
     if (isSideEffect) {
         let importLine = "";
         importLine = isExport ? `export * from "${path}"` : `import "${path}"`;
@@ -170,30 +175,42 @@ function parseImports(code) {
     const importStatements = [];
     const { body } = ast.program;
     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);
+        const statement = parseImportNode(node, ast.comments ?? [], usedComments, code, isFirstImport);
         importStatements.push(statement);
+        isFirstImport = false;
     } else break;
     return importStatements;
 }
-function parseImportNode(node, comments, usedComments) {
+function parseImportNode(node, comments, usedComments, code, isFirstImport) {
     node.type;
     const source = node.source?.value ?? "";
-    node.loc?.start.line;
+    const nodeStartLine = node.loc?.start.line ?? 0;
     node.loc?.end.line;
     const nodeStart = node.start ?? 0;
     let nodeEnd = node.end ?? 0;
     const leadingComments = [];
     const trailingComments = [];
     let start = nodeStart;
+    let emptyLinesAfterComments = 0;
     if (node.leadingComments) {
+        let lastCommentEndLine = 0;
         for (const comment of node.leadingComments)if (!usedComments.has(comment)) {
+            const commentEndLine = comment.loc?.end.line ?? 0;
+            const emptyLinesBetween = nodeStartLine - commentEndLine - 1;
+            if (isFirstImport && emptyLinesBetween >= 1) {
+                usedComments.add(comment);
+                continue;
+            }
             if ("CommentLine" === comment.type) leadingComments.push(`//${comment.value}`);
             else if ("CommentBlock" === comment.type) leadingComments.push(`/*${comment.value}*/`);
             const commentStart = comment.start ?? 0;
             if (commentStart < start) start = commentStart;
+            lastCommentEndLine = commentEndLine;
             usedComments.add(comment);
         }
+        if (leadingComments.length > 0 && lastCommentEndLine > 0) emptyLinesAfterComments = nodeStartLine - lastCommentEndLine - 1;
     }
     if (node.trailingComments) {
         for (const comment of node.trailingComments)if (!usedComments.has(comment)) {
@@ -221,6 +238,7 @@ function parseImportNode(node, comments, usedComments) {
             importContents,
             leadingComments: leadingComments.length > 0 ? leadingComments : void 0,
             trailingComments: trailingComments.length > 0 ? trailingComments : void 0,
+            emptyLinesAfterComments: emptyLinesAfterComments > 0 ? emptyLinesAfterComments : void 0,
             start,
             end
         };
@@ -228,10 +246,11 @@ function parseImportNode(node, comments, usedComments) {
     if ("ExportAllDeclaration" === node.type) return {
         path: source,
         isExport: true,
-        isSideEffect: false,
+        isSideEffect: true,
         importContents: [],
         leadingComments: leadingComments.length > 0 ? leadingComments : void 0,
         trailingComments: trailingComments.length > 0 ? trailingComments : void 0,
+        emptyLinesAfterComments: emptyLinesAfterComments > 0 ? emptyLinesAfterComments : void 0,
         start,
         end
     };
@@ -244,6 +263,7 @@ function parseImportNode(node, comments, usedComments) {
         importContents,
         leadingComments: leadingComments.length > 0 ? leadingComments : void 0,
         trailingComments: trailingComments.length > 0 ? trailingComments : void 0,
+        emptyLinesAfterComments: emptyLinesAfterComments > 0 ? emptyLinesAfterComments : void 0,
         start,
         end
     };

package/dist/types.d.ts

@@ -28,6 +28,8 @@ export interface ImportStatement {
     trailingComments?: string[];
     /** 被移除的导入语句的行尾注释（合并时使用） */
     removedTrailingComments?: string[];
+    /** 前导注释后的空行数（用于保留注释和 import 之间的空行） */
+    emptyLinesAfterComments?: number;
     /** 在源代码中的起始位置（包括注释） */
     start?: number;
     /** 在源代码中的结束位置 */

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@1adybug/prettier-plugin-sort-imports",
     "type": "module",
-    "version": "0.0.7",
+    "version": "0.0.9",
     "description": "一个 Prettier 插件，用于对 JavaScript/TypeScript 文件的导入语句进行分组和排序",
     "keywords": [
         "prettier",
@@ -44,16 +44,19 @@
         "build": "rslib build",
         "dev": "rslib build --watch",
         "prepublishOnly": "npm run build",
-        "format": "prettier --config prettier.config.mjs --write .",
+        "format": "prettier --write .",
         "test": "bun test",
-        "test:watch": "bun test --watch"
+        "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"
@@ -64,6 +67,7 @@
     "dependencies": {
         "@babel/core": "^7.28.4",
         "@babel/parser": "^7.28.4",
+        "@babel/traverse": "^7.28.4",
         "@babel/types": "^7.28.4"
     }
 }