Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 | 1x 8x 8x 1x 8x 1x 7x 6x 6x 8x 8x 8x 8x 2x 1x 1x 2x 2x 8x 2x 2x 8x 2x 2x 8x 8x | import type { Esmx } from './core';
/**
* 软件包打包配置接口。
* 用于将服务的构建产物打包成标准的 npm .tgz 格式软件包。
*
* 特点：
* - **标准化**：使用 npm 标准的 .tgz 打包格式
* - **完整性**：包含模块的源代码、类型声明和配置文件等所有必要文件
* - **兼容性**：与 npm 生态系统完全兼容，支持标准的包管理工作流
*
* 使用场景：
* - 模块打包发布
* - 版本发布管理
* - CI/CD 流程集成
*
* @example
* ```ts
* // entry.node.ts
* import type { EsmxOptions } from '@esmx/core';
*
* export default {
* modules: {
* // 配置需要导出的模块
* exports: [
* 'root:src/components/button.vue',
* 'root:src/utils/format.ts',
* 'npm:vue',
* 'npm:vue-router'
* ]
* },
* // 打包配置
* pack: {
* // 启用打包功能
* enable: true,
*
* // 同时输出多个版本
* outputs: [
* 'dist/versions/latest.tgz',
* 'dist/versions/1.0.0.tgz'
* ],
*
* // 自定义 package.json
* packageJson: async (esmx, pkg) => {
* pkg.name = '@your-scope/your-app';
* pkg.version = '1.0.0';
* // 添加构建脚本
* pkg.scripts = {
* "prepare": "npm run build",
* "build": "npm run build:dts && npm run build:ssr",
* "build:ssr": "esmx build",
* "build:dts": "tsc --declaration --emitDeclarationOnly --outDir dist/src"
* };
* return pkg;
* },
*
* // 打包前准备
* onBefore: async (esmx, pkg) => {
* // 添加必要文件
* await fs.writeFile('dist/README.md', '# Your App\n\n模块导出说明...');
* // 执行类型检查
* await runTypeCheck();
* },
*
* // 打包后处理
* onAfter: async (esmx, pkg, file) => {
* // 发布到私有 npm 镜像源
* await publishToRegistry(file, {
* registry: 'https://npm.your-registry.com/'
* });
* // 或部署到静态服务器
* await uploadToServer(file, 'https://static.example.com/packages');
* }
* }
* } satisfies EsmxOptions;
* ```
*/
export interface PackConfig {
/**
* 是否启用打包功能。
* 启用后会将构建产物打包成标准的 npm .tgz 格式软件包。
* @default false
*/
enable?: boolean;
/**
* 指定输出的软件包文件路径。
* 支持以下配置方式：
* - string: 单个输出路径，如 'dist/versions/my-app.tgz'
* - string[]: 多个输出路径，用于同时生成多个版本
* - boolean: true 时使用默认路径 'dist/client/versions/latest.tgz'
*
* @example
* ```ts
* // 单个输出
* outputs: 'dist/app.tgz'
*
* // 多个版本
* outputs: [
* 'dist/versions/latest.tgz',
* 'dist/versions/1.0.0.tgz'
* ]
*
* // 使用默认路径
* outputs: true
* ```
*
* @default 'dist/client/versions/latest.tgz'
*/
outputs?: string | string[] | boolean;
/**
* package.json 处理函数。
* 在打包前调用，用于自定义 package.json 的内容。
*
* 常见用途：
* - 修改包名和版本号
* - 添加或更新依赖项
* - 添加自定义字段
* - 配置发布相关信息
*
* @param esmx - Esmx 实例
* @param pkgJson - 原始的 package.json 内容
* @returns 处理后的 package.json 内容
*
* @example
* ```ts
* packageJson: async (esmx, pkg) => {
* // 设置包信息
* pkg.name = 'my-app';
* pkg.version = '1.0.0';
* pkg.description = '我的应用';
*
* // 添加依赖
* pkg.dependencies = {
* 'vue': '^3.0.0',
* 'express': '^4.17.1'
* };
*
* // 添加发布配置
* pkg.publishConfig = {
* registry: 'https://registry.example.com'
* };
*
* return pkg;
* }
* ```
*/
packageJson?: (
esmx: Esmx,
pkgJson: Record<string, any>
) => Promise<Record<string, any>>;
/**
* 打包前的钩子函数。
* 在生成 .tgz 文件之前调用，用于执行准备工作。
*
* 常见用途：
* - 添加额外的文件（README、LICENSE 等）
* - 执行测试或构建验证
* - 生成文档或元数据
* - 清理临时文件
*
* @param esmx - Esmx 实例
* @param pkgJson - 处理后的 package.json 内容
*
* @example
* ```ts
* onBefore: async (esmx, pkg) => {
* // 添加文档
* await fs.writeFile('dist/README.md', '# My App');
* await fs.writeFile('dist/LICENSE', 'MIT License');
*
* // 执行测试
* await runTests();
*
* // 生成文档
* await generateDocs();
* }
* ```
*/
onBefore?: (esmx: Esmx, pkgJson: Record<string, any>) => Promise<void>;
/**
* 打包后的钩子函数。
* 在 .tgz 文件生成后调用，用于处理打包产物。
*
* 常见用途：
* - 发布到 npm 仓库（公共或私有）
* - 上传到静态资源服务器
* - 执行版本管理
* - 触发 CI/CD 流程
*
* @param esmx - Esmx 实例
* @param pkgJson - 最终的 package.json 内容
* @param file - 生成的 .tgz 文件内容
*
* @example
* ```ts
* onAfter: async (esmx, pkg, file) => {
* // 发布到 npm 私有仓库
* await publishToRegistry(file, {
* registry: 'https://registry.example.com'
* });
*
* // 上传到静态资源服务器
* await uploadToServer(file, 'https://assets.example.com/packages');
*
* // 创建版本标签
* await createGitTag(pkg.version);
*
* // 触发部署流程
* await triggerDeploy(pkg.version);
* }
* ```
*/
onAfter?: (
esmx: Esmx,
pkgJson: Record<string, any>,
file: Buffer
) => Promise<void>;
}
/**
* PackConfig 配置解析后的内部接口。
* 将用户配置标准化，设置默认值，便于框架内部使用。
*
* 主要处理：
* - 确保所有可选字段都有默认值
* - 统一输出路径格式
* - 标准化回调函数
*/
export interface ParsedPackConfig {
/**
* 是否启用打包功能。
* 解析后总是有确定的布尔值。
* @default false
*/
enable: boolean;
/**
* 解析后的输出文件路径列表。
* 将所有输出格式统一转换为字符串数组：
* - 布尔值 true → ['dist/client/versions/latest.tgz']
* - 字符串 → [输入的字符串]
* - 字符串数组 → 保持不变
*/
outputs: string[];
/**
* 标准化的 package.json 处理函数。
* 未配置时使用默认函数，保持原始内容不变。
*/
packageJson: (
esmx: Esmx,
pkgJson: Record<string, any>
) => Promise<Record<string, any>>;
/**
* 标准化的打包前钩子函数。
* 未配置时使用空函数。
*/
onBefore: (esmx: Esmx, pkgJson: Record<string, any>) => Promise<void>;
/**
* 标准化的打包后钩子函数。
* 未配置时使用空函数。
*/
onAfter: (
esmx: Esmx,
pkgJson: Record<string, any>,
file: Buffer
) => Promise<void>;
}
export function parsePackConfig(config: PackConfig = {}): ParsedPackConfig {
const outputs: string[] = [];
if (typeof config.outputs === 'string') {
outputs.push(config.outputs);
} else if (Array.isArray(config.outputs)) {
outputs.push(...config.outputs);
} else if (config.outputs !== false) {
outputs.push('dist/client/versions/latest.tgz');
}
return {
enable: config.enable ?? false,
outputs,
async packageJson(esmx, pkgJson) {
if (config.packageJson) {
pkgJson = await config.packageJson(esmx, pkgJson);
}
return pkgJson;
},
async onBefore(esmx, pkgJson: Record<string, any>) {
await config.onBefore?.(esmx, pkgJson);
},
async onAfter(esmx, pkgJson, file) {
await config.onAfter?.(esmx, pkgJson, file);
}
};
}
|