@1adybug/prettier-plugin-sort-imports 0.0.6 → 0.0.8

package/README.md

@@ -13,6 +13,7 @@ A powerful Prettier plugin for intelligently grouping and sorting import stateme
 - ✅ **Side Effect Handling**: Configurable sorting behavior for side effect imports
 - ✅ **Unused Import Removal**: Optional automatic removal of unused imports
 - ✅ **Factory Function Pattern**: Support for custom functions in configuration files
+- ✅ **Tailwind CSS Integration**: Compatible with `prettier-plugin-tailwindcss`
 
 ## Quick Start
 
@@ -288,6 +289,7 @@ export default {
 ```
 
 **Benefits of this approach**:
+
 - ✅ **Reusable**: Share the same configuration across multiple projects
 - ✅ **Version Control**: Track your import sorting rules in git
 - ✅ **Maintainable**: Keep complex logic separate from prettier config
@@ -556,6 +558,30 @@ export default {
 
 This maintains configuration flexibility while not violating Prettier's configuration system limitations.
 
+## Integration with Other Plugins
+
+### Tailwind CSS
+
+This plugin works seamlessly with `prettier-plugin-tailwindcss`. For detailed setup instructions, see [TAILWINDCSS_INTEGRATION.md](./TAILWINDCSS_INTEGRATION.md).
+
+**Quick Setup:**
+
+```javascript
+// prettier.config.mjs
+export default {
+    plugins: [
+        "@1adybug/prettier-plugin-sort-imports",
+        "prettier-plugin-tailwindcss", // Must come last
+    ],
+    tailwindFunctions: ["clsx", "cn", "cva", "tw"],
+}
+```
+
+This will:
+
+- ✅ Sort and merge your imports
+- ✅ Sort your Tailwind CSS classes according to the recommended order
+
 ## Notes
 
 1. **Only processes consecutive import/export statement blocks at the beginning of files**

package/README.zh-CN.md

@@ -282,6 +282,7 @@ export default {
 ```
 
 **此方法的优点**：
+
 - ✅ **可复用**：在多个项目间共享相同配置
 - ✅ **版本控制**：在 git 中跟踪你的导入排序规则
 - ✅ **易维护**：将复杂逻辑从 prettier 配置中分离

package/dist/index.js

@@ -72,9 +72,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 +174,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 +237,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 +245,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 +262,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
     };
@@ -581,11 +600,11 @@ function createCombinedPreprocess(parserName, config) {
             ...prettierOptions
         };
         const preprocessFunctions = [];
+        preprocessFunctions.push((text, options)=>preprocessImports(text, options, config));
         for (const plugin of otherPlugins){
             const parser = plugin?.parsers?.[parserName];
             if (parser?.preprocess && "function" == typeof parser.preprocess) preprocessFunctions.push(parser.preprocess);
         }
-        preprocessFunctions.push((text, options)=>preprocessImports(text, options, config));
         let processedText = text;
         for (const preprocess of preprocessFunctions)try {
             processedText = preprocess(processedText, mergedOptions);
@@ -620,23 +639,43 @@ function createPluginInstance(config = {}) {
         ...baseOptions
     };
     for (const plugin of otherPlugins)if (plugin?.options) Object.assign(mergedOptions, plugin.options);
-    return {
-        parsers: {
-            babel: {
-                ...babel,
-                preprocess: createCombinedPreprocess("babel", config)
-            },
-            typescript: {
-                ...typescript,
-                preprocess: createCombinedPreprocess("typescript", config)
-            },
-            "babel-ts": {
-                ...babelTs,
-                preprocess: createCombinedPreprocess("babel-ts", config)
+    const mergedPrinters = {};
+    for (const plugin of otherPlugins)if (plugin?.printers) Object.assign(mergedPrinters, plugin.printers);
+    const mergedParsers = {};
+    const parserNames = [
+        "babel",
+        "typescript",
+        "babel-ts"
+    ];
+    const baseParsers = {
+        babel,
+        typescript,
+        "babel-ts": babelTs
+    };
+    for (const parserName of parserNames){
+        const baseParser = baseParsers[parserName];
+        let merged = {
+            ...baseParser
+        };
+        for (const plugin of otherPlugins){
+            const otherParser = plugin?.parsers?.[parserName];
+            if (otherParser) {
+                const { preprocess, ...otherAttrs } = otherParser;
+                merged = {
+                    ...merged,
+                    ...otherAttrs
+                };
             }
-        },
+        }
+        merged.preprocess = createCombinedPreprocess(parserName, config);
+        mergedParsers[parserName] = merged;
+    }
+    const result = {
+        parsers: mergedParsers,
         options: mergedOptions
     };
+    if (Object.keys(mergedPrinters).length > 0) result.printers = mergedPrinters;
+    return result;
 }
 function createPlugin(config = {}) {
     return createPluginInstance(config);

package/dist/sorter.d.ts

@@ -1,4 +1,4 @@
-import { Group, ImportContent, ImportStatement, PluginConfig } from "./types"; /** 导入类型 */
+import { Group, ImportContent, ImportStatement, PluginConfig } from "./types";
 /** 合并后的配置 */
 export interface MergedConfig extends Omit<Required<PluginConfig>, "separator" | "removeUnusedImports" | "otherPlugins" | "prettierOptions"> {
     separator: PluginConfig["separator"];

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.6",
+    "version": "0.0.8",
     "description": "一个 Prettier 插件，用于对 JavaScript/TypeScript 文件的导入语句进行分组和排序",
     "keywords": [
         "prettier",
@@ -54,6 +54,7 @@
         "@types/bun": "latest",
         "@types/node": "^22.18.6",
         "prettier": "^3.6.2",
+        "prettier-plugin-tailwindcss": "^0.7.0",
         "supports-color": "^10.2.2",
         "typescript": "^5.9.2"
     },