@1adybug/prettier-plugin-sort-imports 0.0.4 → 0.0.5

package/README.md

@@ -198,6 +198,43 @@ export default {
 }
 ```
 
+### Method 3: Config File Path
+
+Use `sortImportsConfigPath` option to load configuration from an external file:
+
+```javascript
+// prettier.config.mjs
+export default {
+    plugins: ["prettier-plugin-import-sorts"],
+    sortImportsConfigPath: "./import-sort.config.js",
+}
+```
+
+```javascript
+// import-sort.config.js (or import-sort.config.cjs)
+module.exports = {
+    getGroup: importStatement => {
+        const path = importStatement.path
+        if (path.startsWith("react")) return "react"
+        if (path.startsWith("@/")) return "internal"
+        if (path.startsWith(".")) return "relative"
+        return "external"
+    },
+    sortGroup: (a, b) => {
+        const order = ["react", "external", "internal", "relative"]
+        return order.indexOf(a.name) - order.indexOf(b.name)
+    },
+    separator: "\n",
+}
+```
+
+**Important Notes**:
+
+- Config file must use **CommonJS format** (`module.exports`), ESM format (`export default`) is not supported
+- If your project has `"type": "module"` in `package.json`, use `.cjs` extension (e.g., `import-sort.config.cjs`)
+- Config file path is resolved relative to the project root (`process.cwd()`)
+- Configuration priority: `createPlugin` parameters > `sortImportsConfigPath` loaded config > Prettier config options
+
 ### importSortRemoveUnused
 
 Whether to remove unused imports, defaults to `false`.

package/README.zh-CN.md

@@ -198,6 +198,43 @@ export default {
 }
 ```
 
+### 方式 3：配置文件路径
+
+使用 `sortImportsConfigPath` 选项从外部文件加载配置：
+
+```javascript
+// prettier.config.mjs
+export default {
+    plugins: ["prettier-plugin-import-sorts"],
+    sortImportsConfigPath: "./import-sort.config.js",
+}
+```
+
+```javascript
+// import-sort.config.js (或 import-sort.config.cjs)
+module.exports = {
+    getGroup: importStatement => {
+        const path = importStatement.path
+        if (path.startsWith("react")) return "react"
+        if (path.startsWith("@/")) return "internal"
+        if (path.startsWith(".")) return "relative"
+        return "external"
+    },
+    sortGroup: (a, b) => {
+        const order = ["react", "external", "internal", "relative"]
+        return order.indexOf(a.name) - order.indexOf(b.name)
+    },
+    separator: "\n",
+}
+```
+
+**重要提示**：
+
+- 配置文件必须使用 **CommonJS 格式**（`module.exports`），不支持 ESM 格式（`export default`）
+- 如果你的项目在 `package.json` 中设置了 `"type": "module"`，请使用 `.cjs` 扩展名（如 `import-sort.config.cjs`）
+- 配置文件路径相对于项目根目录（`process.cwd()`）解析
+- 配置优先级：`createPlugin` 参数 > `sortImportsConfigPath` 加载的配置 > Prettier 配置选项
+
 ### importSortRemoveUnused
 
 是否删除未使用的导入，默认为 `false`。

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 import { Plugin } from "prettier";
 import { PluginConfig } from "./types";
+export * from "./types";
 /** 默认插件实例（用于简单使用） */
 declare const plugin: Plugin;
 /** 创建自定义配置的插件（工厂函数） */

package/dist/index.js

@@ -1,4 +1,5 @@
 import { createRequire } from "module";
+import { resolve } from "path";
 import { parse } from "@babel/parser";
 import traverse from "@babel/traverse";
 function analyzeUsedIdentifiers(code) {
@@ -526,18 +527,43 @@ function mergeImports(imports) {
 }
 const src_require = createRequire(import.meta.url);
 let src_userConfig = {};
+const configCache = new Map();
+function loadConfigFromPath(configPath) {
+    if (configCache.has(configPath)) return configCache.get(configPath);
+    try {
+        const absolutePath = resolve(process.cwd(), configPath);
+        let config = {};
+        try {
+            delete src_require.cache[absolutePath];
+            const module = src_require(absolutePath);
+            config = module.default || module || {};
+        } catch (requireError) {
+            throw new Error(`Failed to load config file: ${configPath}. Please ensure the config file uses CommonJS format (module.exports) or has a .cjs extension. ESM format (.mjs or "type": "module") is not supported in synchronous loading context.\nOriginal error: ${requireError}`);
+        }
+        configCache.set(configPath, config);
+        return config;
+    } catch (error) {
+        console.error(`Failed to load config from ${configPath}:`, error);
+        const emptyConfig = {};
+        configCache.set(configPath, emptyConfig);
+        return emptyConfig;
+    }
+}
 function preprocessImports(text, options) {
     try {
         const imports = parseImports(text);
         if (0 === imports.length) return text;
+        const configPath = options.sortImportsConfigPath;
+        let fileConfig = {};
+        if (configPath && "string" == typeof configPath) fileConfig = loadConfigFromPath(configPath);
         const config = {
-            getGroup: src_userConfig.getGroup ?? options.getGroup,
-            sortGroup: src_userConfig.sortGroup ?? options.sortGroup,
-            sortImportStatement: src_userConfig.sortImportStatement ?? options.sortImportStatement,
-            sortImportContent: src_userConfig.sortImportContent ?? options.sortImportContent,
-            separator: src_userConfig.separator ?? options.importSortSeparator ?? options.separator,
-            sortSideEffect: src_userConfig.sortSideEffect ?? options.importSortSideEffect ?? false,
-            removeUnusedImports: src_userConfig.removeUnusedImports ?? options.importSortRemoveUnused ?? false
+            getGroup: src_userConfig.getGroup ?? fileConfig.getGroup ?? options.getGroup,
+            sortGroup: src_userConfig.sortGroup ?? fileConfig.sortGroup ?? options.sortGroup,
+            sortImportStatement: src_userConfig.sortImportStatement ?? fileConfig.sortImportStatement ?? options.sortImportStatement,
+            sortImportContent: src_userConfig.sortImportContent ?? fileConfig.sortImportContent ?? options.sortImportContent,
+            separator: src_userConfig.separator ?? fileConfig.separator ?? options.importSortSeparator ?? options.separator,
+            sortSideEffect: src_userConfig.sortSideEffect ?? fileConfig.sortSideEffect ?? options.importSortSideEffect ?? false,
+            removeUnusedImports: src_userConfig.removeUnusedImports ?? fileConfig.removeUnusedImports ?? options.importSortRemoveUnused ?? false
         };
         let processedImports = imports;
         if (config.removeUnusedImports) {
@@ -587,6 +613,11 @@ function createPluginInstance() {
             }
         },
         options: {
+            sortImportsConfigPath: {
+                type: "string",
+                category: "Import Sort",
+                description: "配置文件路径，用于加载自定义排序配置"
+            },
             importSortSeparator: {
                 type: "string",
                 category: "Import Sort",

package/package.json

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