@doracli/type 0.0.2 → 0.0.4

package/README.md

@@ -1,3 +1,7 @@
 # `cli`
 
 ## Usage
+
+```
+
+```

package/package.json

@@ -1,16 +1,16 @@
 {
   "name": "@doracli/type",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "description": "package by webpack",
   "author": "cclr <18843152354@163.com>",
   "homepage": "",
   "license": "MIT",
   "types": "src/index.ts",
   "directories": {
-    "lib": "lib"
+    "src": "src"
   },
   "files": [
-    "lib",
+    "src",
     "README.md"
   ],
   "publishConfig": {
@@ -22,5 +22,5 @@
     "g:test": "vitest run",
     "build": "ccf build"
   },
-  "gitHead": "912cb44292b64679630a799974d18c22b2e69738"
+  "gitHead": "a978bb7e7b32c192b1eb527dae5f25bbe1a2af86"
 }

package/src/cdn-type.ts

@@ -0,0 +1,13 @@
+import type { TMode } from './dora-config-common';
+
+type cdnKey =
+  | 'headAfterScript'
+  | 'headAfterStyle'
+  | 'bodyBeforeScript'
+  | 'bodyAfterScript';
+
+export type TCdnConfigDefine = Partial<
+  Record<cdnKey, ((mode: TMode) => string[]) | string[]>
+>;
+
+export type TCdn = Record<cdnKey, string[]>;

package/src/common.ts

@@ -0,0 +1,11 @@
+/**
+ * 全部属性变为可选，递归处理
+ */
+export type PartialRecursive<T> = {
+  [P in keyof T]?: T[P] extends object ? PartialRecursive<T[P]> : T[P];
+};
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export type TAny = any;
+
+export type TPlainObject = Record<string, TAny>;

package/src/dora-config-common.ts

@@ -0,0 +1,83 @@
+import type { TAny, TPlainObject } from './common';
+import type { TModule } from './module-type';
+
+export type TMode = 'development' | 'production';
+
+/** 配置类型 */
+export type TConfigType = 'library' | 'application' | 'plugin';
+
+/**
+ * 模块配置
+ * - 模块格式
+ * - 模块的一些其他配置
+ */
+export type TLib = {
+  format: TModule;
+  [key: string]: TAny;
+};
+
+export type TOutput = {
+  /** 出口文件地址 */
+  file?: string;
+  /**
+   * 出口文件目录
+   * @default lib
+   */
+  path: string;
+};
+
+/**
+ * 项目通用配置
+ * @description 单任务配置
+ * @description 路径只要是 ‘/’ 开头都按绝对路径解析，否则按执行目录进行相对路径解析
+ */
+export type TDoraConfigCommon = {
+  /**
+   * 模块名称
+   * 1. 多模块时必填，会作为路径的一部分
+   * 2. 作为标志性的名字
+   * 3. umd/iife 模块的名字 (低优先级)
+   */
+  name: string;
+  /** 配置类型 */
+  type: TConfigType;
+  /** 入口地址 */
+  input: string;
+  /** 出口配置 */
+  output: TOutput;
+  /** 单模块 */
+  lib: TLib;
+  /** 输出单格式 lib 的简写 */
+  format: TModule;
+  /** 多模块配置 */
+  libList: TLib[];
+  /** 输出多格式 libList 的简写 */
+  formatList: TModule[];
+  /**
+   * 是否清除历史产物
+   * @default true
+   */
+  clear: boolean;
+  /** 是否压缩代码 */
+  minimize: boolean;
+  /** 排除依赖，不打包进产物 */
+  externals: string[] | TPlainObject[];
+  /** 包含依赖，打包进产物 */
+  internals: string[];
+  /** 路径别名 */
+  alias: Record<string, string>;
+  /**
+   * 编译type 仅对ts项目生效
+   * @description 有值就开启
+   * @description 可单独制定输入，输出路径，没有就使用外层的配置
+   * @description 使用外层配置时，默认输出路径 path + /types/**.*
+   */
+  dts:
+    | {
+        input?: string;
+        output?: string;
+      }
+    | false;
+  /** 复制文件配置 */
+  copy: { src: string; dest: string }[];
+};

package/src/dora-config-dts.ts

@@ -0,0 +1,7 @@
+/**
+ * dts 配置
+ */
+export type TDoraConfigDts = {
+  input?: string;
+  output?: string;
+};

package/src/dora-config-esbuild.ts

@@ -0,0 +1,10 @@
+export type TDoraConfigEsbuild = {
+  pluginsOptions: {
+    copy: {
+      targets: {
+        src: string;
+        dest: string;
+      }[];
+    };
+  };
+};

package/src/dora-config-multiple.ts

@@ -0,0 +1,18 @@
+import type { TDoraConfigCommon } from './dora-config-common';
+import type { TDoraConfigDts } from './dora-config-dts';
+import type { TDoraConfigEsbuild } from './dora-config-esbuild';
+import type { TDoraConfigRollup } from './dora-config-rollup';
+import type { TDoraConfigService } from './dora-config-service';
+import type { TDoraConfigWebpack } from './dora-config-webpack';
+
+export type TDoraConfigMultiple = Partial<TDoraConfigCommon> & {
+  /** 隔离 */
+  split?: boolean;
+
+  webpackConfig?: TDoraConfigWebpack;
+  rspackConfig?: TDoraConfigWebpack;
+  rollupConfig?: TDoraConfigRollup;
+  esbuildConfig?: TDoraConfigEsbuild;
+  serviceConfig?: Partial<TDoraConfigService>;
+  dtsConfig?: TDoraConfigDts;
+};

package/src/dora-config-rollup.ts

@@ -0,0 +1,10 @@
+export type TDoraConfigRollup = {
+  pluginsOptions: {
+    copy: {
+      targets: {
+        src: string;
+        dest: string;
+      }[];
+    };
+  };
+};

package/src/dora-config-service.ts

@@ -0,0 +1,48 @@
+export type TDoraConfigService = {
+  /** 是否自动打开浏览器，分场景 */
+  openBrowser: boolean;
+  /** 访问路径前缀，静态资源也会加前缀 */
+  publicPath: string;
+  /** portal */
+  https: boolean;
+  /** 主机，自动打开浏览器会访问 */
+  host: string;
+  /** 允许访问的域名列表 */
+  allowedHosts: 'all' | string[];
+  /** port */
+  port: number;
+  /** 代理接口 */
+  proxy: {
+    [path: string]: {
+      pathRewrite?: Record<string, string>;
+      headers?: Record<string, string>;
+      router: string | (() => string);
+    };
+  };
+  /**
+   * 静态资源服务
+   * 文件夹路径 -> 路由
+   * @default
+   * ```
+   * { './static': '/static' }
+   * ```
+   */
+  static: {
+    [dirPath: string]: string;
+  };
+  /** 扫描接口文件的范围 */
+  scan: string;
+  /**
+   * 文件夹 -> 路由的映射，
+   * 默认文件夹路径就代表路由
+   */
+  pathRouteMap: {
+    [dirPath: string]: {
+      /**
+       * 文件对应的路由，同一个文件可以对应多个路由
+       * 同一个文件对应一个实例，对应多个路由
+       */
+      defs: string[];
+    };
+  };
+};

package/src/dora-config-webpack.ts

@@ -0,0 +1,30 @@
+export type TDoraConfigWebpack = {
+  /** 日志级别，默认 warn */
+  logging?: 'none' | 'error' | 'warn' | 'info' | 'log' | 'verbose' | undefined; // 只显示警告及以上日志
+  /**
+   * eval | [inline-|hidden-|eval-][nosources-][cheap-[module-]]source-map
+   * 开发环境推荐：eval-cheap-module-source-map
+   * - 本地开发首次打包慢点没关系,因为 eval 缓存的原因, 热更新会很快
+   * - 开发中,我们每行代码不会写的太长,只需要定位到行就行,所以加上 cheap
+   * - 我们希望能够找到源代码的错误,而不是打包后的,所以需要加上 module
+   */
+  devtool?: string;
+  /** 内置模块 */
+  externals?: string[];
+  /** 实验性功能 */
+  experiments?: Record<string, unknown>;
+  resolve?: {
+    alias?: Record<string, string>;
+    extensions?: string[];
+  };
+  resolveLoader?: {
+    modules?: string[];
+  };
+  loaderOptions?: {
+    postcssPluginExtra?: unknown[];
+  };
+  pluginsOptions?: {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    WebpackBundleAnalyzer: any;
+  };
+};

package/src/dora-config.ts

@@ -0,0 +1,22 @@
+import type { PartialRecursive } from './common';
+import type { TDoraConfigCommon } from './dora-config-common';
+import type { TDoraConfigDts } from './dora-config-dts';
+import type { TDoraConfigEsbuild } from './dora-config-esbuild';
+import type { TDoraConfigMultiple } from './dora-config-multiple';
+import type { TDoraConfigRollup } from './dora-config-rollup';
+import type { TDoraConfigService } from './dora-config-service';
+import type { TDoraConfigWebpack } from './dora-config-webpack';
+
+export type TDoraConfig = TDoraConfigCommon & {
+  multiple: TDoraConfigMultiple[] | false;
+  webpackConfig?: TDoraConfigWebpack;
+  rspackConfig?: TDoraConfigWebpack;
+  rollupConfig?: TDoraConfigRollup;
+  esbuildConfig?: TDoraConfigEsbuild;
+  serviceConfig?: Partial<TDoraConfigService>;
+  dtsConfig?: TDoraConfigDts;
+};
+
+export type TDoraConfigDefine =
+  | PartialRecursive<TDoraConfig>
+  | ((env: 'development' | 'production') => PartialRecursive<TDoraConfig>);

package/src/env-params.ts

@@ -0,0 +1,4 @@
+export type TEnvParamsBase = {
+  workRootDir: string;
+  action: 'build' | 'server';
+};

package/src/index.ts

@@ -0,0 +1,10 @@
+export * from './cdn-type';
+export * from './dora-config';
+export * from './dora-config-common';
+export * from './dora-config-rollup';
+export * from './dora-config-service';
+export * from './dora-config-webpack';
+export * from './env-params';
+export * from './module-type';
+export * from './package-config';
+export * from './ts-config-file';

package/src/module-type.ts

@@ -0,0 +1,16 @@
+export type InternalModuleFormat =
+  | 'amd'
+  | 'cjs'
+  | 'es'
+  | 'iife'
+  | 'system'
+  | 'umd';
+
+export type TModule =
+  | InternalModuleFormat
+  | 'commonjs'
+  | 'esm'
+  | 'module'
+  | 'var'
+  | 'window'
+  | 'systemjs';

package/src/package-config.ts

@@ -0,0 +1,8 @@
+export type TPackageConfig = {
+  name?: string;
+  version?: string;
+  description?: string;
+  dependencies?: Record<string, string>;
+  devDependencies?: Record<string, string>;
+  peerDependencies?: Record<string, string>;
+};

package/src/ts-config-file.ts

@@ -0,0 +1,5 @@
+export type TTsConfig = {
+  compilerOptions: {
+    paths?: Record<string, string[]>;
+  };
+};