Refactor codebase to use ES module syntax and improve logging

- Updated import statements across multiple files to use ES module syntax.
- Replaced `require` with `import` for better compatibility with modern JavaScript.
- Enhanced logging functionality by utilizing named exports from the logging utility.
- Refactored utility functions to improve readability and maintainability.
- Added a script to automatically append `.js` to relative import/export paths that lack extensions.
- Implemented a codemod for transforming CommonJS to ES module syntax for common patterns.
- Skipped a test that relies on CommonJS require.cache stubbing due to incompatibility with ESM conversion.

Author: cute-omega

_script/append-js-ext-transform.js

@@ -0,0 +1,54 @@
+/**
+ * Append .js to relative import/export/source literal specifiers that lack extension.
+ * Skips node: and absolute/package imports and json/vue/css etc.
+ */
+module.exports = function (fileInfo, api) {
+  const j = api.jscodeshift
+  const root = j(fileInfo.source)
+
+  function shouldAppend (pathStr) {
+    if (!pathStr)
+      return false
+    if (!pathStr.startsWith('.'))
+      return false // only relative
+    if (pathStr.endsWith('.js') || pathStr.endsWith('.mjs') || pathStr.endsWith('.cjs') || pathStr.endsWith('.json') || pathStr.endsWith('.vue') || pathStr.endsWith('.css'))
+      return false
+    return true
+  }
+
+  root.find(j.ImportDeclaration).forEach((p) => {
+    const src = p.node.source.value
+    if (shouldAppend(src)) {
+      p.node.source.value = `${src}.js`
+    }
+  })
+
+  root.find(j.ExportAllDeclaration).forEach((p) => {
+    const src = p.node.source && p.node.source.value
+    if (shouldAppend(src)) {
+      p.node.source.value = `${src}.js`
+    }
+  })
+
+  root.find(j.ExportNamedDeclaration).forEach((p) => {
+    if (p.node.source) {
+      const src = p.node.source.value
+      if (shouldAppend(src)) {
+        p.node.source.value = `${src}.js`
+      }
+    }
+  })
+
+  // also update require() calls left behind
+  root.find(j.CallExpression, { callee: { name: 'require' } }).forEach((p) => {
+    const args = p.node.arguments
+    if (args && args[0] && args[0].type === 'Literal') {
+      const src = args[0].value
+      if (shouldAppend(src)) {
+        args[0].value = `${src}.js`
+      }
+    }
+  })
+
+  return root.toSource({ quote: 'single' })
+}

_script/cjs-to-esm-transform.js

@@ -0,0 +1,76 @@
+/**
+ * Simple cjs -> esm transform for common patterns:
+ * - const X = require('...') -> import X from '...'
+ * - const {a, b} = require('...') -> import {a, b} from '...'
+ * - exports.foo = expr -> export const foo = expr
+ * - module.exports = expr -> export default expr
+ *
+ * Note: this is a best-effort codemod and will need manual review.
+ */
+
+module.exports = function (fileInfo, api) {
+  const j = api.jscodeshift
+  const root = j(fileInfo.source)
+
+  // transform `const x = require('mod')` and destructuring
+  root.find(j.VariableDeclarator, {
+    init: {
+      type: 'CallExpression',
+      callee: { name: 'require' },
+      arguments: args => args && args.length === 1 && args[0].type === 'Literal',
+    },
+  }).forEach((path) => {
+    const init = path.node.init
+    const source = init.arguments[0].value
+    const id = path.node.id
+    let importDecl
+
+    if (id.type === 'Identifier') {
+      importDecl = j.importDeclaration(
+        [j.importDefaultSpecifier(j.identifier(id.name))],
+        j.literal(source),
+      )
+      j(path.parent).replaceWith(importDecl)
+    } else if (id.type === 'ObjectPattern') {
+      const specifiers = id.properties.map((prop) => {
+        const imported = j.identifier(prop.key.name)
+        const local = prop.value ? j.identifier(prop.value.name) : j.identifier(prop.key.name)
+        return j.importSpecifier(imported, local)
+      })
+      importDecl = j.importDeclaration(specifiers, j.literal(source))
+      j(path.parent).replaceWith(importDecl)
+    }
+  })
+
+  // transform `exports.foo = expr` -> `export const foo = expr`
+  root.find(j.AssignmentExpression, {
+    left: {
+      type: 'MemberExpression',
+      object: { name: 'exports' },
+    },
+  }).forEach((p) => {
+    const left = p.node.left
+    const name = left.property.name || (left.property.value && String(left.property.value))
+    const right = p.node.right
+    const exportDecl = j.exportNamedDeclaration(
+      j.variableDeclaration('const', [j.variableDeclarator(j.identifier(name), right)]),
+      [],
+    )
+    j(p.parent).replaceWith(exportDecl)
+  })
+
+  // transform `module.exports = X` -> `export default X`
+  root.find(j.AssignmentExpression, {
+    left: {
+      type: 'MemberExpression',
+      object: { name: 'module' },
+      property: { name: 'exports' },
+    },
+  }).forEach((p) => {
+    const right = p.node.right
+    const exportDecl = j.exportDefaultDeclaration(right)
+    j(p.parent).replaceWith(exportDecl)
+  })
+
+  return root.toSource({ quote: 'single' })
+}

packages/cli/src/index.js

@@ -1,6 +1,6 @@
 const fs = require('node:fs')
 const DevSidecar = require('@docmirror/dev-sidecar')
-const jsonApi = require('@docmirror/mitmproxy/src/json')
+const jsonApi = require('@docmirror/mitmproxy/src/json.js')
 
 // 启动服务
 const mitmproxyPath = './mitmproxy'

packages/cli/src/mitmproxy.js

@@ -1,8 +1,8 @@
 const fs = require('node:fs')
 const path = require('node:path')
 const server = require('@docmirror/mitmproxy')
-const jsonApi = require('@docmirror/mitmproxy/src/json')
-const log = require('@docmirror/mitmproxy/src/utils/util.log.server') // 当前脚本是在 server 的进程中执行的，所以使用 mitmproxy 中的logger
+const jsonApi = require('@docmirror/mitmproxy/src/json.js')
+const log = require('@docmirror/mitmproxy/src/utils/util.log.server.js') // 当前脚本是在 server 的进程中执行的，所以使用 mitmproxy 中的logger
 
 const home = process.env.USER_HOME || process.env.HOME || 'C:/Users/Administrator/'
 

packages/core/package.json

@@ -1,5 +1,6 @@
 {
   "name": "@docmirror/dev-sidecar",
+  "type": "module",
   "version": "2.0.1",
   "private": false,
   "description": "给开发者的加速代理工具",

packages/core/src/config-api.js

@@ -1,12 +1,12 @@
-const fs = require('node:fs')
-const jsonApi = require('@docmirror/mitmproxy/src/json')
-const lodash = require('lodash')
-const request = require('request')
-const defConfig = require('./config/index.js')
-const mergeApi = require('./merge.js')
-const Shell = require('./shell')
-const log = require('./utils/util.log.core')
-const configLoader = require('./config/local-config-loader')
+import fs from 'node:fs';
+import jsonApi from '@docmirror/mitmproxy/src/json.js';
+import lodash from 'lodash';
+import request from 'request';
+import defConfig from './config/index.js';
+import mergeApi from './merge.js';
+import Shell from './shell.js';
+import log from './utils/util.log.core.js';
+import configLoader from './config/local-config-loader.js';
 
 let configTarget = lodash.cloneDeep(defConfig)
 
@@ -297,4 +297,4 @@ const configApi = {
   },
 }
 
-module.exports = configApi
+export default configApi;

packages/core/src/config/index.js

@@ -1,6 +1,5 @@
-/* eslint-disable style/no-tabs */
-const path = require('node:path')
-const configLoader = require('./local-config-loader')
+import path from 'node:path';
+import configLoader from './local-config-loader.js';
 
 function getRootCaCertPath () {
   return path.join(configLoader.getUserBasePath(), '/dev-sidecar.ca.crt')
@@ -1289,4 +1288,4 @@ const defaultConfig = {
 // 从本地文件中加载配置
 defaultConfig.configFromFiles = configLoader.getConfigFromFiles(configLoader.getUserConfig(), defaultConfig)
 
-module.exports = defaultConfig
+export default defaultConfig;

packages/core/src/config/local-config-loader.js

@@ -1,9 +1,9 @@
-const fs = require('node:fs')
-const path = require('node:path')
-const lodash = require('lodash')
-const jsonApi = require('@docmirror/mitmproxy/src/json')
-const mergeApi = require('../merge')
-const logOrConsole = require('../utils/util.log-or-console')
+import fs from 'node:fs'
+import path from 'node:path'
+import lodash from 'lodash'
+import jsonApi from '@docmirror/mitmproxy/src/json.js'
+import mergeApi from '../merge.js'
+import logOrConsole from '../utils/util.log-or-console.js'
 
 function getUserBasePath (autoCreate = true) {
   const userHome = process.env.USERPROFILE || process.env.HOME || '/'
@@ -110,7 +110,7 @@ function getConfigFromFiles (userConfig, defaultConfig) {
   return merged
 }
 
-module.exports = {
+export default {
   getUserBasePath,
 
   loadConfigFromFile,

packages/core/src/event.js

@@ -38,4 +38,4 @@ const EventHub = {
   fire,
   unregister,
 }
-module.exports = EventHub
+export default EventHub;

packages/core/src/expose.js

@@ -1,10 +1,10 @@
-const lodash = require('lodash')
-const config = require('./config-api')
-const event = require('./event')
-const modules = require('./modules')
-const shell = require('./shell')
-const status = require('./status')
-const log = require('./utils/util.log.core')
+import lodash from 'lodash';
+import config from './config-api.js';
+import event from './event.js';
+import modules from './modules.js';
+import shell from './shell.js';
+import status from './status.js';
+import log from './utils/util.log.core.js';
 
 const context = {
   config,
@@ -137,7 +137,8 @@ const api = {
   plugin,
   log,
 }
-module.exports = {
+
+export default {
   status,
   api,
-}
+};