feat: support syncPackage, support emit source-map on production build

Author: Lucifier129

packages/react-imvc-v2/build/createWebpackConfig.js

@@ -179,7 +179,7 @@ module.exports = async function createWebpackConfig(options, isServer = false) {
                         parallel: true,
                         // Enable file caching
                         cache: true,
-                        sourceMap: false,
+                        sourceMap: config.devtool ? true : false,
                     }),
                 ],
             })

packages/react-imvc-v2/config/config.defaults.js

@@ -298,4 +298,10 @@ module.exports = {
      * 默认为 false
      */
     useContentHash: false,
+
+    /**
+     * 是否同步 {root}/package.json 到 {root}/{publish}/package.json
+     * 默认为 true
+     */
+    syncPackage: true,
 }

packages/react-imvc-v2/package.json

@@ -1,6 +1,6 @@
 {
     "name": "react-imvc",
-    "version": "2.10.27",
+    "version": "2.10.28",
     "description": "An Isomorphic MVC Framework",
     "main": "./index",
     "bin": {

packages/react-imvc-v2/project/build.js

@@ -8,6 +8,7 @@ const config = {
     routes: 'routes', // 服务端路由目录
     layout: 'Layout', // 自定义 Layout
     staticPath: '/my_static', // 静态资源目录
+    // devtool: 'source-map',
     // bundleAnalyzer: true,
     // staticEntry: 'index.html',
     publish: '../project_publish', // 打包输出目录

packages/react-imvc-v2/project/preview.js

@@ -8,6 +8,7 @@ const config = {
     basename: ['/a', '/b'],
     routes: 'routes', // 服务端路由目录
     staticPath: '/my_static', // 静态资源目录
+    publish: '../project_publish', // 打包输出目录
     layout: 'Layout', // 自定义 Layout
     // bundleAnalyzer: true,
     // useTypeCheck: true

packages/react-imvc-v2/project/start.js

@@ -10,6 +10,7 @@ const config = {
     layout: 'Layout', // 自定义 Layout
     staticPath: '/my_static', // 静态资源目录
     useFileLoader: true,
+    publish: '../project_publish', // 打包输出目录
     // bundleAnalyzer: true,
     // useTypeCheck: true
 }

packages/react-imvc-v2/scripts/start.js

@@ -11,4 +11,7 @@ if (process.env.NODE_ENV === 'development') {
     })
 }
 
-require('../start/index')(options)
+require('../start/index')({
+    ...options,
+    fromScript: true,
+})

packages/react-imvc-v2/start/index.js

@@ -8,6 +8,7 @@ if (!process.env.NODE_ENV) {
 require('core-js/stable')
 require('regenerator-runtime/runtime')
 
+let fs = require('fs').promises
 let path = require('path')
 let http = require('http')
 let fetch = require('node-fetch')
@@ -20,8 +21,83 @@ createExpressApp = createExpressApp.default || createExpressApp
 getConfig = getConfig.default || getConfig
 createPageRouter = createPageRouter.default || createPageRouter
 
+const isExist = async (path) => {
+    try {
+        await fs.access(path)
+        return true
+    } catch (e) {
+        return false
+    }
+}
+
+const findUpClosestTwoPackages = async (startDir) => {
+    let currentDir = startDir
+    let packages = []
+
+    while (true) {
+        let packageFile = path.join(currentDir, 'package.json')
+        if (await isExist(packageFile)) {
+            packages.unshift({
+                filename: packageFile,
+                package: require(packageFile),
+            })
+
+            if (packages.length >= 2) {
+                break
+            }
+        }
+
+        let parentDir = path.dirname(currentDir)
+
+        if (parentDir === currentDir) {
+            break
+        }
+
+        currentDir = parentDir
+    }
+
+    return packages
+}
+
+const syncPackage = async () => {
+    const mainFilename = path.normalize(require.main?.filename ?? '')
+
+    if (!mainFilename) {
+        return
+    }
+
+    const packages = await findUpClosestTwoPackages(path.dirname(mainFilename))
+
+    if (packages.length < 2) {
+        return
+    }
+
+    const [rootPackage, publishPackage] = packages
+
+    const isPackageNameEqual = rootPackage.package.name === publishPackage.package.name
+    const isPackageContentEqual = JSON.stringify(rootPackage.package) === JSON.stringify(publishPackage.package)
+
+    if (!isPackageNameEqual || isPackageContentEqual) {
+        return
+    }
+
+    console.error(`${publishPackage.filename}\nis not equal to\n${rootPackage.filename}\nSyncing...`)
+    await fs.writeFile(publishPackage.filename, await fs.readFile(rootPackage.filename))
+    console.error('Syncing done. Please restart the server to apply changes')
+    process.exit(1)
+}
+
 module.exports = async function start(options) {
     let config = getConfig(options)
+
+    /**
+     * sync package.json in root dir and publish dir
+     * if they are not equal when server starts not from script
+     */
+    if (config.syncPackage && options.fromScript !== true) {
+        await syncPackage()
+    }
+
     let [app, pageRouter] = await Promise.all([createExpressApp(config), createPageRouter(config)])
     let port = normalizePort(config.port)
 

packages/react-imvc-v3/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-imvc",
-  "version": "3.5.0",
+  "version": "3.5.1",
   "description": "An Isomorphic MVC Framework",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -160,7 +160,7 @@
     "@types/loader-utils": "^1.1.9",
     "@types/memory-fs": "^0.3.2",
     "@types/morgan": "^1.9.0",
-    "@types/node": "^10.17.17",
+    "@types/node": "^22.13.9",
     "@types/node-fetch": "^2.5.5",
     "@types/node-notifier": "^6.0.0",
     "@types/puppeteer": "^2.0.1",

packages/react-imvc-v3/project/imvc.config.tsx

@@ -12,6 +12,7 @@ const config: Config = {
   routes: 'routes', // 服务端路由目录
   layout: 'Layout', // 自定义 Layout
   publish: '../publish',
+  devtool: 'source-map',
   useContentHash: true,
   useFileLoader: true,
   useSass: true,