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

package/dist/formatter.d.ts

@@ -1,6 +1,7 @@
+import type { ParserOptions } from "prettier";
 import { Group, ImportStatement, PluginConfig } from "./types"; /** 格式化导入语句 */
-export declare function formatImportStatement(statement: ImportStatement): string;
+export declare function formatImportStatement(statement: ImportStatement, trailingComma?: ParserOptions["trailingComma"]): string;
 /** 格式化分组 */
-export declare function formatGroups(groups: Group[], config: PluginConfig): string;
+export declare function formatGroups(groups: Group[], config: PluginConfig, trailingComma?: ParserOptions["trailingComma"]): string;
 /** 格式化导入语句列表（不使用分组） */
-export declare function formatImportStatements(statements: ImportStatement[]): string;
+export declare function formatImportStatements(statements: ImportStatement[], trailingComma?: ParserOptions["trailingComma"]): string;

package/dist/index.js

@@ -79,9 +79,10 @@ function removeUnusedImportsFromStatements(importStatements, code) {
     }
     return filteredStatements;
 }
-function formatImportStatement(statement) {
+function formatImportStatement(statement, trailingComma = "es5") {
     const { path, isExport, isSideEffect, importContents, leadingComments, trailingComments, removedTrailingComments, emptyLinesAfterComments } = statement;
     const lines = [];
+    const shouldAddTrailingComma = "none" !== trailingComma;
     if (leadingComments && leadingComments.length > 0) {
         lines.push(...leadingComments);
         const emptyLines = emptyLinesAfterComments ?? 0;
@@ -130,8 +131,25 @@ function formatImportStatement(statement) {
         const defaultPart = parts.length > 0 ? parts.join(", ") + ", " : "";
         const importStart = `${keyword} ${typeKeyword}${defaultPart}{`;
         const importEnd = `} from "${path}"`;
+        const formatWithTrailingComma = (item)=>{
+            const lines = item.split("\n");
+            const lastLine = lines.pop();
+            const lineWithComma = (()=>{
+                const lineCommentIndex = lastLine.indexOf(" //");
+                const blockCommentIndex = lastLine.indexOf(" /*");
+                const commentIndex = -1 === lineCommentIndex ? blockCommentIndex : -1 === blockCommentIndex ? lineCommentIndex : Math.min(lineCommentIndex, blockCommentIndex);
+                if (-1 === commentIndex) return `${lastLine},`;
+                return `${lastLine.slice(0, commentIndex)},${lastLine.slice(commentIndex)}`;
+            })();
+            lines.push(lineWithComma);
+            return lines.join("\n");
+        };
         lines.push(importStart);
-        lines.push(`    ${namedPartsWithComments.join(",\n    ")},`);
+        const formattedParts = [
+            ...namedPartsWithComments
+        ];
+        if (shouldAddTrailingComma) formattedParts[formattedParts.length - 1] = formatWithTrailingComma(formattedParts[formattedParts.length - 1]);
+        lines.push(`    ${formattedParts.join(",\n    ")}`);
         lines.push(importEnd);
     } else {
         if (namedParts.length > 0) if (allNamedImportsAreTypes && !hasDefaultOrNamespace) {
@@ -151,7 +169,7 @@ function formatImportStatement(statement) {
     }
     return lines.join("\n");
 }
-function formatGroups(groups, config) {
+function formatGroups(groups, config, trailingComma) {
     const lines = [];
     const separator = config.groupSeparator;
     for(let i = 0; i < groups.length; i++){
@@ -164,12 +182,12 @@ function formatGroups(groups, config) {
                 if ("" !== separatorStr) lines.push(separatorStr);
             }
         }
-        for (const statement of group.importStatements)lines.push(formatImportStatement(statement));
+        for (const statement of group.importStatements)lines.push(formatImportStatement(statement, trailingComma));
     }
     return lines.join("\n");
 }
-function formatImportStatements(statements) {
-    return statements.map(formatImportStatement).join("\n");
+function formatImportStatements(statements, trailingComma) {
+    return statements.map((statement)=>formatImportStatement(statement, trailingComma)).join("\n");
 }
 function parseImports(code, filepath) {
     const hasImportOrExport = /^\s*(import|export)\s/m.test(code);
@@ -599,8 +617,8 @@ function preprocessImports(text, options, config = {}) {
         if (finalConfig.getGroup) {
             const groups = groupImports(mergedImports, finalConfig);
             const sortedGroups = sortGroups(groups, finalConfig);
-            formattedImports = formatGroups(sortedGroups, finalConfig);
-        } else formattedImports = formatImportStatements(mergedImports);
+            formattedImports = formatGroups(sortedGroups, finalConfig, options.trailingComma);
+        } else formattedImports = formatImportStatements(mergedImports, options.trailingComma);
         const firstImport = imports[0];
         const lastImport = imports[imports.length - 1];
         const startIndex = firstImport.start ?? 0;

package/package.json

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