@seayoo-web/scripts 2.9.0 → 3.0.0

package/dist/index.js

@@ -157,24 +157,21 @@ function htmlInjectPlugin(data) {
     name: "html-inject-plugin",
     transformIndexHtml: {
       order: "pre",
-      handler: (html) => html.replace(/%\s*(.*?)\s*%/g, (match, p1) => data[p1] ?? match).replace(/`{{\s*(.*?)\s*}}`/g, (match, p1) => data[p1] ?? match).replace(/[\r\n]{2,}/g, "\n").replace(/(?:^[\s\r\n]*|[\s\r\n]*$)/g, "")
+      handler: function(html) {
+        return html.replace(/%\s*(.*?)\s*%/g, (match, p1) => data[p1] ?? match).replace(/`{{\s*(.*?)\s*}}`/g, (match, p1) => data[p1] ?? match).replace(/[\r\n]{2,}/g, "\n").replace(/(?:^[\s\r\n]*|[\s\r\n]*$)/g, "");
+      }
     }
   };
 }
 function definePageBuildConfig(option) {
   const {
-    notVuePage,
-    noPolyfill,
-    requireSentryToken,
-    ignoreSentryToken,
-    manualChunks,
-    badPackages = [],
+    preset = {},
     plugins = [],
     build = {},
     resolve = {},
     server = {},
     sentry = {},
-    envTransform,
+    envTransformer,
     base,
     ...optionReset
   } = option || {};
@@ -184,7 +181,7 @@ function definePageBuildConfig(option) {
     delete server.port;
   }
   return async function({ command, mode }) {
-    const envs = getBuildEnv(command, mode, requireSentryToken, ignoreSentryToken);
+    const envs = getBuildEnv(command, mode, sentry.required, sentry.ignore);
     const justBuild = mode === "build";
     const gitInfo = justBuild ? null : await getCommitInfo(command, mode, envs.page, envs.deployTo || "");
     const isProductMode = mode === "production" || mode === "prod" || mode === "prd";
@@ -203,22 +200,17 @@ function definePageBuildConfig(option) {
       }
       process.exit(0);
     }
-    if (envTransform) {
-      envs.viteEnvs = await envTransform(envs.viteEnvs, command, mode);
+    if (envTransformer) {
+      envs.viteEnvs = await envTransformer(envs.viteEnvs, command, mode);
     }
     const trunkMap = {
       "naive-ui": "naive-ui",
       html2canvas: "html2canvas",
       swiper: "swiper",
-      ...manualChunks
-    };
-    const trunkKeys = Object.keys(trunkMap);
-    const trunkFn = function(id) {
-      const k = trunkKeys.find((k2) => id.includes(k2));
-      if (k) return trunkMap[k];
+      ...preset.manualChunks
     };
-    const ignoreSideEffects = ["thinkingdata", "@esotericsoftware/spine", ...badPackages];
-    const baseValue = typeof base === "function" ? base(mode, envs.viteEnvs) || "./" : typeof base === "object" && base ? base[mode] : typeof base === "string" ? base : "./";
+    const ignoreSideEffects = ["thinkingdata", "@esotericsoftware/spine", ...preset.badPackages || []];
+    const baseValue = typeof base === "function" ? base(mode, envs.viteEnvs) : typeof base === "object" && base ? base[mode] : typeof base === "string" ? base : "./";
     if (baseValue === void 0 && mode !== "development") {
       console.warn(`base 参数在模式（${mode}）下未设置内容`.red);
       process.exit(1);
@@ -240,15 +232,17 @@ function definePageBuildConfig(option) {
           },
           ...build.rollupOptions,
           output: {
-            manualChunks: trunkFn,
+            manualChunks: function(id) {
+              const k = Object.keys(trunkMap).find((k2) => id.includes(k2));
+              if (k) return trunkMap[k];
+            },
             ...build.rollupOptions?.output
           }
         }
       },
       plugins: [
-        notVuePage ? null : vue(),
-        // notVuePage ? null : vueDevTools(),
-        noPolyfill ? null : legacy({
+        preset.ignoreVuePlugin ? null : vue(),
+        preset.ignorePolyfill ? null : legacy({
           targets: ["defaults", "> 0.1%", "last 5 versions and not dead"],
           // https://github.com/vitejs/vite/blob/main/packages/plugin-legacy/src/index.ts#L170
           // https://unpkg.com/browse/core-js@3.41.0/
@@ -285,6 +279,9 @@ function definePageBuildConfig(option) {
           debug: envs.deployDebug,
           preview: option?.finder?.preview ?? true,
           commitLogs: isProductMode && gitInfo.logs.length > 0 ? "\n" + gitInfo.logs.join("\n") : void 0,
+          onBeforeDeploy: option?.finder?.beforeDeploy ? async function(dist) {
+            await option?.finder?.beforeDeploy?.(dist, envs.viteEnvs);
+          } : void 0,
           onFinished() {
             if (isProductMode) {
               createPageDeployTag(envs.page, envs.deployTo || "", envs.deployUser);
@@ -294,7 +291,7 @@ function definePageBuildConfig(option) {
         command === "build" && envs.sentryAuthToken && !justBuild ? sentryVitePlugin({
           authToken: envs.sentryAuthToken,
           org: sentry.org || "sentry",
-          url: sentry.url || "https://sentry.seayoo.com/",
+          url: sentry.url || "https://sentry.seayoo.com",
           project: sentry.project || "gamer-fe"
         }) : null,
         justBuild ? visualizer() : null

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seayoo-web/scripts",
-  "version": "2.9.0",
+  "version": "3.0.0",
   "description": "scripts for seayoo web repos",
   "type": "module",
   "source": "index.ts",
@@ -33,11 +33,11 @@
     "access": "public"
   },
   "dependencies": {
-    "@sentry/vite-plugin": "^3.3.1",
-    "@vitejs/plugin-legacy": "^7.0.0",
-    "@vitejs/plugin-vue": "^6.0.0",
+    "@sentry/vite-plugin": "^4.0.2",
+    "@vitejs/plugin-legacy": "^7.1.0",
+    "@vitejs/plugin-vue": "^6.0.1",
     "@vue/eslint-config-prettier": "^10.2.0",
-    "@vue/eslint-config-typescript": "^14.5.0",
+    "@vue/eslint-config-typescript": "^14.6.0",
     "chokidar": "^4.0.3",
     "colors": "^1.4.0",
     "commander": "^13.1.0",
@@ -50,10 +50,10 @@
     "ora": "^8.2.0",
     "postcss-html": "^1.8.0",
     "rollup-plugin-visualizer": "^6.0.3",
+    "stylelint-order": "^7.0.0",
     "terser": "^5.43.1",
     "vite-plugin-stylelint": "^6.0.2",
-    "stylelint-order": "^7.0.0",
-    "@seayoo-web/finder": "^2.1.1"
+    "@seayoo-web/finder": "^2.2.0"
   },
   "devDependencies": {
     "@types/fs-extra": "^11.0.4",

package/types/src/inject.d.ts

@@ -4,7 +4,7 @@
 export declare function htmlInjectPlugin(data: Record<string, string>): {
     name: string;
     transformIndexHtml: {
-        order: string;
+        order: "pre";
         handler: (html: string) => string;
     };
 };

package/types/src/vite.page.d.ts

@@ -1,21 +1,55 @@
 import type { UserConfig, UserConfigFnPromise } from "vite";
 interface ExternalConfig {
-    /** 设置base路径，支持配置多组 base，以 mode 为key */
-    base?: string | Record<string, string> | ((mode: string, env: Record<string, string>) => string);
-    /** 是否不使用 vue */
-    notVuePage?: boolean;
-    /** 是否不加载 polyfill */
-    noPolyfill?: boolean;
+    /**
+     * 动态修改环境变量
+     */
+    envTransformer?: (envs: Record<string, string>, command: "build" | "serve", mode: string) => Promise<Record<string, string>> | Record<string, string>;
+    /**
+     * 设置base路径，支持配置多组 base(以 mode 为 key) 或自定义函数返回 base
+     */
+    base?: string | Record<string, string> | ((mode: string, envs: Record<string, string>) => string);
+    /**
+     * 功能预设配置
+     */
+    preset?: {
+        /**
+         * 忽略 vue 插件
+         */
+        ignoreVuePlugin?: boolean;
+        /**
+         * 是否忽略 polyfill
+         */
+        ignorePolyfill?: boolean;
+        /**
+         * 指定哪些不够友好的包，这些包的 iife 或修改全局 windows 变量的行为导致默认 tree-shaking 策略失效
+         *
+         * 从而这些包被误打入最终的产物中，无谓增加了包的体积。默认 `thinkingdata` 和 `@esotericsoftware/spine`
+         */
+        badPackages?: string[];
+        /**
+         * 手工指定 trunk 合并策略，Record<key, chunk>，即 id.include(key) 则打到 trunk 中
+         *
+         * 默认 {`naive-ui`, `html2canvas`, `swiper`}
+         *
+         * 设置的值会跟默认值进行合并。
+         *
+         * 也可以手工设定 `build.rollupOptions.output.manualChunks` 来自定义
+         */
+        manualChunks?: Record<string, string>;
+    };
     /** sentry 配置 */
     sentry?: {
+        /** 默认 `gamer-fe` */
         project?: string;
+        /** 默认 `https://sentry.seayoo.com` */
         url?: string;
+        /** 默认 `sentry` */
         org?: string;
+        /** 是否强制要求提供 sentryToken，优先级高于 ignore  */
+        required?: boolean;
+        /** 是否忽略 sentryToken 设置 */
+        ignore?: boolean;
     };
-    /** 是否强制要求提供 sentryToken */
-    requireSentryToken?: boolean;
-    /** 是否忽略 sentryToken 设置 */
-    ignoreSentryToken?: boolean;
     /** finder 配置 */
     finder?: {
         /**
@@ -28,27 +62,11 @@ interface ExternalConfig {
          * 匹配时仅针对单一目录和文件名进行检查，不跨目录检查
          */
         ignoreFiles?: string[];
+        /**
+         * 在部署文件前调用，用以调整产物文件
+         */
+        beforeDeploy?: (distDir: string, envs: Record<string, string>) => unknown;
     };
-    /**
-     * 手工指定 trunk 合并策略，Record<key, chunk>，即 id.include(key) 则打到 trunk 中
-     *
-     * 默认 {`naive-ui`, `html2canvas`, `swiper`}
-     *
-     * 设置的值会跟默认值进行合并。
-     *
-     * 也可以手工设定 `build.rollupOptions.output.manualChunks` 来自定义
-     */
-    manualChunks?: Record<string, string>;
-    /**
-     * 指定哪些不够友好的包，这些包的 iife 或修改全局 windows 变量的行为导致默认 tree-shaking 策略失效
-     *
-     * 从而这些包被误打入最终的产物中，无谓增加了包的体积。默认 `thinkingdata` 和 `@esotericsoftware/spine`
-     */
-    badPackages?: string[];
-    /**
-     * 动态修改环境变量
-     */
-    envTransform?: (env: Record<string, string>, command: "build" | "serve", mode: string) => Promise<Record<string, string>> | Record<string, string>;
 }
 /**
  * 导出一个动态的配置工厂函数