fix(plugin-loader): loading ESM configure using URL format (#219)

link #216 #217

Author: Zhengqbbb

docs/faq/index.md

@@ -8,7 +8,7 @@ sitemap:
 
 # FAQ
 
-## Error: require() of ES Module ... not supported
+## Error: Cannot require() ES Module ... not supported
 > [MODULE_TYPELESS_PACKAGE_JSON] Warning: Module type of xxxx is not specified and it doesn't parse as CommonJS.
 
 1. If you are an ESM project (i.e., `"type": "module"` in package.json) or using `export default` syntax,

docs/zh/faq/index.md

@@ -7,7 +7,7 @@ sitemap:
 ---
 # 常见问题
 
-## Error: require() of ES Module ... not supported
+## Error: Cannot require() ES Module ... not supported
 > [MODULE_TYPELESS_PACKAGE_JSON] Warning: Module type of xxxx is not specified and it doesn't parse as CommonJS.
 
 1. 如果你是 ESM 项目 (即 package.json 中有 `"type": "module"`) 或使用 `export default` 语法

packages/@cz-git/plugin-loader/__tests__/fixtures/6-esm-config/commitlint.config.mjs

@@ -0,0 +1,10 @@
+import { defineConfig } from 'cz-git'
+
+export default defineConfig({
+    rules: {
+        'scope-enum': [2, 'always', ['cz-git']],
+    },
+    prompt: {
+        useEmoji: true,
+    },
+})

packages/@cz-git/plugin-loader/__tests__/fixtures/6-esm-config/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "test",
+  "private": true,
+  "author": "Zhengqbbb <[email protected]> (https://github.com/Zhengqbbb)",
+  "config": {
+    "commitizen": {
+      "path": "node_modules/cz-git"
+    }
+  }
+}

packages/@cz-git/plugin-loader/__tests__/loader.test.ts

@@ -110,4 +110,13 @@ describe('config loader', () => {
             },
         })
     }, 1000)
+
+    it('default env load esm config', async () => {
+        mockDir = await useBootstrap('./fixtures/6-esm-config')
+        const config = await loaderSpyFn({ cwd: mockDir.name })
+        expect(config).toEqual({
+            rules: { 'scope-enum': [2, 'always', ['cz-git']] },
+            prompt: { path: 'node_modules/cz-git', useEmoji: true },
+        })
+    }, 1000)
 })

packages/@cz-git/plugin-loader/src/esm-ts-loader.ts

@@ -1,4 +1,5 @@
 import process from 'node:process'
+import { resolve } from 'node:path'
 import { style } from '@cz-git/inquirer'
 import type { Loader } from 'cosmiconfig'
 
@@ -10,7 +11,7 @@ type LoaderError = Error & {
 export function esmTsLoader(): Loader {
     return async (cfgPath: string, _: string) => {
         try {
-            const result = await import(cfgPath) as { default?: any }
+            const result = await import(fileToURL(cfgPath))
             return result.default || result
         }
         catch (e: any) {
@@ -41,3 +42,21 @@ export function esmTsLoader(): Loader {
         }
     }
 }
+
+export function fileToURL(filePath: string) {
+    if (typeof filePath !== 'string')
+        throw new TypeError(`Expected a string, got ${typeof filePath}`)
+
+    let pathName = resolve(filePath)
+
+    pathName = pathName.replace(/\\/g, '/')
+
+    // Windows drive letter must be prefixed with a slash.
+    if (pathName[0] !== '/') {
+        pathName = `/${pathName}`
+    }
+
+    // Escape required characters for path components.
+    // See: https://tools.ietf.org/html/rfc3986#section-3.3
+    return encodeURI(`file://${pathName}`).replace(/[?#]/g, encodeURIComponent)
+}