# @fluidframework/fluid-runner 中文文档 规范地址：https://npmcn.com/package/%40fluidframework/fluid-runner/ 版本：3\.12\.0 npm 元数据更新时间：2026-11-10T22:58:50.246Z 中文译文更新时间：2026-11-15T02:33:49.782Z 软件包许可：MIT 本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。 原始 npm 页面：https://www.npmjs.com/package/%40fluidframework/fluid-runner 原文对照：https://npmcn.com/package/%40fluidframework/fluid-runner/?lang=original 项目主页：https://fluidframework.com/ 源码仓库：https://github.com/microsoft/FluidFramework ## 关键信息（来自 npm 元数据） - 包体积（解压后）：302 kB，137 个文件 - 模块格式：ES Module - TypeScript 类型：包内自带 - 运行依赖：10 个 - 首次发布：2022-07-28T16:49:36.992Z - 最新版本发布：2026-11-10T22:58:50.077Z - 近 30 天下载量：3811（2026-10-15 至 2026-11-13，npm 官方下载统计） - 已发布版本数：409（近 12 个月 48 个） ## 中文简介 在流体框架环境中运行各种功能的工具 ## 安装 ```sh npm install @fluidframework/fluid-runner ``` 也可以使用：`pnpm add @fluidframework/fluid-runner`、`yarn add @fluidframework/fluid-runner`、`bun add @fluidframework/fluid-runner` ## README # @ fluidframework/ fluid-runner (英语) 此软件包包含用于在流体框架环境中运行各种功能的功能 . ## 使用 Fluid 框架库 对于依赖流体框架库的公共API,我们建议 `^` (caret)版本范围. 例如,使用 `^1.3.4`。 。 。 . 依赖不稳定的API,例如: `beta` API,我们推荐一个更具限制性的版本范围. 例如,使用一个 `~` 版本范围. ## 安装 运行此命令以安装软件包 : ```bash npm i @fluidframework/fluid-runner ``` ## 从此软件包导入 此软件包使用 [packet.json 导出](https://nodejs.org/api/packages.html#exports) 通过支持级别将API分离. 有关支助保障的信息改为: [API 支持级别](https://fluidframework.com/docs/build/releases-and-apitags/#api-support-levels)。 。 。 . 导入 `public` API 从 `@fluidframework/fluid-runner`。 。 。 . 导入 `legacy` API 从 `@fluidframework/fluid-runner/legacy`。 。 。 . ## 导出文件 允许在给定的 ODSP 快照的容器上执行一些执行 . ### 样本命令 如果在全球安装软件包 : `node fluid-runner exportFile --codeLoader=compiledBundle.js --inputFile=inputFileName.fluid --outputFile=result.txt --telemetryFile=telemetryFile.txt` 如果直接使用此软件包 : `node bin/fluid-runner exportFile --codeLoader=compiledBundle.js --inputFile=inputFileName.fluid --outputFile=result.txt --telemetryFile=telemetryFile.txt` ### 代码装入器捆绑格式 编码装入器捆绑应规定这一功能所需的有定义的出口. 关于需要出口的更详细情况,见: [代码LoaderBundle.ts](https://npmcn.com/package/%40fluidframework/fluid-runner/src/codeLoaderBundle.ts)。 。 。 . #### "code Loader" vs "IFluid File Converter" 参数 您可能注意到命令行参数 `codeLoader` 是可选的。 如果您选择不为 `codeLoader`,您必须扩展此库 并提供一个 [`IFluidFileConverter`](https://npmcn.com/package/%40fluidframework/fluid-runner/src/codeLoaderBundle.ts) 联合国 [`fluidRunner(...)`](https://npmcn.com/package/%40fluidframework/fluid-runner/src/fluidRunner.ts) 方法. ```typescript import { fluidRunner } from "@fluidframework/fluid-runner"; await fluidRunner({ /* IFluidFileConverter implementation here */ }); ``` > **说明**: 只有一个 `codeLoader` 或者说 `fluidRunner(...)` 允许参数。 如果两者均提供或无提供,则在执行开始时会出现出错. ### 输入文件格式 输入文件预计将是ODSP快照. 关于一些实例,请参见 [本地 OdspSnapshot 文件夹](https://npmcn.com/package/%40fluidframework/fluid-runner/src/test/localOdspSnapshots)。 。 。 . ### 遥测格式 有一个可选的命令行选项 `telemetryFormat` 它允许您指定遥测输出格式。 此选项的命名很严格,必须匹配其中的选项 [输出格式](https://npmcn.com/package/%40fluidframework/fluid-runner/src/logger/fileLogger.ts)。 。 。 . 默认格式是当前 `JSON` ### 额外的遥测属性 有一个可选的命令行选项 `telemetryProp` 它允许您指定每个远程测量条目中将添加的额外属性。 格式遵循这些规则: - 每个密钥必须是字符串 - 值可以是字符串或数字 - 密钥和值不能为空 有效用法实例: ``` --telemetryProp prop1 value1 --telemetryProp prop2 10.5 --telemetryProp " prop1 " " value1 " prop2 value2 --telemetryProp prop1 "aaa=bbb" prop2 "aaa\"bbb" ``` > 引文中不修饰白- 空格 无效用法示例 : ``` --telemetryProp "10" value1 --telemetryProp prop1 --telemetryProp= // this will be treated as [''] ``` ### 消费 代码周围 `exportFile` 可以在多个不同的层被消耗. 无需像现在这样完全运行所有这些代码,以下是本工作流程中涉及的一些有趣的代码比特: - [`createLogger(...)`](https://npmcn.com/package/%40fluidframework/fluid-runner/src/logger/loggerUtils.ts) - 创建并包 `IFileLogger` 并在每个条目中添加一些有用的遥测数据 - [`createContainerAndExecute(...)`](https://npmcn.com/package/%40fluidframework/fluid-runner/src/exportFile.ts) - 这是基于本地 ODSP 快照运行一些动作的核心逻辑 - [`getSnapshotFileContent(...)`](https://npmcn.com/package/%40fluidframework/fluid-runner/src/utils.ts) - 从 JSON 和 二进制格式读取本地 ODSP 快照, 用于 `createContainerAndExecute(...)` 举例来说,消费途径略有不同: [`exportFile(...)`](https://npmcn.com/package/%40fluidframework/fluid-runner/src/exportFile.ts),参见 [`parseBundleAndExportFile(...)`](https://npmcn.com/package/%40fluidframework/fluid-runner/src/parseBundleAndExportFile.ts)。除了运行与 [`exportFile`](https://npmcn.com/package/%40fluidframework/fluid-runner/src/exportFile.ts) 方法,它执行围绕解析动态提供的捆绑路径的逻辑 `IFluidFileConverter` 对象. ## 贡献准则 你们可以 [贡献](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md) 通过这些方式实现流体框架: - 回答问题 [GitHub 讨论](https://github.com/microsoft/FluidFramework/discussions)。 。 。 . - [提交错误报告](https://github.com/microsoft/FluidFramework/issues) 并且帮助验证修正. - 审查 [源代码更改](https://github.com/microsoft/FluidFramework/pulls)。 。 。 . - [贡献错误修正](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md)。 。 。 . 详细指示改为: [repo 文档](https://github.com/microsoft/FluidFramework/blob/main/docs/content/Home.md)。 。 。 . 本项目遵循 [Microsoft 开源行为守则](https://opensource.microsoft.com/codeofconduct/)。 。 。 . 更多信息,改为: [《行为守则》经常被问到的问题](https://opensource.microsoft.com/codeofconduct/faq/)。 。 。 . 问题或评论,联系 [打开码@ microsoft.com](mailto:opencode@microsoft.com)。 。 。 . 这个项目可能包含微软项目的商标或标志,产品,或服务. 这些商标或标志的使用必须遵循微软 [商标和品牌准则](https://www.microsoft.com/trademarks)。 。 。 . 在这个项目的修改后版本中使用微软商标或标志不得造成混淆或暗示微软赞助. ## 帮助 读取 [流体框架文件](https://fluidframework.com/docs/) 用于了解流体框架概念和API. 要求提供文件未载列的资料, [创建问题](https://github.com/microsoft/FluidFramework/blob/main/docs/content/Contributing/Submitting-Bugs-and-Feature-Requests.md)。 。 。 . ## 商标 这个项目可能包含微软项目的商标或标志,产品,或服务. 这些商标或标志的使用必须遵循微软的 [商标和品牌准则](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general)。 。 。 . 在这个项目的修改后版本中使用微软商标或标志不得造成混淆或暗示微软赞助. ## 常见问题 ### @fluidframework/fluid-runner 是什么？ 在流体框架环境中运行各种功能的工具 ### 如何安装 @fluidframework/fluid-runner？ 在项目目录运行 npm install @fluidframework/fluid-runner，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 fluid-runner，可以用 npx fluid-runner 直接运行。 ### @fluidframework/fluid-runner 支持 TypeScript 吗？ 支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。 ### @fluidframework/fluid-runner 支持 ESM 还是 CommonJS？ 以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。 ### @fluidframework/fluid-runner 可以商用吗？ @fluidframework/fluid-runner 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。 ### @fluidframework/fluid-runner 的下载量有多少？ 根据 npm 官方下载统计，@fluidframework/fluid-runner 在 2026/10/15 – 2026/11/13 这 30 天内被下载 3,811 次，日均约 127 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。 ### @fluidframework/fluid-runner 还在维护吗？ 最新版本 3\.12\.0 发布于 2026/11/11（4 天前）；至今共发布 409 个版本，其中过去 12 个月发布了 48 个；首次发布于 2022/07/29。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。