@gct-paas/cli 0.0.1-dev.7.1 → 0.0.1-dev.7.2

package/es/commands/create-template/create-template.d.ts

@@ -0,0 +1,6 @@
+import { Command } from 'commander';
+import { ICommand } from '../../interface';
+export declare class CreateTemplateCommand implements ICommand {
+    load(program: Command): void;
+    action(): Promise<void>;
+}

package/es/commands/index.d.ts

@@ -0,0 +1,5 @@
+import { Command } from 'commander';
+export declare class CommandLoader {
+    static load(program: Command): void;
+    private static handleInvalidCommand;
+}

package/es/commands/update-template/update-template.d.ts

@@ -0,0 +1,6 @@
+import { Command } from 'commander';
+import { ICommand } from '../../interface';
+export declare class UpdateTemplateCommand implements ICommand {
+    load(program: Command): void;
+    action(): Promise<void>;
+}

package/es/commands/zip/zip.d.ts

@@ -0,0 +1,21 @@
+import { Command } from 'commander';
+import { ICommand } from '../../interface';
+interface ZipCommandParams {
+    /**
+     * 待压缩目录
+     *
+     * @type {string}
+     */
+    folder: string;
+    /**
+     * 输出文件名
+     *
+     * @type {string}
+     */
+    output: string;
+}
+export declare class ZipCommand implements ICommand {
+    load(program: Command): void;
+    action(args: ZipCommandParams): Promise<void>;
+}
+export {};

package/es/core/commitlint/commitlint-config/commitlint-config.d.ts

@@ -0,0 +1,9 @@
+import type { UserConfig } from '@commitlint/types';
+/**
+ * 基于基础配置，定义 commitlint 配置
+ *
+ * @export
+ * @param {UserConfig} [config={}]
+ * @returns {*}  {UserConfig}
+ */
+export declare function defineCommitlintConfig(config?: UserConfig): UserConfig;

package/es/core/commitlint/index.d.ts

@@ -0,0 +1 @@
+export { defineCommitlintConfig } from './commitlint-config/commitlint-config';

package/es/core/constants/index.d.ts

@@ -0,0 +1,12 @@
+/**
+ * 开发模式标识，匹配环境变量中的 NODE_ENV
+ */
+export declare const DEV_MODE = "development";
+/**
+ * 生产编译模式标识，匹配环境变量中的 NODE_ENV
+ */
+export declare const PROD_MODE = "production";
+/**
+ * 默认需要忽略编译的外部依赖
+ */
+export declare const DEFAULT_EXTERNAL: string[];

package/es/core/eslint/eslint-config/eslint-config.d.ts

@@ -0,0 +1,9 @@
+import { ConfigArray, InfiniteDepthConfigWithExtends } from 'typescript-eslint';
+/**
+ * 基于基础规则，定义 eslint 配置
+ *
+ * @export
+ * @param {...InfiniteDepthConfigWithExtends[]} configs
+ * @returns {*}  {ConfigArray}
+ */
+export declare function defineEslintConfig(...configs: InfiniteDepthConfigWithExtends[]): ConfigArray;

package/es/core/eslint/index.d.ts

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

package/es/core/index.d.ts

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

package/es/core/prettier/index.d.ts

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

package/es/core/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/core/rollup/index.d.ts

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

package/es/core/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/core/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/core/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/core/rollup/rollup-plugins/index.d.ts

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

package/es/core/stylelint/index.d.ts

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

package/es/core/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/core/template/actions/create-template.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 创建模板行为
+ *
+ * @export
+ * @class CreateTemplateAction
+ */
+export declare class CreateTemplateAction {
+    /**
+     * 创建模板
+     *
+     * @param {string} cwd 创建模板的路径
+     * @param {string} name 生成项目名称
+     * @returns {*}  {Promise<void>}
+     */
+    run(cwd: string, name: string): Promise<void>;
+}

package/es/core/template/actions/update-template.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 已经出初始化过的插件进行增量更新
+ *
+ * @export
+ * @class UpdateTemplateAction
+ */
+export declare class UpdateTemplateAction {
+    run(cwd: string, overwrite: boolean): Promise<void>;
+    /**
+     * 增量更新文件，对比文件 hash 值进行更新
+     *
+     * @param {string} cwd 项目更目录
+     * @param {string} temp 模板克隆临时目录
+     * @param {string} filePath 克隆的文件路径
+     * @returns {*}  {Promise<void>}
+     */
+    updateFile(cwd: string, temp: string, filePath: string): Promise<void>;
+}

package/es/core/template/actions/zip.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 压缩文件夹
+ *
+ * @export
+ * @class ZipAction
+ */
+export declare class ZipAction {
+    run(cwd: string, folder?: string, outFile?: string): Promise<void>;
+}

package/es/core/template/constant/index.d.ts

@@ -0,0 +1 @@
+export declare const TEMPLATE_GIT = "https://git.gct-china.com/paas/frontend/paas-comp-template.git";

package/es/core/template/index.d.ts

@@ -0,0 +1,3 @@
+export { CreateTemplateAction } from './actions/create-template';
+export { UpdateTemplateAction } from './actions/update-template';
+export { ZipAction } from './actions/zip';

package/es/core/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/core/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/core/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/core/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;

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

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

package/es/core/vite/vite-config/vite-dev-config.d.ts

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

package/es/core/vite/vite-config/vite-plugin-config.d.ts

@@ -0,0 +1,25 @@
+import { UserConfig } from 'vite';
+/**
+ * 设计端构建配置
+ *
+ * @export
+ * @param {UserConfig} [opts={}]
+ * @returns {*}  {UserConfig}
+ */
+export declare function defineDesignPluginViteConfig(opts?: UserConfig): UserConfig;
+/**
+ * 移动端插件构建配置
+ *
+ * @export
+ * @param {UserConfig} [opts={}]
+ * @returns {*}  {UserConfig}
+ */
+export declare function defineMobilePluginViteConfig(opts?: UserConfig): UserConfig;
+/**
+ * 网页端插件构建配置
+ *
+ * @export
+ * @param {UserConfig} [opts={}]
+ * @returns {*}  {UserConfig}
+ */
+export declare function defineWebPluginViteConfig(opts?: UserConfig): UserConfig;

package/es/index.d.ts

@@ -0,0 +1,2 @@
+export declare function bootstrap(): Promise<void>;
+export * from './core';

package/es/interface/i-command/i-command.d.ts

@@ -0,0 +1,22 @@
+import { Command } from 'commander';
+/**
+ * 命令项
+ *
+ * @export
+ * @interface ICommand
+ */
+export interface ICommand {
+    /**
+     * 加载命令
+     *
+     * @param {Command} program
+     */
+    load(program: Command): void;
+    /**
+     * 执行行为
+     *
+     * @param {...unknown[]} args
+     * @return {*}  {(void | Promise<void>)}
+     */
+    action(...args: unknown[]): void | Promise<void>;
+}

package/es/interface/index.d.ts

@@ -0,0 +1 @@
+export * from './i-command/i-command';

package/es/types/index.d.ts

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

package/es/utils/index.d.ts

@@ -0,0 +1 @@
+export { localBinExists, loadLocalBinCommandLoader, } from './local-binaries/local-binaries';

package/es/utils/local-binaries/local-binaries.d.ts

@@ -0,0 +1,3 @@
+import { CommandLoader } from '../../commands/index';
+export declare function localBinExists(): boolean;
+export declare function loadLocalBinCommandLoader(): typeof CommandLoader;

package/package.json

@@ -1,15 +1,24 @@
 {
   "name": "@gct-paas/cli",
-  "version": "0.0.1-dev.7.1",
+  "version": "0.0.1-dev.7.2",
   "type": "module",
   "description": "paas 平台核心包",
   "bin": {
-    "gct-paas": "dist/bin.mjs"
+    "gct-paas": "es/bin.mjs"
   },
-  "main": "dist/index.mjs",
+  "main": "dist/index.cjs",
+  "module": "es/index.mjs",
   "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./es/index.d.ts",
+      "import": "./es/index.mjs",
+      "require": "./dist/index.cjs"
+    }
+  },
   "files": [
     "dist",
+    "es",
     "CHANGELOG.md",
     "README.md"
   ],