@1adybug/prettier-plugin-sort-imports 0.0.17 → 0.0.19

package/README.md

@@ -45,8 +45,11 @@ 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"
 ```
 
@@ -87,7 +90,9 @@ import { Button } from "antd"
 import { format } from "date-fns"
 
 import { Header } from "./components/Header"
+
 import { sum } from "./utils"
+
 import "./styles.css"
 ```
 
@@ -201,12 +206,8 @@ export default {
 
                 return order.indexOf(a.name) - order.indexOf(b.name)
             },
-            sortImportStatement: (a, b) => {
-                return a.path.localeCompare(b.path)
-            },
-            sortImportContent: (a, b) => {
-                return a.name.localeCompare(b.name)
-            },
+            sortImportStatement: (a, b) => a.path.localeCompare(b.path),
+            sortImportContent: (a, b) => a.name.localeCompare(b.name),
 
             // Configuration
             separator: "\n",
@@ -449,12 +450,7 @@ separator: (group, index) => {
 
 ```typescript
 import Default, * as Namespace from "module"
-import {
-    type TypeA,
-    type TypeB,
-    VariableA,
-    VariableB,
-} from "module"
+import { type TypeA, type TypeB, VariableA, VariableB } from "module"
 ```
 
 **Custom behavior**:
@@ -473,11 +469,7 @@ createPlugin({
 ```
 
 ```typescript
-import {
-    API_KEY,
-    type User,
-    getUser,
-} from "api"
+import { type User, API_KEY, getUser } from "api"
 ```
 
 ### Import Statement Sorting

package/README.zh-CN.md

@@ -44,8 +44,11 @@ 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"
 ```
 
@@ -86,7 +89,9 @@ import { Button } from "antd"
 import { format } from "date-fns"
 
 import { Header } from "./components/Header"
+
 import { sum } from "./utils"
+
 import "./styles.css"
 ```
 
@@ -441,12 +446,7 @@ separator: (group, index) => {
 
 ```typescript
 import Default, * as Namespace from "module"
-import {
-    type TypeA,
-    type TypeB,
-    VariableA,
-    VariableB,
-} from "module"
+import { type TypeA, type TypeB, VariableA, VariableB } from "module"
 ```
 
 **自定义行为**：
@@ -465,11 +465,7 @@ createPlugin({
 ```
 
 ```typescript
-import {
-    API_KEY,
-    type User,
-    getUser,
-} from "api"
+import { type User, API_KEY, getUser } from "api"
 ```
 
 ### 导入语句排序

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,13 +188,13 @@ 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) {
+function parseImportNode(node, comments, usedComments, code, isFirstImport, filepath) {
     node.type;
     const source = node.source?.value ?? "";
     const nodeStartLine = node.loc?.start.line ?? 0;
@@ -242,6 +243,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 +256,7 @@ function parseImportNode(node, comments, usedComments, code, isFirstImport) {
         };
     }
     if ("ExportAllDeclaration" === node.type) return {
+        filepath,
         path: source,
         isExport: true,
         isSideEffect: true,
@@ -267,6 +270,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,
@@ -469,7 +473,9 @@ function groupImports(imports, userConfig) {
         const separatorIndex = key.lastIndexOf("|||");
         const name = key.slice(0, separatorIndex);
         const isSideEffect = "true" === key.slice(separatorIndex + 3);
+        const filepath = statements[0].filepath;
         groups.push({
+            filepath,
             name,
             isSideEffect,
             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/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,6 +39,8 @@ export interface ImportStatement {
 }
 /** 分组 */
 export interface Group {
+    /** 当前文件相对于当前路径的位置 */
+    filepath?: string;
     /** 分组名称，默认为 default */
     name: string;
     /** 是否是副作用分组，默认为 false */

package/package.json

@@ -1,74 +1,67 @@
 {
-    "name": "@1adybug/prettier-plugin-sort-imports",
-    "type": "module",
-    "version": "0.0.17",
-    "description": "一个 Prettier 插件，用于对 JavaScript/TypeScript 文件的导入语句进行分组和排序",
-    "keywords": [
-        "prettier",
-        "plugin",
-        "import",
-        "sort",
-        "organize",
-        "typescript",
-        "javascript"
-    ],
-    "author": "1adybug <lurongv@qq.com>",
-    "license": "MIT",
-    "repository": {
-        "type": "git",
-        "url": "git+https://github.com/1adybug/prettier-plugin-sort-imports.git"
-    },
-    "homepage": "https://github.com/1adybug/prettier-plugin-sort-imports#readme",
-    "bugs": {
-        "url": "https://github.com/1adybug/prettier-plugin-sort-imports/issues"
-    },
-    "sideEffects": false,
-    "publishConfig": {
-        "access": "public",
-        "registry": "https://registry.npmjs.com/"
-    },
-    "exports": {
-        ".": {
-            "types": "./dist/index.d.ts",
-            "import": "./dist/index.js",
-            "require": "./dist/index.js"
-        }
-    },
-    "main": "./dist/index.js",
-    "module": "./dist/index.js",
-    "types": "./dist/index.d.ts",
-    "files": [
-        "dist"
-    ],
-    "scripts": {
-        "build": "rslib build",
-        "dev": "rslib build --watch",
-        "prepublishOnly": "npm run build",
-        "format": "prettier --write .",
-        "test": "bun test",
-        "test:watch": "bun test --watch",
-        "fg": "npm run format && git add . && git commit -m \"✨feature: format\"",
-        "ucr": "npx zixulu acr"
-    },
-    "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"
-    },
-    "peerDependencies": {
-        "prettier": "^3.0.0"
-    },
-    "dependencies": {
-        "@babel/core": "^7.28.4",
-        "@babel/parser": "^7.28.4",
-        "@babel/traverse": "^7.28.4",
-        "@babel/types": "^7.28.4"
+  "name": "@1adybug/prettier-plugin-sort-imports",
+  "version": "0.0.19",
+  "description": "一个 Prettier 插件，用于对 JavaScript/TypeScript 文件的导入语句进行分组和排序",
+  "keywords": [
+    "prettier",
+    "plugin",
+    "import",
+    "sort",
+    "organize",
+    "typescript",
+    "javascript"
+  ],
+  "author": "1adybug <lurongv@qq.com>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/1adybug/prettier.git"
+  },
+  "homepage": "https://github.com/1adybug/prettier/tree/main/packages/prettier-plugin-sort-imports",
+  "bugs": {
+    "url": "https://github.com/1adybug/prettier/issues"
+  },
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.js"
     }
-}
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "sideEffects": false,
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.com/"
+  },
+  "dependencies": {
+    "@babel/core": "^7.28.4",
+    "@babel/parser": "^7.28.4",
+    "@babel/traverse": "^7.28.4",
+    "@babel/types": "^7.28.4"
+  },
+  "devDependencies": {
+    "@rslib/core": "^0.15.0",
+    "@types/babel__core": "^7.20.5",
+    "@types/bun": "latest",
+    "@types/node": "^22.18.6",
+    "json5": "^2.2.3",
+    "supports-color": "^10.2.2",
+    "typescript": "^5.9.2"
+  },
+  "peerDependencies": {
+    "prettier": "^3.0.0"
+  },
+  "scripts": {
+    "build": "rslib build",
+    "dev": "rslib build --watch",
+    "test": "bun test",
+    "test:watch": "bun test --watch"
+  }
+}