@gct-paas/build 0.0.1-dev.8

package/es/eslint/eslint-config/eslint-config.mjs

@@ -0,0 +1,109 @@
+import eslint from "@eslint/js";
+import tsEslint from "typescript-eslint";
+import eslintPluginVue from "eslint-plugin-vue";
+import eslintPluginPrettierRecommended from "eslint-plugin-prettier/recommended";
+import unusedImports from "eslint-plugin-unused-imports";
+import eslintPluginImport from "eslint-plugin-import";
+import globals from "globals";
+export function defineEslintConfig(...configs) {
+  return tsEslint.config(
+    /** js推荐配置 */
+    eslint.configs.recommended,
+    /** ts推荐配置 */
+    tsEslint.configs.strict,
+    tsEslint.configs.stylistic,
+    /** vue推荐配置 */
+    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
+        },
+        parserOptions: {
+          ecmaFeatures: {
+            // 全局严格模式
+            impliedStrict: true,
+            // 启用 jsx
+            jsx: true
+          }
+        }
+      },
+      rules: {
+        // 基础配置覆盖
+        "no-console": "off",
+        "no-debugger": "off",
+        "no-undef": "off",
+        "no-plusplus": [
+          "error",
+          {
+            allowForLoopAfterthoughts: true
+          }
+        ],
+        "no-underscore-dangle": "off",
+        "no-restricted-syntax": "off",
+        "no-continue": "off",
+        "no-unused-vars": "off",
+        "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",
+        // vue 配置覆盖
+        "vue/no-setup-props-destructure": "off",
+        "vue/require-default-prop": "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",
+        // 其他配置覆盖
+        "class-methods-use-this": "off",
+        "prefer-destructuring": "off"
+      }
+    },
+    {
+      name: "ts-vue-override",
+      files: ["**/*.vue"],
+      rules: {
+        "@typescript-eslint/no-unused-vars": "off"
+      }
+    },
+    ...configs
+  );
+}

package/es/eslint/index.d.ts

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

package/es/eslint/index.mjs

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

package/es/index.d.ts

@@ -0,0 +1,7 @@
+export * from './commitlint';
+export * from './eslint';
+export * from './prettier';
+export * from './rollup';
+export * from './stylelint';
+export * from './util';
+export * from './vite';

package/es/index.mjs

@@ -0,0 +1,7 @@
+export * from "./commitlint/index.mjs";
+export * from "./eslint/index.mjs";
+export * from "./prettier/index.mjs";
+export * from "./rollup/index.mjs";
+export * from "./stylelint/index.mjs";
+export * from "./util/index.mjs";
+export * from "./vite/index.mjs";

package/es/prettier/index.d.ts

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

package/es/prettier/index.mjs

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

package/es/prettier/prettier-config/prettier-config.d.ts

@@ -0,0 +1,22 @@
+import { Options } from 'prettier';
+/**
+ * 基于基础配置，定义 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 declare function definePrettierConfig(config?: Options): Options;

package/es/prettier/prettier-config/prettier-config.mjs

@@ -0,0 +1,26 @@
+import { merge } from "lodash-es";
+export function definePrettierConfig(config = {}) {
+  return merge(
+    {
+      // 起始格式化间隔
+      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/es/rollup/index.d.ts

@@ -0,0 +1,2 @@
+export { defineRollupConfig } from './rollup-config/dev-config';
+export * from './rollup-plugins';

package/es/rollup/index.mjs

@@ -0,0 +1,2 @@
+export { defineRollupConfig } from "./rollup-config/dev-config.mjs";
+export * from "./rollup-plugins/index.mjs";

package/es/rollup/rollup-config/dev-config.d.ts

@@ -0,0 +1,9 @@
+import { RollupOptions } from 'rollup';
+/**
+ * 开发包基础编译配置
+ *
+ * @export
+ * @param {RollupOptions} [opts={}]
+ * @returns {*}  {RollupOptions}
+ */
+export declare function defineRollupConfig(opts?: RollupOptions): RollupOptions;

package/es/rollup/rollup-config/dev-config.mjs

@@ -0,0 +1,101 @@
+import { defineConfig } from "rollup";
+import { merge } from "lodash-es";
+import path from "path";
+import glob from "fast-glob";
+import { nodeResolve } from "@rollup/plugin-node-resolve";
+import commonjs from "@rollup/plugin-commonjs";
+import json from "@rollup/plugin-json";
+import esbuild from "rollup-plugin-esbuild";
+import dts from "vite-plugin-dts";
+import vue from "@vitejs/plugin-vue";
+import vueJsx from "@vitejs/plugin-vue-jsx";
+import * as rf from "rimraf";
+import cpy from "cpy";
+import fs from "fs-extra";
+import { copyFile, ignoreCompilerFile } from "../rollup-plugins/index.mjs";
+import { DEFAULT_EXTERNAL, PROD_MODE } from "../../constants/index.mjs";
+export function defineRollupConfig(opts = {}) {
+  process.on("SIGINT", () => {
+    process.exit();
+  });
+  const cwd = process.cwd();
+  const isProd = process.env.NODE_ENV === PROD_MODE;
+  const rootDir = path.resolve(cwd, "src");
+  const outDir = path.resolve(cwd, "es");
+  const assetsDir = path.resolve(cwd, "public");
+  const externalCompileFileReg = /\.(vue|scss|css|less|d\.ts)+$/;
+  rf.sync(outDir);
+  const input = glob.sync("src/**/*.{ts,tsx}", {
+    cwd,
+    absolute: true,
+    onlyFiles: true,
+    ignore: ["**/*.test.ts", "**/*.test.tsx", "**/*.d.ts"]
+  });
+  if (isProd) {
+    if (fs.pathExistsSync(assetsDir)) {
+      cpy(assetsDir, outDir);
+    }
+    cpy(path.resolve(cwd, "src/**/*.{vue,scss,css,less,d.ts}"), outDir);
+  } else {
+    copyFile([
+      {
+        from: assetsDir,
+        to: outDir
+      },
+      {
+        from: rootDir,
+        to: outDir,
+        opts: {
+          ignored: (file, stats) => {
+            if (stats && stats.isFile()) {
+              return !externalCompileFileReg.test(file);
+            }
+            return false;
+          }
+        }
+      }
+    ]);
+  }
+  const output = [
+    {
+      dir: outDir,
+      format: "es",
+      sourcemap: false,
+      preserveModules: true,
+      preserveModulesRoot: rootDir,
+      entryFileNames: "[name].mjs"
+    }
+  ];
+  return merge(
+    defineConfig({
+      input,
+      treeshake: false,
+      external: DEFAULT_EXTERNAL,
+      output,
+      plugins: [
+        ignoreCompilerFile(externalCompileFileReg),
+        json(),
+        vue({
+          isProduction: false
+        }),
+        vueJsx({}),
+        nodeResolve({
+          extensions: [".cjs", ".mjs", ".js", ".ts"]
+        }),
+        commonjs(),
+        esbuild({
+          logLevel: "verbose",
+          sourceMap: false,
+          target: ["esnext"],
+          loaders: {
+            ".vue": "ts"
+          }
+        }),
+        dts({
+          outDir: [outDir]
+        })
+      ]
+    }),
+    opts
+  );
+}

package/es/rollup/rollup-plugins/copy-file.d.ts

@@ -0,0 +1,37 @@
+import * as chokidar from 'chokidar';
+/**
+ * 文件拷贝插件配置参数
+ *
+ * @export
+ * @interface CopyFilePluginOptions
+ */
+export interface CopyFilePluginOptions {
+    /**
+     * 源文件
+     *
+     * @type {string}
+     * @memberof CopyFilePluginOptions
+     */
+    from: string;
+    /**
+     * 目标文件
+     *
+     * @type {string}
+     * @memberof CopyFilePluginOptions
+     */
+    to: string;
+    /**
+     * chokidar watch 配置
+     *
+     * @type {chokidar.ChokidarOptions}
+     */
+    opts?: chokidar.ChokidarOptions;
+}
+/**
+ * 文件拷贝插件，在开发模式下会监控文件变更，并自动拷贝文件
+ *
+ * @export
+ * @param {CopyFilePluginOptions[]} opts
+ * @return {*}  {Plugin}
+ */
+export declare function copyFile(opts: CopyFilePluginOptions[]): void;

package/es/rollup/rollup-plugins/copy-file.mjs

@@ -0,0 +1,18 @@
+import { CopyWatch } from "../../util/index.mjs";
+export function copyFile(opts) {
+  if (opts.length === 0) {
+    return;
+  }
+  const arr = [];
+  opts.forEach((opt) => {
+    arr.push(new CopyWatch(opt.from, opt.to, opt.opts));
+  });
+  process.on("exit", () => {
+    if (!opts.length) {
+      return;
+    }
+    arr.forEach((item) => {
+      item.unwatch();
+    });
+  });
+}

package/es/rollup/rollup-plugins/ignore-compiler-file.d.ts

@@ -0,0 +1,8 @@
+import { Plugin } from 'rollup';
+/**
+ * 忽略编译的文件类型
+ *
+ * @export
+ * @returns {*}  {Plugin}
+ */
+export declare function ignoreCompilerFile(extReg: RegExp): Plugin;

package/es/rollup/rollup-plugins/ignore-compiler-file.mjs

@@ -0,0 +1,17 @@
+export function ignoreCompilerFile(extReg) {
+  return {
+    name: "gct:ignore-compiler-file",
+    resolveId(source) {
+      if (extReg.test(source)) {
+        return {
+          id: source,
+          external: true
+        };
+      }
+      return null;
+    },
+    load() {
+      return null;
+    }
+  };
+}

package/es/rollup/rollup-plugins/index.d.ts

@@ -0,0 +1,2 @@
+export { copyFile } from './copy-file';
+export { ignoreCompilerFile } from './ignore-compiler-file';

package/es/rollup/rollup-plugins/index.mjs

@@ -0,0 +1,2 @@
+export { copyFile } from "./copy-file.mjs";
+export { ignoreCompilerFile } from "./ignore-compiler-file.mjs";

package/es/stylelint/index.d.ts

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

package/es/stylelint/index.mjs

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

package/es/stylelint/stylelint-config/stylelint-config.d.ts

@@ -0,0 +1,9 @@
+import { Config } from 'stylelint';
+/**
+ * 基于基础规则，定义 stylelint 配置
+ *
+ * @export
+ * @param {Config} config
+ * @returns {*}  {Config}
+ */
+export declare function defineStylelintConfig(config?: Config): Config;

package/es/stylelint/stylelint-config/stylelint-config.mjs

@@ -0,0 +1,21 @@
+import { merge } from "lodash-es";
+export function defineStylelintConfig(config = {}) {
+  return merge(
+    {
+      extends: ["stylelint-config-standard", "stylelint-config-standard-scss"],
+      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
+        // 变量声明之间不可以有空白行
+      }
+    },
+    config
+  );
+}

package/es/util/index.d.ts

@@ -0,0 +1,17 @@
+export { CopyWatch } from './watcher/watcher';
+/**
+ * win 路径 \\ 转 linux 路径 /
+ *
+ * @export
+ * @param {string} pathStr
+ * @return {*}  {string}
+ */
+export declare function winToUnixPath(pathStr: string): string;
+/**
+ * linux 路径 / 转 win 路径 \\
+ *
+ * @export
+ * @param {string} pathStr
+ * @return {*}  {string}
+ */
+export declare function unixToWinPath(pathStr: string): string;

package/es/util/index.mjs

@@ -0,0 +1,7 @@
+export { CopyWatch } from "./watcher/watcher.mjs";
+export function winToUnixPath(pathStr) {
+  return pathStr.replace(/\\/g, "/");
+}
+export function unixToWinPath(pathStr) {
+  return pathStr.replace(/\//g, "\\");
+}

package/es/util/watcher/watcher.d.ts

@@ -0,0 +1,48 @@
+import * as chokidar from 'chokidar';
+import fs from 'fs-extra';
+import { EventName } from 'chokidar/handler';
+/**
+ * 文件监控类
+ *
+ * @export
+ * @class CopyWatch
+ */
+export declare class CopyWatch {
+    dir: string;
+    copyDir: string;
+    protected w: chokidar.FSWatcher;
+    /**
+     * Creates an instance of CopyWatch.
+     *
+     * @param {string[]} dir 需要监控的目录
+     * @param {string} copyDir 需要拷贝到的目录
+     */
+    constructor(dir: string, copyDir: string, opts?: chokidar.ChokidarOptions);
+    /**
+     * 初始化
+     *
+     * @protected
+     */
+    protected init(): void;
+    /**
+     * 文件监控变更
+     *
+     * @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;
+    /**
+     * 文件监控异常
+     *
+     * @protected
+     * @param {string} path
+     * @param {(fs.Stats | undefined)} [stats]
+     */
+    protected watchErr(err: unknown): void;
+    /**
+     * 停止监控
+     */
+    unwatch(): void;
+}

package/es/util/watcher/watcher.mjs

@@ -0,0 +1,95 @@
+import * as chokidar from "chokidar";
+import path from "path";
+import * as rimraf from "rimraf";
+import { copyFileSync } from "copy-file";
+import log from "consola";
+import colors from "picocolors";
+import { merge } from "lodash-es";
+export class CopyWatch {
+  /**
+   * Creates an instance of CopyWatch.
+   *
+   * @param {string[]} dir 需要监控的目录
+   * @param {string} copyDir 需要拷贝到的目录
+   */
+  constructor(dir, copyDir, opts = {}) {
+    this.dir = dir;
+    this.copyDir = copyDir;
+    this.w = chokidar.watch(
+      this.dir,
+      merge(
+        {
+          awaitWriteFinish: {
+            stabilityThreshold: 300
+            // 等待0.3秒防抖
+          }
+        },
+        opts
+      )
+    );
+    log.debug(`\u62F7\u8D1D\u76D1\u63A7\u6587\u4EF6\u5939: ${this.dir}`);
+    this.init();
+  }
+  w;
+  /**
+   * 初始化
+   *
+   * @protected
+   */
+  init() {
+    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]
+   */
+  watchAll(eventName, pathStr, stats) {
+    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(`\u62F7\u8D1D\u6587\u4EF6: ${colors.cyan(source)} => ${colors.cyan(target)}`);
+        copyFileSync(source, target);
+        break;
+      case "addDir":
+        break;
+      case "unlink":
+      case "unlinkDir":
+        log.info(`\u5220\u9664\u6587\u4EF6\u6216\u76EE\u5F55: ${target}`);
+        rimraf.sync(target);
+        break;
+      default:
+    }
+  }
+  /**
+   * 文件监控异常
+   *
+   * @protected
+   * @param {string} path
+   * @param {(fs.Stats | undefined)} [stats]
+   */
+  watchErr(err) {
+    log.error(`\u76D1\u63A7\u6587\u4EF6\u53D1\u751F\u9519\u8BEF: ${err}`);
+  }
+  /**
+   * 停止监控
+   */
+  unwatch() {
+    this.w.off("all", this.watchAll);
+    this.w.off("error", this.watchErr);
+    this.w.unwatch(this.dir);
+    this.w.close();
+  }
+}

package/es/vite/index.d.ts

@@ -0,0 +1,4 @@
+export { defineViteBaseConfig } from './vite-config/vite-base-config';
+export { defineViteConfig } from './vite-config/vite-config';
+export { defineDevViteConfig } from './vite-config/vite-dev-config';
+export { defineDesignPluginViteConfig, defineMobilePluginViteConfig, defineWebPluginViteConfig, } from './vite-config/vite-plugin-config';

package/es/vite/index.mjs

@@ -0,0 +1,8 @@
+export { defineViteBaseConfig } from "./vite-config/vite-base-config.mjs";
+export { defineViteConfig } from "./vite-config/vite-config.mjs";
+export { defineDevViteConfig } from "./vite-config/vite-dev-config.mjs";
+export {
+  defineDesignPluginViteConfig,
+  defineMobilePluginViteConfig,
+  defineWebPluginViteConfig
+} from "./vite-config/vite-plugin-config.mjs";

package/es/vite/vite-config/vite-base-config.d.ts

@@ -0,0 +1,9 @@
+import { UserConfig } from 'vite';
+/**
+ * 构建 vite 通用配置，基于此配置构建其他 vite 配置
+ *
+ * @export
+ * @param {UserConfig} [opts={}]
+ * @returns {*}  {UserConfig}
+ */
+export declare function defineViteBaseConfig(opts?: UserConfig): UserConfig;