使用 Yeoman 生成器创建 Office 外接程序项目 - Office Add-ins

适用于 Office 外接程序的 Yeoman 生成器 (也称为“Yo Office”) 是一种基于Node.js的交互式命令行工具，用于创建 Office 外接程序开发项目。建议使用此工具创建外接程序项目，除非你希望外接程序的服务器端代码位于中。基于 NET 的语言 (（如 C# 或 VB.Net) ），或者你希望外接程序托管在 Internet 信息服务器 (IIS) 。在后两种情况下之一，请使用 Visual Studio 创建加载项。

也可以使用 Teams 工具包 (预发行版本) 创建 Office 加载项。有关如何执行此操作和限制的详细信息，请参阅使用 Teams 工具包创建 Office 外接程序项目 (预览版) 。

该工具创建的项目具有以下特征。

它们具有包含 package.json 文件的标准 npm 配置。

它们包括几个有用的脚本，用于生成项目、启动服务器、旁加载 Office 中的加载项和其他任务。

它们使用 webpack 作为捆绑程序和基本任务运行程序。

在开发模式下，它们由基于 webpack 的基于Node.js的 webpack-dev-server 托管在 localhost 上，该服务器是支持热重载和更改时重新编译的面向开发的快速服务器版本。

默认情况下，工具会安装所有依赖项，但可以使用命令行参数推迟安装。

它们包括完整的外接程序清单。

它们具有一个“Hello World”级外接程序，该工具完成后即可运行。

它们包括一个 polyfill 和一个配置为将 TypeScript 和最新版本的 JavaScript 转译为 ES5 JavaScript 的转译器。这些功能可确保 Office 加载项可能运行的所有 Webview 运行时（包括 Trident (Internet Explorer) ）都支持加载项。

如果想要明显偏离这些选项（例如使用不同的任务运行器或其他服务器），建议在运行该工具时选择 “仅清单”选项。

安装生成器

如果不熟悉 Node.js 或 npm，请首先设置开发环境。

Node.js （最新 LTS 版本）。

最新版本的 Yeoman 和适用于 Office 加载项的 Yeoman 生成器。若要全局安装这些工具，请从命令提示符处运行以下命令。

npm install -g yo generator-office
即便先前已安装了 Yeoman 生成器，我们还是建议你通过 npm 将包更新为最新版本。
在系统提示符中使用以下命令启动该工具， (而不是 bash 窗口) 。
yo office 
需要加载大量内容，因此可能需要 20 秒才能启动该工具。 该工具会提出一系列问题。 对于某些用户，只需键入提示的答案即可。 对于其他人，系统会提供可能答案的列表。 如果提供了列表，请选择一个列表，然后选择 Enter。
第一个问题要求你在多种类型的项目之间进行选择。 选项包括：
Office 外接程序任务窗格项目
使用 React 框架的 Office 外接程序任务窗格项目
使用共享运行时的 Excel 自定义函数
使用仅限 JavaScript 的运行时的 Excel 自定义函数
支持单一登录的 Office 外接程序任务窗格项目
带有 Microsoft 365 统一清单的 Outlook 外接程序 (预览版) 
仅包含清单的 Office 外接程序项目
包含“仅清单”选项的 Office 外接程序项目生成包含基本外接程序清单和最小基架的项目。 有关选项的详细信息，请参阅 仅清单选项。
下一个问题要求你在 TypeScript 和 JavaScript 之间进行选择。  (如果在上一个问题中选择了“仅清单”选项，则会跳过此问题。) 
然后系统会提示你为加载项命名。 指定的名称将在加载项清单中使用，但稍后可以更改它。
然后，系统会提示你选择外接程序应在哪个 Office 应用程序中运行。 有六种可能的应用程序可供选择：Excel、OneNote、Outlook、PowerPoint、Project 和 Word。 只能选择一个，但稍后可以更改清单以支持其他 Office 应用程序。 Outlook 除外。 支持 Outlook 的清单不能支持任何其他 Office 应用程序。
回答此问题后，生成器将创建项目并安装依赖项。 你可能会在屏幕上的 npm 输出中看到 WARN 消息。 可以忽略这些内容。 还可能会看到发现漏洞的消息。 暂时可以忽略这些内容，但最终需要在加载项发布到生产环境之前对其进行修复。 有关修复漏洞的详细信息，请打开浏览器并搜索“npm 漏洞”。
如果创建成功，你将在命令窗口中看到“ 恭喜！” 消息，后跟一些建议的后续步骤。  (如果在快速入门或教程中使用生成器，请忽略命令窗口中的后续步骤，继续执行文章中的说明。) 
如果要创建 Office 外接程序项目的基架，但要推迟依赖项的安装，请将 选项添加到 --skip-installyo office 命令。 以下代码是一个示例。
yo office --skip-install
准备好安装依赖项时，请在命令提示符中导航到项目的根文件夹，并输入 npm install。
“仅清单”选项
此选项仅为加载项创建清单。 生成的项目没有Hello World加载项、任何脚本或任何依赖项。 在以下方案中使用此选项。
你希望使用 Yeoman 生成器项目默认安装和配置的工具中的不同工具。 例如，你想要使用不同的捆绑程序、转码器、任务运行器或开发服务器。
你想要使用除 React 以外的 Web 应用程序开发框架，例如 Vue。
有关使用生成器和仅清单选项的示例，请参阅 使用 Vue 生成 Excel 任务窗格加载项。
使用命令行参数
还可以向 命令添加参数 yo office 。 两种最常用的查询为：
yo office --details：这将输出有关所有其他命令行参数的简短帮助。
yo office --skip-install：这将阻止生成器安装依赖项。
有关命令行参数的详细参考，请参阅 Office 外接程序的 Yeoman 生成器中的生成器自述文件。
如果在使用该工具时遇到问题，第一步应该是重新安装它，以确保你拥有最新版本。  (有关详细信息，请参阅 安装生成器 。) 如果这样做无法解决问题，请在 GitHub 存储库中搜索该工具的问题 ，查看是否有其他人遇到过同一问题并找到解决方案。 如果没有人，请 创建一个新问题。