paas-build-package 0.0.1

package/packages/build/src/eslint/eslint-config/eslint-config.ts

@@ -0,0 +1,161 @@
+import { defineConfig } from 'eslint/config';
+import eslint from '@eslint/js';
+import type { ConfigWithExtendsArray } from '@eslint/config-helpers';
+import tsEslint, { ConfigArray, parser } from 'typescript-eslint';
+import eslintPluginVue from 'eslint-plugin-vue';
+import vueParser from 'vue-eslint-parser';
+import eslintPluginPrettierRecommended from 'eslint-plugin-prettier/recommended';
+import unusedImports from 'eslint-plugin-unused-imports';
+import eslintPluginImport from 'eslint-plugin-import';
+import globals from 'globals';
+
+/**
+ * 基于基础规则，定义 eslint 配置
+ *
+ * @export
+ * @param {...ConfigWithExtendsArray} configs
+ * @returns {*}  {ConfigArray}
+ */
+export function defineEslintConfig(
+  ...configs: ConfigWithExtendsArray
+): ConfigArray {
+  return defineConfig(
+    // 基础配置
+    eslint.configs.recommended,
+    tsEslint.configs.recommended,
+    tsEslint.configs.strict,
+    tsEslint.configs.stylistic,
+    eslintPluginVue.configs['flat/recommended'],
+    eslintPluginPrettierRecommended,
+    eslintPluginImport.flatConfigs.recommended,
+    eslintPluginImport.flatConfigs.warnings,
+    eslintPluginImport.flatConfigs.errors,
+    eslintPluginImport.flatConfigs.typescript,
+
+    // 自定义配置
+    {
+      ignores: [
+        '**/node_modules',
+        'lerna.json',
+        'package.json',
+        'tsconfig.json',
+        'pnpm-lock.yaml',
+        'pnpm-workspace.yaml',
+        'eslint.config.mjs',
+        '**/dist',
+        '**/out',
+        '**/es',
+        '**/lib',
+      ],
+      files: ['**/*.{ts,tsx,vue}'],
+      plugins: {
+        'unused-imports': unusedImports,
+      },
+      languageOptions: {
+        globals: {
+          ...globals.browser,
+          ...globals.node,
+        },
+        parser: parser,
+        parserOptions: {
+          ecmaFeatures: {
+            impliedStrict: true, // 全局严格模式
+            jsx: true, // 启用 JSX
+          },
+        },
+      },
+      rules: {
+        // 基础规则覆盖
+        'no-console': 'off',
+        'no-debugger': 'off',
+        'no-undef': 'off',
+        'no-plusplus': [
+          'error',
+          {
+            allowForLoopAfterthoughts: true,
+          },
+        ],
+        'no-underscore-dangle': 'off',
+        'no-restricted-syntax': 'off',
+        'no-useless-assignment': 'off',
+        'no-continue': 'off',
+        'no-unused-vars': 'off', // 关闭基础规则，由 TypeScript 规则接管
+        'no-extraneous-class': 'off',
+        'no-param-reassign': 'off',
+        'no-useless-constructor': 'off',
+        'no-empty-function': 'off',
+
+        // unused-imports 插件规则
+        'unused-imports/no-unused-imports': 'error',
+        'consistent-return': 'off',
+        'func-names': 'off',
+
+        // import 插件规则
+        'import/no-unresolved': 'off',
+        'import/extensions': 'off',
+        'import/prefer-default-export': 'off',
+
+        // TypeScript 规则覆盖
+        '@typescript-eslint/no-unused-vars': [
+          'error',
+          {
+            argsIgnorePattern: '^_',
+          },
+        ],
+        '@typescript-eslint/no-inferrable-types': 'off',
+        '@typescript-eslint/no-explicit-any': ['error'],
+        '@typescript-eslint/explicit-module-boundary-types': 'off',
+        '@typescript-eslint/no-non-null-assertion': 'off',
+        '@typescript-eslint/no-extraneous-class': 'off',
+        '@typescript-eslint/no-dynamic-delete': 'off',
+        // 其他规则覆盖
+        'class-methods-use-this': 'off',
+        'prefer-destructuring': 'off',
+        'no-restricted-imports': [
+          'error',
+          {
+            paths: [
+              {
+                name: '@/index',
+                message: '禁止从 index 导入内容',
+              },
+              {
+                name: '@/loader',
+                message: '禁止从 loader 导入内容',
+              },
+              {
+                name: '..',
+                message: '禁止从内部导入内容自身内容',
+              },
+            ],
+          },
+        ],
+      },
+    },
+    {
+      name: 'ts-vue-override',
+      files: ['**/*.vue'],
+      languageOptions: {
+        parser: vueParser,
+        globals: { ...globals.browser, ...globals.node },
+        parserOptions: {
+          /** typescript项目需要用到这个 */
+          parser: tsEslint.parser,
+          ecmaVersion: 'latest',
+          /** 允许在.vue 文件中使用 JSX */
+          ecmaFeatures: {
+            jsx: true,
+          },
+        },
+      },
+      rules: {
+        '@typescript-eslint/no-unused-vars': 'off',
+        '@typescript-eslint/no-unused-expressions': 'off',
+        // Vue 规则覆盖
+        'vue/no-setup-props-destructure': 'off',
+        'vue/require-default-prop': 'off',
+      },
+    },
+    ...configs,
+  );
+}

package/packages/build/src/eslint/index.ts

@@ -0,0 +1 @@
+export { defineEslintConfig } from './eslint-config/eslint-config';

package/packages/build/src/index.ts

@@ -0,0 +1,8 @@
+export * from './commitlint';
+export * from './constants';
+export * from './eslint';
+export * from './prettier';
+export * from './stylelint';
+export * from './unocss';
+export * from './util';
+export * from './vite';

package/packages/build/src/prettier/index.ts

@@ -0,0 +1 @@
+export { definePrettierConfig } from './prettier-config/prettier-config';

package/packages/build/src/prettier/prettier-config/prettier-config.ts

@@ -0,0 +1,48 @@
+import { Options } from 'prettier';
+import { mergeConfig } from '../../util';
+
+/**
+ * 基于基础配置，定义 prettier 配置
+ *
+ * @description 提交信息规范，提交格式: type: description
+ * feat: 新功能（feature）
+ * fix: 修补bug
+ * docs: 文档（documentation）
+ * style: 格式（不影响代码运行的变动）
+ * refactor: 重构（即不是新增功能，也不是修改bug的代码变动）
+ * test: 增加测试，或测试变更
+ * perf : 性能优化
+ * revert: 撤销上一次的提交
+ * build: 构建工具或构建过程等的变动，如：关联包升级等
+ * chore: 其他修改（不在上述类型中的修改）
+ * release: 发布新版本
+ *
+ * @export
+ * @param {Options} config
+ * @returns {*}  {Options}
+ */
+export function definePrettierConfig(config: Options = {}): Options {
+  return mergeConfig<Options, Options>(
+    {
+      // 起始格式化间隔
+      tabWidth: 2,
+      // 使用单引号
+      singleQuote: true,
+      // jsx 中使用单引号
+      jsxSingleQuote: true,
+      // 对象中的 key 是否需要引号。as-needed: 只有在必须时才要
+      quoteProps: 'as-needed',
+      // 每行结尾是否需要分号
+      trailingComma: 'all',
+      // 括号中参数前后补充空格
+      bracketSpacing: true,
+      // 箭头函数，参数是否添加括号
+      arrowParens: 'avoid',
+      // jsx 元素最后末尾的 > ，换行放置
+      bracketSameLine: false,
+      // 设置换行符
+      endOfLine: 'lf',
+    },
+    config,
+  );
+}

package/packages/build/src/stylelint/index.ts

@@ -0,0 +1 @@
+export { defineStylelintConfig } from './stylelint-config/stylelint-config';

package/packages/build/src/stylelint/stylelint-config/stylelint-config.ts

@@ -0,0 +1,39 @@
+import { merge } from 'lodash-es';
+import { Config } from 'stylelint';
+
+/**
+ * 基于基础规则，定义 stylelint 配置
+ *
+ * @export
+ * @param {Config} config
+ * @returns {*}  {Config}
+ */
+export function defineStylelintConfig(config: Config = {}): Config {
+  return merge(
+    {
+      extends: [
+        'stylelint-config-standard-scss',
+        'stylelint-config-recess-order',
+      ],
+      rules: {
+        'annotation-no-unknown': null,
+        'color-no-invalid-hex': true,
+        'function-name-case': null, // 强制样式方法名称小写或大写
+        'no-duplicate-selectors': null,
+        'selector-class-pattern': null,
+        'scss/dollar-variable-pattern': null,
+        'scss/at-function-pattern': null,
+        'scss/dollar-variable-empty-line-before': null, // 变量声明之间不可以有空白行
+        'nesting-selector-no-missing-scoping-root': null,
+        'selector-pseudo-class-no-unknown': [
+          true,
+          {
+            // css modules 的 :global 伪类
+            ignorePseudoClasses: ['global'],
+          },
+        ],
+      },
+    },
+    config,
+  );
+}

package/packages/build/src/types/index.d.ts

@@ -0,0 +1 @@
+declare module 'eslint-plugin-import';

package/packages/build/src/unocss/index.ts

@@ -0,0 +1 @@
+export * from './unocss.config';

package/packages/build/src/unocss/unocss.config.ts

@@ -0,0 +1,45 @@
+import {
+  defineConfig,
+  presetTypography,
+  presetUno,
+  presetWebFonts,
+  UserConfig,
+} from 'unocss';
+import { mergeConfig } from '../util';
+
+/**
+ * 定义 unocss 配置，基于此配置构建其他 unocss 配置
+ *
+ * @export
+ * @param {UserConfig} config
+ * @return {*}  {UserConfig}
+ */
+export function defineUnoConfig(config: UserConfig): UserConfig {
+  return defineConfig(
+    mergeConfig<UserConfig, UserConfig>(
+      {
+        shortcuts: {
+          'ks-row': 'flex',
+          'ks-column': 'flex flex-col',
+          'ks-col': 'flex-1',
+          'ks-row-middle': 'flex items-center',
+          'ks-row-start': 'flex items-start',
+          'ks-row-end': 'flex items-end',
+          'ks-row-center': 'flex justify-center',
+          'ks-row-left': 'flex justify-start',
+          'ks-row-right': 'flex justify-end',
+          'ks-row-center-middle': 'flex items-center justify-center',
+          'ks-row-center-between': 'flex items-center justify-between',
+          'ks-row-center-around': 'flex items-center justify-around',
+          'ks-row-between': 'flex  justify-between',
+          ell: 'text-ellipsis whitespace-nowrap overflow-hidden',
+          'gct-color-text-1': 'text-[#1A1D23]',
+          'gct-color-text-4': 'text-[#5A5F6B]',
+          'gct-color-text-5': 'text-[#8B8B8B]',
+        },
+        presets: [presetUno(), presetTypography(), presetWebFonts({})],
+      },
+      config,
+    ),
+  );
+}

package/packages/build/src/util/env-state/env-state.ts

@@ -0,0 +1,9 @@
+/**
+ * 是否为需要线上插件开发环境
+ *
+ * @export
+ * @return {*}  {boolean}
+ */
+export function isBuildPluginEnv(): boolean {
+  return process.env.BUILD_PLUGIN_ENV === 'true';
+}

package/packages/build/src/util/index.ts

@@ -0,0 +1,52 @@
+import { mergeWith } from 'lodash-es';
+
+export { isBuildPluginEnv } from './env-state/env-state';
+export { IS_NODE_MODULE } from './reg-exp/reg-exp';
+export { CopyWatch } from './watcher/watcher';
+
+/**
+ * win 路径 \\ 转 linux 路径 /
+ *
+ * @export
+ * @param {string} pathStr
+ * @return {*}  {string}
+ */
+export function winToUnixPath(pathStr: string): string {
+  return pathStr.replace(/\\/g, '/');
+}
+
+/**
+ * linux 路径 / 转 win 路径 \\
+ *
+ * @export
+ * @param {string} pathStr
+ * @return {*}  {string}
+ */
+export function unixToWinPath(pathStr: string): string {
+  return pathStr.replace(/\//g, '\\');
+}
+
+/**
+ * 自定义合并配置，数据非替换为 concat 合并
+ *
+ * @author chitanda
+ * @date 2025-08-20 20:08:45
+ * @export
+ * @template T
+ * @param {T} obj
+ * @param {U} obj2
+ * @returns {*}  {T}
+ */
+export function mergeConfig<T extends object, U extends object>(
+  obj: T,
+  obj2: U,
+): T & U {
+  return mergeWith(obj, obj2, (objValue, srcValue) => {
+    // 如果都是数组类型，进行合并而非替换
+    if (Array.isArray(objValue) && Array.isArray(srcValue)) {
+      return objValue.concat(srcValue);
+    }
+    // 其他类型使用默认合并策略
+    return undefined;
+  });
+}

package/packages/build/src/util/reg-exp/reg-exp.ts

@@ -0,0 +1 @@
+export const IS_NODE_MODULE = /node_modules\//;

package/packages/build/src/util/watcher/watcher.ts

@@ -0,0 +1,114 @@
+import * as chokidar from 'chokidar';
+import fs from 'fs-extra';
+import path from 'path';
+import * as rimraf from 'rimraf';
+import { copyFileSync } from 'copy-file';
+import log from 'consola';
+import colors from 'picocolors';
+import { EventName } from 'chokidar/handler';
+import { merge } from 'lodash-es';
+
+/**
+ * 文件监控类
+ *
+ * @export
+ * @class CopyWatch
+ */
+export class CopyWatch {
+  protected w: chokidar.FSWatcher;
+
+  /**
+   * Creates an instance of CopyWatch.
+   *
+   * @param {string[]} dir 需要监控的目录
+   * @param {string} copyDir 需要拷贝到的目录
+   */
+  constructor(
+    public dir: string,
+    public copyDir: string,
+    opts: chokidar.ChokidarOptions = {},
+  ) {
+    this.w = chokidar.watch(
+      this.dir,
+      merge(
+        {
+          awaitWriteFinish: {
+            stabilityThreshold: 300, // 等待0.3秒防抖
+          },
+        },
+        opts,
+      ),
+    );
+    log.debug(`拷贝监控文件夹: ${this.dir}`);
+    this.init();
+  }
+
+  /**
+   * 初始化
+   *
+   * @protected
+   */
+  protected init(): void {
+    this.watchAll = this.watchAll.bind(this);
+    this.watchErr = this.watchErr.bind(this);
+    this.w.on('all', this.watchAll);
+    this.w.on('error', this.watchErr);
+  }
+
+  /**
+   * 文件监控变更
+   *
+   * @protected
+   * @param {("add" | "addDir" | "change" | "unlink" | "unlinkDir")} eventName
+   * @param {string} pathStr
+   * @param {(fs.Stats)} [stats]
+   */
+  protected watchAll(
+    eventName: EventName,
+    pathStr: string,
+    stats?: fs.Stats,
+  ): void {
+    if (stats && stats.size <= 0) {
+      return;
+    }
+    const cwd = process.cwd();
+    const source = path.resolve(cwd, pathStr);
+    const target = path.resolve(this.copyDir, path.relative(this.dir, pathStr));
+    switch (eventName) {
+      case 'add':
+      case 'change':
+        log.info(`拷贝文件: ${colors.cyan(source)} => ${colors.cyan(target)}`);
+        copyFileSync(source, target);
+        break;
+      case 'addDir':
+        break;
+      case 'unlink':
+      case 'unlinkDir':
+        log.info(`删除文件或目录: ${target}`);
+        rimraf.sync(target);
+        break;
+      default:
+    }
+  }
+
+  /**
+   * 文件监控异常
+   *
+   * @protected
+   * @param {string} path
+   * @param {(fs.Stats | undefined)} [stats]
+   */
+  protected watchErr(err: unknown): void {
+    log.error(`监控文件发生错误: ${err}`);
+  }
+
+  /**
+   * 停止监控
+   */
+  unwatch(): void {
+    this.w.off('all', this.watchAll);
+    this.w.off('error', this.watchErr);
+    this.w.unwatch(this.dir);
+    this.w.close();
+  }
+}

package/packages/build/src/vite/index.ts

@@ -0,0 +1,13 @@
+export { defineViteBaseConfig } from './vite-config/vite-base-config';
+export { defineViteConfig, defineLoaderViteConfig } from './vite-config/vite-config';
+export { defineDevViteConfig } from './vite-config/vite-dev-config';
+export { definePkgDevViteConfig } from './vite-config/vite-pkg-dev-config';
+export {
+  definePluginViteConfig,
+  defineDesignPluginViteConfig,
+  defineMobilePluginViteConfig,
+  definePadPluginViteConfig,
+  defineWebPluginViteConfig,
+} from './vite-config/vite-plugin-config';
+export { defineProjectViteConfig } from './vite-config/vite-project-config';
+

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

@@ -0,0 +1,49 @@
+import { defineConfig, UserConfig } from 'vite';
+import vue from '@vitejs/plugin-vue';
+import vueJsx from '@vitejs/plugin-vue-jsx';
+import path from 'path';
+import { DEFAULT_EXTERNAL } from '../../constants';
+import { mergeConfig } from '../../util';
+
+/**
+ * 构建 vite 通用配置，基于此配置构建其他 vite 配置
+ *
+ * @export
+ * @param {UserConfig} [opts={}]
+ * @returns {*}  {UserConfig}
+ */
+export function defineViteBaseConfig(opts: UserConfig = {}): UserConfig {
+  // 当前脚本执行的工作目录
+  const cwd = process.cwd();
+  // 编译文件输出目录
+  const outDir = path.resolve(cwd, 'dist');
+
+  return mergeConfig<UserConfig, UserConfig>(
+    defineConfig({
+      resolve: {
+        alias: {
+          '@': path.resolve(cwd, './src'),
+        },
+      },
+      css: {
+        preprocessorOptions: {
+          scss: {
+            additionalData: `@use "@gct-paas/scss/style/global.scss" as *;`,
+          },
+        },
+      },
+      build: {
+        outDir,
+        target: 'chrome89',
+        rolldownOptions: {
+          external: DEFAULT_EXTERNAL,
+        },
+      },
+      plugins: [
+        vue(),
+        vueJsx(),
+      ],
+    }),
+    opts,
+  );
+}

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

@@ -0,0 +1,74 @@
+import { defineConfig, mergeConfig, PluginOption, UserConfig } from 'vite';
+import path from 'path';
+import UnoCSS from 'unocss/vite';
+import { defineViteBaseConfig } from './vite-base-config';
+
+/**
+ * 构建 vite 通用配置，基于此配置构建其他 vite 配置
+ *
+ * @export
+ * @param {UserConfig} [opts={}]
+ * @returns {*}  {UserConfig}
+ */
+export function defineViteConfig(opts: UserConfig = {}): UserConfig {
+  // 当前脚本执行的工作目录
+  const cwd = process.cwd();
+
+  return mergeConfig<UserConfig, UserConfig>(
+    defineViteBaseConfig(
+      defineConfig({
+        build: {
+          minify: 'terser',
+          terserOptions: {
+            // 压缩选项，控制代码压缩行为
+            compress: {
+              // 是否移除 console.* 调用；false 表示保留，避免生产环境丢失重要日志
+              drop_console: false,
+              // 是否移除永远不会执行的死代码（如 if(false){...}）
+              dead_code: true,
+              // 是否移除未被引用的变量和函数，减小产物体积
+              unused: true,
+              // 压缩算法的执行轮数；多轮压缩可以发现单轮无法消除的冗余代码，但会增加构建耗时
+              passes: 2,
+            },
+            // 是否混淆变量名、函数名等标识符，使产物更难以阅读反编译，同时进一步缩小体积
+            mangle: true,
+          },
+          lib: {
+            entry: path.resolve(cwd, 'src/index.ts'),
+            formats: ['es'],
+            cssFileName: 'index.min',
+            fileName: '[name].[format].min',
+          },
+        },
+        plugins: [
+          UnoCSS({ hmrTopLevelAwait: false }) as PluginOption,
+        ]
+      }),
+    ),
+    opts,
+  );
+}
+
+/**
+ * 构建 loader 模块的 vite 配置，基于此配置构建基于 index 模式下的上层样式加载封装
+ *
+ * @export
+ * @param {UserConfig} [opts={}]
+ * @return {*}  {UserConfig}
+ */
+export function defineLoaderViteConfig(opts: UserConfig = {}): UserConfig {
+  // 当前脚本执行的工作目录
+  const cwd = process.cwd();
+
+  return mergeConfig<UserConfig, UserConfig>(
+    defineViteConfig({
+      build: {
+        lib: {
+          entry: path.resolve(cwd, 'src/loader.ts'),
+        },
+      },
+    }),
+    opts,
+  );
+}

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

@@ -0,0 +1,26 @@
+import { defineConfig, mergeConfig, PluginOption, UserConfig } from 'vite';
+import vue from '@vitejs/plugin-vue';
+import vueJsx from '@vitejs/plugin-vue-jsx';
+
+/**
+ * 构建本地开发 vite 通用配置，基于此配置构建其他 vite 配置
+ *
+ * @export
+ * @param {UserConfig} [opts={}]
+ * @returns {*}  {UserConfig}
+ */
+export function defineDevViteConfig(opts: UserConfig = {}): UserConfig {
+  return mergeConfig<UserConfig, UserConfig>(
+    defineConfig({
+      css: {
+        preprocessorOptions: {
+          scss: {
+            additionalData: `@use "@gct-paas/scss/style/global.scss" as *;`,
+          },
+        },
+      },
+      plugins: [vue() as PluginOption, vueJsx() as PluginOption],
+    }),
+    opts,
+  );
+}