paas-build-package 0.0.1

package/packages/build/src/vite/vite-config/vite-pkg-dev-config.ts

@@ -0,0 +1,123 @@
+import { defineConfig, UserConfig, PluginOption } from 'vite';
+import path from 'path';
+import * as rf from 'rimraf';
+import vue from '@vitejs/plugin-vue';
+import vueJsx from '@vitejs/plugin-vue-jsx';
+import { libInjectCss } from 'vite-plugin-lib-inject-css';
+import { viteStaticCopy } from 'vite-plugin-static-copy';
+import dts from 'vite-plugin-dts';
+import { readFileSync, existsSync } from 'fs';
+// import UnoCSS from 'unocss/vite';
+import { mergeConfig, IS_NODE_MODULE } from '../../util';
+import { DEFAULT_EXTERNAL } from '../../constants';
+
+/**
+ * pkg 包开发编译 vite 配置
+ *
+ * @export
+ * @param {UserConfig} [opts={}]
+ * @return {*}  {UserConfig}
+ */
+export function definePkgDevViteConfig(opts: UserConfig = {}): UserConfig {
+  // 当前脚本执行的工作目录
+  const cwd = process.cwd();
+  // 编译文件输出目录
+  const outDir = path.resolve(cwd, 'es');
+  // 删除历史编译文件
+  rf.sync(outDir);
+
+  // 是否为开发模式启动
+  const isDev = process.env.NODE_ENV === 'development';
+
+  // 读取 package.json 中的 dependencies
+  let pkgDependencies: string[] = [];
+  try {
+    const pkgJsonPath = path.resolve(cwd, 'package.json');
+    const pkgJson = JSON.parse(readFileSync(pkgJsonPath, 'utf-8'));
+    pkgDependencies = Object.keys(pkgJson.dependencies || {});
+  } catch (error) {
+    console.warn('Failed to read package.json dependencies:', error);
+  }
+
+  return mergeConfig<UserConfig, UserConfig>(
+    defineConfig({
+      css: {
+        preprocessorOptions: {
+          scss: {
+            additionalData: `@use "@gct-paas/scss/style/global.scss" as *;`,
+          },
+        },
+      },
+      build: {
+        outDir,
+        target: 'esnext',
+        minify: false,
+        sourcemap: isDev,
+        rolldownOptions: {
+          external: (id: string) => {
+            // 排除 package.json 中声明的所有依赖
+            if (
+              pkgDependencies.some(
+                dep => id === dep || id.startsWith(dep + '/'),
+              )
+            ) {
+              return true;
+            }
+            // 排除 node_modules 下的模块
+            if (IS_NODE_MODULE.test(id)) {
+              return true;
+            }
+            // 排除基础组件包
+            if (DEFAULT_EXTERNAL.includes(id)) {
+              return true;
+            }
+            return false;
+          },
+          output: {
+            preserveModules: true,
+            entryFileNames: ({ name }) => `${name}.mjs`,
+            assetFileNames: '[name][extname]', // 样式文件保留原名
+          },
+        },
+        lib: {
+          entry: path.resolve(process.cwd(), 'src/index.ts'),
+          formats: ['es'],
+        },
+      },
+      plugins: [
+        vue() as PluginOption,
+        vueJsx() as PluginOption,
+        // UnoCSS({ hmrTopLevelAwait: false }) as PluginOption,
+        libInjectCss(),
+        dts({
+          outDir: [outDir],
+          compilerOptions: {
+            declarationMap: isDev,
+          },
+          // 排除测试目录，以及测试文件
+          exclude: [
+            '**/test/**',
+            '**/*.test.ts',
+            '**/*.test.tsx',
+            '**/*.spec.ts',
+            '**/*.spec.tsx',
+          ],
+        }),
+        ...(existsSync(path.resolve(cwd, 'src/types'))
+          ? [
+              viteStaticCopy({
+                targets: [
+                  {
+                    // 将 src/types 目录下的文件复制到编译输出目录
+                    src: 'src/types',
+                    dest: '.',
+                  },
+                ],
+              }),
+            ]
+          : []),
+      ],
+    }),
+    opts,
+  );
+}

package/packages/build/src/vite/vite-config/vite-plugin-config.ts

@@ -0,0 +1,149 @@
+import { mergeConfig, UserConfig } from 'vite';
+import path from 'path';
+// import { federation } from '@module-federation/vite';
+import { defineViteBaseConfig } from './vite-base-config';
+import { DEFAULT_EXTERNAL } from '../../constants';
+import { importMapExternalPlugin } from '../vite-plugins/imnport-external-plugin';
+
+/**
+ * 插件构建配置
+ *
+ * @export
+ * @param {UserConfig} [opts={}]
+ * @return {*}  {UserConfig}
+ */
+export function definePluginViteConfig(opts: UserConfig = {}): UserConfig {
+  // 当前脚本执行的工作目录
+  const cwd = process.cwd();
+  // 设计界面插件打包入口文件
+  const entry = path.resolve(cwd, 'src/index.ts');
+  // 封装样式加载的 loader 模块打包入口文件
+  const loaderEntry = path.resolve(cwd, 'src/loader.ts');
+  // 是否生产模式
+  const isProd = process.env.NODE_ENV === 'production';
+
+  return mergeConfig<UserConfig, UserConfig>(
+    defineViteBaseConfig({
+      optimizeDeps: {
+        exclude: DEFAULT_EXTERNAL,
+      },
+      build: {
+        minify: isProd ? 'terser' : false,
+        terserOptions: {
+          // 压缩选项，控制代码压缩行为
+          compress: {
+            // 是否移除 console.* 调用；false 表示保留，避免生产环境丢失重要日志
+            drop_console: false,
+            // 是否移除永远不会执行的死代码（如 if(false){...}）
+            dead_code: true,
+            // 是否移除未被引用的变量和函数，减小产物体积
+            unused: true,
+            // 压缩算法的执行轮数；多轮压缩可以发现单轮无法消除的冗余代码，但会增加构建耗时
+            passes: 2,
+          },
+          // 是否混淆变量名、函数名等标识符，使产物更难以阅读反编译，同时进一步缩小体积
+          mangle: true,
+        },
+        lib: {
+          entry: isProd ? loaderEntry : entry,
+          formats: ['es'],
+          cssFileName: 'index.min',
+          fileName: '[name].[format].min',
+        },
+      },
+      plugins: [
+        ...importMapExternalPlugin(DEFAULT_EXTERNAL),
+        // federation({
+        //   name: 'gct-paas-plugin',
+        //   filename: 'remoteEntry.js',
+        //   dts: false,
+        //   manifest: true,
+        //   exposes: {
+        //     '.': './src/index.ts',
+        //   },
+        // }),
+      ],
+    }),
+    opts,
+  );
+}
+
+/**
+ * 设计界面插件构建配置
+ *
+ * @export
+ * @param {UserConfig} [opts={}]
+ * @return {*}  {UserConfig}
+ */
+export function defineDesignPluginViteConfig(opts: UserConfig = {}): UserConfig {
+  return mergeConfig<UserConfig, UserConfig>(
+    definePluginViteConfig({
+      server: {
+        port: 7001,
+        host: '0.0.0.0',
+        allowedHosts: true,
+      },
+    }),
+    opts,
+  );
+}
+
+/**
+ * 设计界面插件构建配置
+ *
+ * @export
+ * @param {UserConfig} [opts={}]
+ * @return {*}  {UserConfig}
+ */
+export function defineMobilePluginViteConfig(opts: UserConfig = {}): UserConfig {
+  return mergeConfig<UserConfig, UserConfig>(
+    definePluginViteConfig({
+      server: {
+        port: 7002,
+        host: '0.0.0.0',
+        allowedHosts: true,
+      },
+    }),
+    opts,
+  );
+}
+
+/**
+ * 设计界面插件构建配置
+ *
+ * @export
+ * @param {UserConfig} [opts={}]
+ * @return {*}  {UserConfig}
+ */
+export function definePadPluginViteConfig(opts: UserConfig = {}): UserConfig {
+  return mergeConfig<UserConfig, UserConfig>(
+    definePluginViteConfig({
+      server: {
+        port: 7003,
+        host: '0.0.0.0',
+        allowedHosts: true,
+      },
+    }),
+    opts,
+  );
+}
+
+/**
+ * 设计界面插件构建配置
+ *
+ * @export
+ * @param {UserConfig} [opts={}]
+ * @return {*}  {UserConfig}
+ */
+export function defineWebPluginViteConfig(opts: UserConfig = {}): UserConfig {
+  return mergeConfig<UserConfig, UserConfig>(
+    definePluginViteConfig({
+      server: {
+        port: 7004,
+        host: '0.0.0.0',
+        allowedHosts: true,
+      },
+    }),
+    opts,
+  );
+}

package/packages/build/src/vite/vite-config/vite-project-config.ts

@@ -0,0 +1,82 @@
+import {
+  defineConfig,
+  PluginOption,
+  UserConfig,
+  UserConfigFnPromise,
+} from 'vite';
+import vue from '@vitejs/plugin-vue';
+import vueJsx from '@vitejs/plugin-vue-jsx';
+import UnoCSS from 'unocss/vite';
+import path from 'path';
+import fse from 'fs-extra';
+import { mergeConfig } from '../../util';
+import { DEFAULT_EXTERNAL } from '../../constants';
+import { injectImportMapPlugin } from '../vite-plugins/inject-importmap-plugin';
+
+/**
+ * 构建本地开发 project 项目 vite 通用配置，基于此配置构建其他 vite 配置
+ * 参数合并时，数组会被合并而不是被替换
+ *
+ * @author chitanda
+ * @date 2025-08-24 11:08:04
+ * @export
+ * @param {UserConfig} [opts={}]
+ * @returns {*}  {Promise<UserConfig>}
+ */
+export function defineProjectViteConfig(
+  opts: UserConfig = {},
+): UserConfigFnPromise {
+  return defineConfig(async () => {
+    // 获取当前工作目录
+    const cwd = process.cwd();
+    // 获取工作目录 package.json 文件内容
+    const pkg = fse.readJsonSync(path.resolve(cwd, 'package.json'));
+
+    return mergeConfig<UserConfig, UserConfig>(
+      {
+        resolve: {
+          alias: {
+            '@/*': 'src/*',
+          }
+        },
+        base: './',
+        build: {
+          rolldownOptions: {
+            external: DEFAULT_EXTERNAL,
+          },
+        },
+        css: {
+          preprocessorOptions: {
+            scss: {
+              additionalData: `@use "@gct-paas/scss/style/global.scss" as *;`,
+            },
+          },
+        },
+        server: {
+          host: '0.0.0.0',
+          allowedHosts: true,
+          cors: true,
+          fs: {
+            strict: false,
+          },
+          proxy: {
+            hostname: '0.0.0.0',
+          },
+        },
+        define: {
+          'import.meta.env.pkg': {
+            name: pkg.name,
+            version: pkg.version,
+          },
+        },
+        plugins: [
+          vue() as PluginOption,
+          vueJsx() as PluginOption,
+          UnoCSS({ hmrTopLevelAwait: false }) as PluginOption,
+          injectImportMapPlugin() as PluginOption,
+        ],
+      },
+      opts,
+    );
+  });
+}

package/packages/build/src/vite/vite-plugins/imnport-external-plugin.ts

@@ -0,0 +1,21 @@
+/**
+ * 在 dev 模式下：告诉 Rollup/Rolldown 指定模块是 external
+ *
+ * @export
+ * @param {string[]} modules
+ * @return {*} 
+ */
+export function importMapExternalPlugin(modules: string[]) {
+  return [
+    {
+      name: 'gct-vite-plugin:import-external',
+      apply: 'serve' as const,
+      enforce: 'pre' as const,
+      resolveId(id: string) {
+        if (modules.includes(id)) {
+          return { id, external: true };
+        }
+      },
+    },
+  ];
+}

package/packages/build/src/vite/vite-plugins/inject-importmap-plugin.ts

@@ -0,0 +1,133 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import { simpleGit } from 'simple-git';
+import type { Plugin, HtmlTagDescriptor } from 'vite';
+import { isBuildPluginEnv } from '../../util';
+
+export interface InjectImportMapPluginOptions {
+  /**
+   * 仓库地址，默认为 https://git.gct-china.com/paas/frontend/gct-paas-cdn.git
+   */
+  repoUrl?: string;
+  /**
+   * 需要读取的文件路径，默认为 extras/import-map.json
+   */
+  filePath?: string;
+  /**
+   * 指定分支，若未指定则自动获取当前主工程对应的分支
+   */
+  branch?: string;
+}
+
+// importMap 开发态前缀路径
+const DEV_IMPORT_MAP_PREFIX: string[] = ['/plugin-kit/@id/', '/plugin-design/@id/', '/plugin-render-mobile/@id/', '/plugin-render-pad/@id/', '/plugin-render-web/@id/'];
+
+/**
+ * 编译时读取并注入 import-map 配置的插件
+ */
+export function injectImportMapPlugin(options: InjectImportMapPluginOptions = {}): Plugin {
+  const {
+    repoUrl = 'https://git.gct-china.com/paas/frontend/gct-paas-cdn.git',
+    filePath = 'extras/import-map.json',
+  } = options;
+
+  let importMapContent = '{}';
+
+  return {
+    name: 'gct-vite-plugin:inject-importmap',
+    apply: 'build',
+    async buildStart() {
+      const cwd = process.cwd();
+      let targetBranch = options.branch;
+
+      // 1. 如果未传 branch，则获取当前工作区的 branch
+      if (!targetBranch) {
+        // CI 环境（如 GitLab CI）会设置标准环境变量，优先使用
+        targetBranch = process.env.CI_COMMIT_BRANCH || process.env.CI_BUILD_REF_NAME;
+
+        if (!targetBranch) {
+          const cwdGit = simpleGit(cwd);
+          try {
+            const raw = await cwdGit.revparse(['--abbrev-ref', 'HEAD']);
+            const resolved = raw.trim();
+            // 游离 HEAD 状态（detached HEAD）下返回字面量 "HEAD"，分支名无效
+            if (resolved && resolved !== 'HEAD') {
+              targetBranch = resolved;
+            }
+          } catch {
+            // 忽略，下方统一处理
+          }
+        }
+
+        if (!targetBranch) {
+          this.error(
+            '无法自动获取当前 git 分支：当前可能处于游离 HEAD（detached HEAD）状态（CI 环境常见）。' +
+            '请通过 options.branch 明确指定分支名，或确保环境变量 CI_COMMIT_BRANCH / CI_BUILD_REF_NAME 已设置。',
+          );
+        }
+      }
+
+      // 2. 准备缓存目录，使用 sparse checkout 减少体积
+      const cacheDir = path.resolve(cwd, 'node_modules/.gct/cache/importmap-repo-cache');
+
+      try {
+        if (!fs.existsSync(cacheDir)) {
+          fs.mkdirSync(cacheDir, { recursive: true });
+          const git = simpleGit(cacheDir);
+          await git.init();
+          await git.addRemote('origin', repoUrl);
+          await git.raw(['config', 'core.sparseCheckout', 'true']);
+          // 写入需要拉取的单一文件到 sparse-checkout 配置中
+          fs.writeFileSync(path.join(cacheDir, '.git/info/sparse-checkout'), filePath);
+        }
+
+        // 3. 每次执行都进行 fetch 确保拿到最新文件
+        const git = simpleGit(cacheDir);
+        // 重置 origin，防止 url 变更或者后期添加 token 等
+        await git.remote(['set-url', 'origin', repoUrl]);
+        // 浅拉取对应分支，depth=1
+        await git.fetch('origin', targetBranch!, { '--depth': 1 });
+        // 强制重置工作区到远程最新的快照，丢弃并覆盖过期内容
+        await git.reset(['--hard', `origin/${targetBranch}`]);
+
+        // 4. 读取文件并验证 JSON
+        const targetFilePath = path.join(cacheDir, filePath);
+        if (!fs.existsSync(targetFilePath)) {
+          this.error(`在仓库 ${repoUrl} 的 ${targetBranch} 分支中，未找到文件: ${filePath}。`);
+        }
+
+        const rawContent = fs.readFileSync(targetFilePath, 'utf-8');
+        try {
+          // 验证并过滤格式
+          const parsed = JSON.parse(rawContent);
+          // 补充开发态前缀路径，确保本地调试时能够正确解析模块
+          if (isBuildPluginEnv() && parsed.imports) {
+            const keys = Object.keys(parsed.imports);
+            DEV_IMPORT_MAP_PREFIX.forEach(prefix => {
+              keys.forEach(key => {
+                const val = parsed.imports[key];
+                parsed.imports[prefix + key] = val;
+              });
+            });
+          }
+          importMapContent = JSON.stringify(parsed);
+        } catch (parseError) {
+          this.error(`目标文件 ${filePath} 包含非法的 JSON 格式: ${parseError}`);
+        }
+      } catch (error) {
+        this.error(`从 Git 仓库拉取或读取 import-map.json 时发生错误: ${error}`);
+      }
+    },
+
+    transformIndexHtml(): HtmlTagDescriptor[] {
+      return [
+        {
+          tag: 'script',
+          attrs: { type: 'importmap' },
+          injectTo: 'head-prepend',
+          children: importMapContent,
+        },
+      ];
+    },
+  };
+}

package/packages/build/tsconfig.json

@@ -0,0 +1,32 @@
+{
+  "compilerOptions": {
+    "module": "esnext",
+    "target": "esnext",
+    "lib": [
+      "ES2022"
+    ],
+    "moduleResolution": "bundler",
+    "noEmit": true,
+    "allowImportingTsExtensions": true,
+    "sourceMap": false,
+    "declaration": true,
+    "declarationMap": true,
+    "strict": true,
+    "skipDefaultLibCheck": true,
+    "skipLibCheck": true,
+    "experimentalDecorators": true,
+    "esModuleInterop": true,
+    "resolveJsonModule": true,
+    "forceConsistentCasingInFileNames": true,
+    "rootDir": "src",
+    "outDir": "dist",
+    "types": ["./src/types"]
+  },
+  "include": [
+    "src/**/*.ts"
+  ],
+  "exclude": [
+    "node_modules",
+    "test"
+  ]
+}

package/packages/cli/CHANGELOG.md

@@ -0,0 +1,20 @@
+# 版本变更日志
+
+这个项目的所有关键变化都将记录在此文件中.
+
+此日志格式基于 [Keep a Changelog](https://keepachangelog.com/zh-CN/1.1.0/),
+并且此项目遵循 [Semantic Versioning](https://semver.org/lang/zh-CN/).
+
+## [Unreleased]
+
+## [0.1.3] - 2025-06-16
+
+### Added
+
+- 新增对 ResponseEntity«List«Tree«string»»»、ResponseEntity«PageBase«AgentResponse»» 类似类型的处理
+
+## [0.0.1] - 2025-01-07
+
+### Added
+
+- 初始化项目.

package/packages/cli/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 冠骋信息技术有限公司
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/packages/cli/README.md

@@ -0,0 +1 @@
+

package/packages/cli/build.config.ts

@@ -0,0 +1,22 @@
+import { defineBuildConfig } from 'unbuild';
+
+export default defineBuildConfig({
+  entries: [
+    {
+      builder: 'mkdist',
+      input: './src/',
+      outDir: './es',
+      format: 'esm',
+      ext: 'mjs',
+    },
+    {
+      builder: 'mkdist',
+      input: './src/',
+      outDir: './dist',
+      format: 'cjs',
+      ext: 'cjs',
+    },
+  ],
+  // Generates .d.ts declaration file
+  declaration: true,
+});

package/packages/cli/hbs-temp/api-config.ts.hbs

@@ -0,0 +1,21 @@
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export const apiConfig: any[] = [
+{{#each entities as |entity|}}
+  {
+    name: '{{camelCase entity.entityName}}',
+    entityName: '{{entity.entityName}}',
+    apis: [
+{{#each methods as |method|}}
+      {
+        mode: '{{ method.mode }}',
+        method: '{{ method.mode }}{{#if method.name}}{{pascalCase (camelCase method.name) }}{{/if}}',
+        path: '{{#eq method.name '{id}'}}{{else}}{{method.model.requestPath}}{{/eq}}',
+        {{#gt method.pathParams.length 0}}hasPathParams: true,{{/gt}}
+        {{#gt method.queries.length 0}}hasQuery: true,{{/gt}}
+        {{#if method.requestEntity}}hasData: true{{/if}}
+      },
+{{/each}}
+    ]
+  },
+{{/each}}
+]

package/packages/cli/hbs-temp/apis/{{api}}.service.d.ts.hbs

@@ -0,0 +1,39 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import type { AxiosRequestConfig } from 'axios';
+{{#gt entityRefs.length 0}}
+import type { {{formatImport entityRefs}} } from '../entities';
+
+{{/gt}}
+{{#each methods as |method|}}
+{{#gt method.queries.length 0}}
+export interface {{ method.mode }}{{#if method.name}}{{pascalCase (camelCase method.name) }}{{/if}}Query {
+{{#each method.queries as |query|}}
+{{#neq query.description ""}}
+  /**
+   * {{query.description}}
+   */
+{{/neq}}
+  {{#eq query.name "requestParam"}}
+  [key: any]: any;
+  {{else}}
+  {{camelCase query.name}}{{#if query.required}}{{else}}?{{/if}}: {{#if query.items}}{{formatJsType query}}{{else}}{{formatJsType query}}{{/if}};
+  {{/eq}}
+{{/each}}
+}
+{{/gt}}
+{{#gt method.pathParams.length 0}}
+export interface {{ method.mode }}{{#if method.name}}{{pascalCase (camelCase method.name) }}{{/if}}PathParams {
+{{#each method.pathParams as |param|}}
+  {{camelCase param}}: string;
+{{/each}}
+}
+{{/gt}}
+{{/each}}
+export interface {{pascalCase (camelCase entityName) }}Service {
+{{#each methods as |method|}}
+  /**
+   * {{ method.model.summary }}
+   */
+  {{ method.mode }}{{#if method.name}}{{pascalCase (camelCase method.name) }}{{/if}}({{#gt method.pathParams.length 0}}path: {{ method.mode }}{{#if method.name}}{{pascalCase (camelCase method.name) }}{{/if}}PathParams, {{/gt}}{{#gt method.queries.length 0}}query: {{ method.mode }}{{#if method.name}}{{pascalCase (camelCase method.name) }}{{/if}}Query, {{/gt}}{{#if method.requestEntity}}data: {{method.requestEntity.title}}, {{/if}}config?: Partial<AxiosRequestConfig>): Promise<{{#if method.responseEntity}}{{formatImportItem method.responseEntity.title}}{{else}}any{{/if}}>;
+{{/each}}
+}

package/packages/cli/hbs-temp/entities.d.ts.hbs

@@ -0,0 +1,19 @@
+/* eslint-disable @typescript-eslint/no-empty-object-type */
+{{#each definitions as |entity|}}
+  {{#notIncludes entity.title '«'}}
+export interface {{ entity.title }} {
+{{#gt entity.propertySize 0}}
+  {{#each entity.properties as |property key|}}
+  /**
+   * {{ property.description }}
+   *
+   * @type {{{formatJsType property }}}
+   */
+  {{ key }}{{#if property.required}}{{else}}?{{/if}}: {{formatJsType property }};
+  {{/each}}
+{{else}}
+  // 暂无属性
+{{/gt}}
+}
+  {{/notIncludes}}
+{{/each}}