@doracli/helper 0.0.1

package/lib/type/index.d.ts

@@ -0,0 +1,246 @@
+import * as _doracli_type from '@doracli/type';
+import { TTsConfig, TDoraConfig, TCdnConfigDefine, TPackageConfig, TDoraConfigDefine, TMode, TCdn, TModule } from '@doracli/type';
+import * as _cclr_lang from '@cclr/lang';
+import { TPlainObject, PartialRecursive } from '@cclr/lang';
+import * as _doracli_type_src_dora_config_service from '@doracli/type/src/dora-config-service';
+import * as _doracli_type_src_dora_config_mocks from '@doracli/type/src/dora-config-mocks';
+import * as _doracli_type_src_dora_config_esbuild from '@doracli/type/src/dora-config-esbuild';
+export { default as picocolors } from 'picocolors';
+
+declare class ConfigCtx {
+    private tsConfig;
+    private doraConfig;
+    private packageConfig;
+    private cdnConfig;
+    private cmd;
+    private workRoot;
+    setCmd(cmd: TPlainObject): void;
+    getCmd(): TPlainObject;
+    setWorkRoot(root: string): void;
+    getWorkRoot(): string;
+    setTsConfig(config: TTsConfig): void;
+    getTsConfig(): TTsConfig;
+    setDoraConfig(config: TDoraConfig): void;
+    getDoraConfig(): TDoraConfig;
+    setCdnConfig(config: TCdnConfigDefine): void;
+    getCdnConfig(): Partial<Record<"headAfterScript" | "headAfterStyle" | "bodyBeforeScript" | "bodyAfterScript", ((mode: _doracli_type.TMode) => string[]) | string[]>>;
+    setPackageConfig(config: TPackageConfig): void;
+    getPackageConfig(): TPackageConfig;
+    copy(): ConfigCtx;
+}
+
+declare enum EnvEnum {
+    dev = "development",
+    prod = "production"
+}
+
+/**
+ * 在制定目录下插入 tsconfig.json 文件
+ * @param cwd
+ */
+declare const insertTsconfig: (cwd?: string) => Promise<void>;
+
+/**
+ * @param mode 模式
+ * @param status 状态
+ * @param msg 消息
+ * @returns
+ */
+declare const cLogMessage: (mode: string, status: string, ...msg: string[]) => void;
+declare const cLogError: (mode: string, status: string, ...msg: string[]) => void;
+declare const cLogWarn: (mode: "serve" | "build" | string, status: string, ...msg: string[]) => void;
+declare const cLogSuccess: (mode: string, status: string, ...msg: string[]) => void;
+declare const cLogTime: (key?: string) => () => void;
+declare const cLogTimeEnd: (key: string) => void;
+declare const cLog: {
+    log: (mode: string, status: string, ...msg: string[]) => void;
+    error: (mode: string, status: string, ...msg: string[]) => void;
+    warn: (mode: "serve" | "build" | string, status: string, ...msg: string[]) => void;
+    info: (mode: string, status: string, ...msg: string[]) => void;
+    time: (key?: string) => () => void;
+    timeEnd: (key: string) => void;
+};
+
+declare const getDoracliConfig: (root: string) => Promise<TDoraConfigDefine | null>;
+
+/**
+ * 获取json文件
+ * @param root
+ * @returns
+ */
+declare const getPackageJson: (root?: string) => Promise<any>;
+
+declare const getTsconfigJson: (root: string) => Promise<any>;
+
+/**
+ * 获取cdn文件配置
+ * @returns
+ */
+declare function getUserCdn(root: string): Promise<TCdnConfigDefine | null>;
+
+declare const mergeDoraCliConfig: <T extends PartialRecursive<TDoraConfig>>(target: T, source?: T) => Omit<T, "output"> & {
+    output: {
+        file?: string;
+        path?: string | undefined;
+    };
+};
+/**
+ * 合并多个配置项
+ * @param target 配置项，可多个，后面的配置项会覆盖前面的配置项
+ * @returns
+ */
+declare const mergeDoraCliConfigMutiple: <T extends PartialRecursive<TDoraConfig>>(...target: T[]) => T;
+
+/**
+ * 获取cdn文件配置
+ * @param workRootDir
+ * @param mode
+ * @returns
+ */
+declare function parseCdnConfig(cdnConfig: TCdnConfigDefine | null, mode: TMode): TCdn | undefined;
+
+/**
+ * 解析doracli配置
+ * @param workRootDir
+ * @param mode
+ * @returns
+ */
+declare const parseDoracliConfig: (userConfig: TDoraConfigDefine | null, mode: TMode) => Promise<PartialRecursive<TDoraConfig> | null>;
+
+/**
+ * 配置项多任务拆分
+ * @param config 配置项
+ * @returns
+ */
+declare const splitDoraCliConfig: (config: TDoraConfig) => PartialRecursive<TDoraConfig>[] | {
+    input: string;
+    output: _doracli_type.TOutput;
+    formatList: _doracli_type.TModule[];
+    format: _doracli_type.TModule;
+    clear: boolean;
+    minimize: boolean;
+    externals: string[];
+    internals: string[];
+    alias: Record<string, string>;
+    dts: {
+        input?: string;
+        output?: string;
+    } | false;
+    copy: {
+        src: string;
+        dest: string;
+    }[];
+    webpackConfig?: _doracli_type.TDoraConfigWebpack;
+    rollupConfig?: _doracli_type.TDoraConfigRollup;
+    esbuildConfig?: _doracli_type_src_dora_config_esbuild.TDoraConfigEsbuild;
+    mocksConfig?: _doracli_type_src_dora_config_mocks.TDoraConfigMocks;
+    serviceConfig?: _doracli_type_src_dora_config_service.TDoraConfigService;
+}[];
+
+declare const wholeDoraConfig: (config: PartialRecursive<TDoraConfig>, workRootDir?: string) => TDoraConfig;
+
+declare const inputFileDirList: string[];
+declare const inputFileTypeList: string[];
+declare const findInput: (workRootDir: string) => string;
+
+/**
+ * 获取tsconfig.json里的paths，作为项目路径别名
+ * @param tsConfig
+ * @returns
+ */
+declare const getTsPathAlias: (tsConfig: TTsConfig) => Record<string, string>;
+
+/**
+ * 收集用户配置
+ * @param configCtx ConfigCtx
+ * @param mode 开发 or 生产
+ * @param presetConfig  预设配置
+ */
+declare const collectConfig: (configCtx: ConfigCtx, mode: TMode, presetConfig?: {
+    doraConfig?: PartialRecursive<TDoraConfig>;
+}) => Promise<void>;
+
+/**
+ * 获取cdn文件配置
+ * @returns
+ */
+declare function resolveCdnConfig(workRootDir: string, mode: TMode): Promise<{} | undefined>;
+
+declare const resolveDoraConfig: (workRootDir: string, mode: TMode) => Promise<_cclr_lang.PartialRecursive<_doracli_type.TDoraConfig> | null>;
+
+/**
+ * 获取json文件
+ * @param root
+ * @returns
+ */
+declare const resolvePackageJson: (workRootDir: string) => Promise<any>;
+
+declare const resolveTsconfigJson: (workRootDir: string) => Promise<any>;
+
+type TCollectType = {
+    doraConfig: TDoraConfigDefine | null;
+    packageConfig: TPackageConfig | null;
+    tsconfigConfig: TTsConfig | null;
+    cdnConfig: TCdnConfigDefine | null;
+};
+declare const collectConfigs: (workDir: string, need?: {
+    doraConfig?: boolean;
+    packageConfig?: boolean;
+    tsconfigConfig?: boolean;
+    cdnConfig?: boolean;
+}) => Promise<TCollectType>;
+
+type TParseConfigResult = {
+    doraConfig: TDoraConfig;
+    packageConfig: TPackageConfig;
+    tsConfig: TTsConfig;
+    cdnConfig: TCdn;
+};
+declare const parsetConfig: (config: TCollectType, mode: TMode) => Promise<TParseConfigResult>;
+
+declare const configCtxCollect: (configCtx: ConfigCtx, params: {
+    workRootDir?: string;
+    cmd?: TPlainObject;
+} & TParseConfigResult) => Promise<void>;
+
+declare const createEnvParams: <T extends TPlainObject>(params: T) => T;
+
+type TOutputSingle = {
+    /** 输入地址 */
+    input: string;
+    /** 输出文件路径 */
+    outputFile: string;
+    /** 输出文件路径 */
+    outputPath: string;
+    /** 格式化 */
+    format: TModule;
+};
+declare const createOutputList: (config: TDoraConfig) => TOutputSingle[];
+
+declare const splitDoraConfig: (config: TDoraConfig) => {
+    input: string;
+    output: _doracli_type.TOutput;
+    formatList: _doracli_type.TModule[];
+    format: _doracli_type.TModule;
+    clear: boolean;
+    minimize: boolean;
+    externals: string[];
+    internals: string[];
+    alias: Record<string, string>;
+    dts: {
+        input?: string;
+        output?: string;
+    } | false;
+    copy: {
+        src: string;
+        dest: string;
+    }[];
+    webpackConfig?: _doracli_type.TDoraConfigWebpack;
+    rollupConfig?: _doracli_type.TDoraConfigRollup;
+    esbuildConfig?: _doracli_type_src_dora_config_esbuild.TDoraConfigEsbuild;
+    mocksConfig?: _doracli_type_src_dora_config_mocks.TDoraConfigMocks;
+    serviceConfig?: _doracli_type_src_dora_config_service.TDoraConfigService;
+}[] | PartialRecursive<TDoraConfig>[];
+
+export { ConfigCtx, EnvEnum, cLog, cLogError, cLogMessage, cLogSuccess, cLogTime, cLogTimeEnd, cLogWarn, collectConfig, collectConfigs, configCtxCollect, createEnvParams, createOutputList, findInput, getDoracliConfig, getPackageJson, getTsPathAlias, getTsconfigJson, getUserCdn, inputFileDirList, inputFileTypeList, insertTsconfig, mergeDoraCliConfig, mergeDoraCliConfigMutiple, parseCdnConfig, parseDoracliConfig, parsetConfig, resolveCdnConfig, resolveDoraConfig, resolvePackageJson, resolveTsconfigJson, splitDoraCliConfig, splitDoraConfig, wholeDoraConfig };
+export type { TCollectType, TOutputSingle, TParseConfigResult };

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@doracli/helper",
+  "version": "0.0.1",
+  "description": "use helper",
+  "author": "cclr <18843152354@163.com>",
+  "homepage": "",
+  "license": "MIT",
+  "type": "module",
+  "exports": {
+    "import": "./lib/esm/index.js",
+    "require": "./lib/cjs/index.js"
+  },
+  "types": "lib/type/index.d.ts",
+  "directories": {
+    "lib": "lib"
+  },
+  "files": [
+    "lib",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "scripts": {
+    "test": "vitest",
+    "g:test": "vitest run",
+    "build": "drn build",
+    "g:build": "drn build"
+  },
+  "dependencies": {
+    "@cclr/lang": "^0.1.28",
+    "@cclr/utils": "^0.1.28",
+    "@dorabag/config-loader": "^1.0.10",
+    "@dorabag/file-pro": "^1.0.10",
+    "@dorabag/open-browser": "^1.0.10",
+    "@dorabag/srv-tool": "^1.0.10",
+    "@doracli/type": "^0.0.1",
+    "picocolors": "^1.1.1",
+    "webpack": "^5.102.1",
+    "webpack-dev-server": "^5.2.2"
+  },
+  "gitHead": "40ab496f25042487a671979074515f3345c96453"
+}