@qse/edu-scripts 2.0.2 → 2.0.3

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # 更新日志
 
+## 2.0.3 (2926-03-10)
+
+- feat: 增加 cache 配置项
+- feat: 增加 override 迁移提示
+- fix: 修复 dll 在 pnpm 环境下失效
+
 ## 2.0.2 (2926-03-10)
 
 - fix: 修复 react 兼容问题

package/dist/cli.mjs

@@ -49,13 +49,16 @@ function resolveOwn(...filePath) {
 	}
 	return path.resolve(current, ...filePath);
 }
+function resolveExistPaths(...paths) {
+	return paths.filter((p) => fs.existsSync(p));
+}
 function getExistPath(...paths) {
-	for (const path of paths) if (fs.existsSync(path)) return path;
-	return paths[0];
+	return resolveExistPaths(...paths)[0] || paths[0];
 }
 const paths = {
 	resolveApp,
 	resolveOwn,
+	resolveExistPaths,
 	eduAppEnv: resolveApp("src", "edu-app-env.d.ts"),
 	dist: resolveApp("dist"),
 	sshSftp: resolveApp(".sftprc.json"),
@@ -210,6 +213,23 @@ const qseCDN = (() => {
 		isUseQsbSchemeRender: include("qsb-scheme-render.min.js")
 	};
 })();
+function getPnpmCompatibleDllManifest(manifestPath) {
+	const manifest = fs.readJsonSync(manifestPath);
+	const normalizedContent = { ...manifest.content };
+	for (const [key, value] of Object.entries(manifest.content)) {
+		if (!key.startsWith("./node_modules/")) continue;
+		const request = key.replace("./node_modules/", "");
+		try {
+			const resolvedPath = require$2.resolve(request);
+			const relativePath = `./${path$1.relative(process.cwd(), resolvedPath).replace(/\\/g, "/")}`;
+			if (!normalizedContent[relativePath]) normalizedContent[relativePath] = value;
+		} catch {}
+	}
+	return {
+		...manifest,
+		content: normalizedContent
+	};
+}
 function getWebpackConfig(args, override) {
 	const isDev = process.env.NODE_ENV === "development";
 	const isProd = process.env.NODE_ENV === "production";
@@ -259,7 +279,7 @@ function getWebpackConfig(args, override) {
 		});
 		return loaders;
 	};
-	return {
+	const config = {
 		context: process.cwd(),
 		mode: process.env.NODE_ENV,
 		entry: "./src/index",
@@ -271,6 +291,7 @@ function getWebpackConfig(args, override) {
 			uniqueName: appPkg$1.name,
 			publicPath: ""
 		},
+		name: appPkg$1.name,
 		externals: Object.assign({}, qseCDN.isUseCommon && {
 			react: "React",
 			"react-dom": "ReactDOM",
@@ -466,7 +487,7 @@ function getWebpackConfig(args, override) {
 			}
 		].filter(Boolean) }] },
 		plugins: [
-			qseCDN.isUseCommon && new rspack.DllReferencePlugin({ manifest: fs.readJsonSync(paths.resolveOwn("asset", "dll", "libcommon3-manifest.json")) }),
+			qseCDN.isUseCommon && new rspack.DllReferencePlugin({ manifest: getPnpmCompatibleDllManifest(paths.resolveOwn("asset", "dll", "libcommon3-manifest.json")) }),
 			new rspack.NormalModuleReplacementPlugin(/@rspack\/dev-server\/client\/index\.js/, (resource) => {
 				const myClientPath = paths.resolveOwn("asset", "rspack-dev-server-client.js");
 				resource.request = resource.request.replace(/.*dev-server\/client\/index\.js/, myClientPath);
@@ -543,6 +564,17 @@ function getWebpackConfig(args, override) {
 			maxAssetSize: 2 * 1024 * 1024
 		}
 	};
+	if (override.cache) {
+		config.cache = true;
+		config.experiments = {
+			...config.experiments,
+			cache: {
+				type: "persistent",
+				buildDependencies: paths.resolveExistPaths(fileURLToPath(import.meta.url), paths.package, paths.tsconfig, paths.override)
+			}
+		};
+	}
+	return config;
 }
 
 //#endregion
@@ -722,6 +754,15 @@ const defaultOverride = {
 	import: [],
 	pure_funcs: ["console.log"]
 };
+function migrateOverride(override) {
+	if ("transformNodeModules" in override) console.warn("transformNodeModules 配置已废弃，请删除这个配置项");
+	if ("minifyImage" in override) console.warn("minifyImage 配置已废弃，请删除这个配置项");
+	if (typeof override.minify !== "boolean") {
+		console.warn("minify 类型错误，请使用boolean类型，已自动设置为 true");
+		override.minify = true;
+	}
+	if ("babel" in override) throw new Error("babel 配置已废弃，请删除这个配置项。如果有 babel-plugin-import 相关的配置，请直接使用 import 选项");
+}
 let override = null;
 function getOverride() {
 	if (override) return override;
@@ -730,6 +771,7 @@ function getOverride() {
 		const userOverride = resolveModule(require(paths.override));
 		if (typeof userOverride !== "object") throw new Error("格式错误，请使用 npx edu g override 生成文件");
 		Object.assign(override, userOverride);
+		migrateOverride(override);
 	}
 	return override;
 }
@@ -902,14 +944,15 @@ async function build(args) {
 			}));
 			process.exit(1);
 		}
+		printFileSizesAfterBuild(stats, previousSizeMap, paths.dist, WARN_AFTER_BUNDLE_GZIP_SIZE, WARN_AFTER_CHUNK_GZIP_SIZE);
+		if (appConfig.single) console.log(`打包完成，可以使用 ${chalk.green("@qse/ssh-sftp")} 自动部署代码到 v1`);
+		else console.log(`打包完成，可以运行 ${chalk.green("npx edu-scripts deploy")} 部署代码到 v1`);
+		console.log();
 		console.log(stats.toString({
 			colors: true,
 			preset: "errors-warnings",
 			timings: true
 		}));
-		printFileSizesAfterBuild(stats, previousSizeMap, paths.dist, WARN_AFTER_BUNDLE_GZIP_SIZE, WARN_AFTER_CHUNK_GZIP_SIZE);
-		if (appConfig.single) console.log(`打包完成，可以使用 ${chalk.green("@qse/ssh-sftp")} 自动部署代码到 v1`);
-		else console.log(`打包完成，可以运行 ${chalk.green("npx edu-scripts deploy")} 部署代码到 v1`);
 		console.log();
 	});
 }

package/dist/index.d.mts

@@ -71,6 +71,13 @@ type Configuration$2 = {
    * @default [{libraryName: 'lodash',libraryDirectory: '',camelToDashComponentName: false}]
    */
   import?: NonNullable<SwcLoaderOptions['rspackExperiments']>['import'];
+  /**
+   * 该选项可以开启 Rspack 构建过程中对快照及中间产物的缓存，可以使用它们来提升构建的速度。\
+   * 这会增加磁盘空间的使用，但能显著提升构建性能，特别是在大型项目中。建议在开发环境中开启，在生产环境中根据需要选择是否开启。\
+   * 项目会自动清理7天未使用的缓存文件，确保磁盘空间不会被过度占用。
+   * @default false
+   */
+  cache?: boolean;
 };
 declare function defineConfig(config: Configuration$2): Configuration$2;
 //#endregion

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qse/edu-scripts",
-  "version": "2.0.2",
+  "version": "2.0.3",
   "author": "Kinoko",
   "license": "MIT",
   "type": "module",

package/src/build.ts

@@ -53,8 +53,6 @@ export default async function build(args: BuildArgs) {
       process.exit(1)
     }
 
-    console.log(stats.toString({ colors: true, preset: 'errors-warnings', timings: true }))
-
     printFileSizesAfterBuild(
       stats,
       previousSizeMap,
@@ -69,5 +67,7 @@ export default async function build(args: BuildArgs) {
       console.log(`打包完成，可以运行 ${chalk.green('npx edu-scripts deploy')} 部署代码到 v1`)
     }
     console.log()
+    console.log(stats.toString({ colors: true, preset: 'errors-warnings', timings: true }))
+    console.log()
   })
 }

package/src/config/paths.ts

@@ -20,18 +20,19 @@ function resolveOwn(...filePath: string[]) {
   return path.resolve(current, ...filePath)
 }
 
+function resolveExistPaths(...paths: string[]) {
+  return paths.filter((p) => fs.existsSync(p))
+}
+
 function getExistPath(...paths: string[]) {
-  for (const path of paths) {
-    if (fs.existsSync(path)) {
-      return path
-    }
-  }
-  return paths[0]
+  const existPaths = resolveExistPaths(...paths)
+  return existPaths[0] || paths[0]
 }
 
 const paths = {
   resolveApp,
   resolveOwn,
+  resolveExistPaths,
   eduAppEnv: resolveApp('src', 'edu-app-env.d.ts'),
   dist: resolveApp('dist'),
   sshSftp: resolveApp('.sftprc.json'),
@@ -41,7 +42,10 @@ const paths = {
   package: resolveApp('package.json'),
   tailwind: resolveApp('tailwind.config.js'),
   pages: resolveApp('src', 'pages'),
-  override: getExistPath(resolveApp('edu-scripts.override.js'), resolveApp('edu-scripts.override.ts')),
+  override: getExistPath(
+    resolveApp('edu-scripts.override.js'),
+    resolveApp('edu-scripts.override.ts')
+  ),
   indexHTML: globbySync('./public/*.html', { absolute: true }),
   src: resolveApp('src'),
   public: resolveApp('public'),

package/src/config/webpackConfig.ts

@@ -12,6 +12,7 @@ import appConfig from '../utils/appConfig'
 import type { Configuration as CustomConfiguration } from '../utils/defineConfig'
 import paths from './paths'
 import PostcssSafeAreaPlugin from './plugins/postcss-safe-area'
+import { fileURLToPath } from 'node:url'
 
 const require = createRequire(import.meta.url)
 const appPkg = fs.readJsonSync(paths.package) as { name: string; version: string }
@@ -75,6 +76,32 @@ interface CSSLoaderOptions {
   }
 }
 
+interface DllManifest {
+  name: string
+  content: Record<string, { id: number | string }>
+}
+
+function getPnpmCompatibleDllManifest(manifestPath: string): DllManifest {
+  const manifest = fs.readJsonSync(manifestPath) as DllManifest
+  const normalizedContent = { ...manifest.content }
+
+  for (const [key, value] of Object.entries(manifest.content)) {
+    if (!key.startsWith('./node_modules/')) continue
+
+    const request = key.replace('./node_modules/', '')
+    try {
+      const resolvedPath = require.resolve(request)
+      const relativePath = `./${path.relative(process.cwd(), resolvedPath).replace(/\\/g, '/')}`
+
+      if (!normalizedContent[relativePath]) {
+        normalizedContent[relativePath] = value
+      }
+    } catch {}
+  }
+
+  return { ...manifest, content: normalizedContent }
+}
+
 export default function getWebpackConfig(args: any, override: CustomConfiguration): Configuration {
   const isDev = process.env.NODE_ENV === 'development'
   const isProd = process.env.NODE_ENV === 'production'
@@ -143,7 +170,7 @@ export default function getWebpackConfig(args: any, override: CustomConfiguratio
 
   const config: Configuration = {
     context: process.cwd(),
-    mode: process.env.NODE_ENV as 'development' | 'production' | 'none',
+    mode: process.env.NODE_ENV as 'development' | 'production',
     entry: './src/index',
     target: 'browserslist',
     output: {
@@ -155,6 +182,7 @@ export default function getWebpackConfig(args: any, override: CustomConfiguratio
       uniqueName: appPkg.name,
       publicPath: '',
     },
+    name: appPkg.name,
     externals: Object.assign(
       {},
       qseCDN.isUseCommon && {
@@ -407,7 +435,9 @@ export default function getWebpackConfig(args: any, override: CustomConfiguratio
     plugins: [
       qseCDN.isUseCommon &&
         new rspack.DllReferencePlugin({
-          manifest: fs.readJsonSync(paths.resolveOwn('asset', 'dll', 'libcommon3-manifest.json')),
+          manifest: getPnpmCompatibleDllManifest(
+            paths.resolveOwn('asset', 'dll', 'libcommon3-manifest.json')
+          ),
         }),
       new rspack.NormalModuleReplacementPlugin(
         /@rspack\/dev-server\/client\/index\.js/,
@@ -505,5 +535,21 @@ export default function getWebpackConfig(args: any, override: CustomConfiguratio
     },
   }
 
+  if (override.cache) {
+    config.cache = true
+    config.experiments = {
+      ...config.experiments,
+      cache: {
+        type: 'persistent',
+        buildDependencies: paths.resolveExistPaths(
+          fileURLToPath(import.meta.url),
+          paths.package,
+          paths.tsconfig,
+          paths.override
+        ),
+      },
+    }
+  }
+
   return config
 }

package/src/utils/defineConfig.ts

@@ -75,6 +75,14 @@ export type Configuration = {
    * @default [{libraryName: 'lodash',libraryDirectory: '',camelToDashComponentName: false}]
    */
   import?: NonNullable<SwcLoaderOptions['rspackExperiments']>['import']
+
+  /**
+   * 该选项可以开启 Rspack 构建过程中对快照及中间产物的缓存，可以使用它们来提升构建的速度。\
+   * 这会增加磁盘空间的使用，但能显著提升构建性能，特别是在大型项目中。建议在开发环境中开启，在生产环境中根据需要选择是否开启。\
+   * 项目会自动清理7天未使用的缓存文件，确保磁盘空间不会被过度占用。
+   * @default false
+   */
+  cache?: boolean
 }
 export function defineConfig(config: Configuration) {
   return config

package/src/utils/getOverride.ts

@@ -14,6 +14,28 @@ const defaultOverride: Configuration = {
   pure_funcs: ['console.log'],
 }
 
+function migrateOverride(override: Configuration) {
+  // 迁移提示 v1 -> v2，后续版本会删除这些废弃的配置项
+  if ('transformNodeModules' in override) {
+    console.warn('transformNodeModules 配置已废弃，请删除这个配置项')
+  }
+
+  if ('minifyImage' in override) {
+    console.warn('minifyImage 配置已废弃，请删除这个配置项')
+  }
+
+  if (typeof override.minify !== 'boolean') {
+    console.warn('minify 类型错误，请使用boolean类型，已自动设置为 true')
+    override.minify = true
+  }
+
+  if ('babel' in override) {
+    throw new Error(
+      'babel 配置已废弃，请删除这个配置项。如果有 babel-plugin-import 相关的配置，请直接使用 import 选项'
+    )
+  }
+}
+
 let override: Configuration | null = null
 
 export default function getOverride(): Configuration {
@@ -26,6 +48,8 @@ export default function getOverride(): Configuration {
     if (typeof userOverride !== 'object')
       throw new Error('格式错误，请使用 npx edu g override 生成文件')
     Object.assign(override, userOverride)
+
+    migrateOverride(override)
   }
 
   return override