You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/develop/yeoman-generator-overview.md
+16-9Lines changed: 16 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,16 +2,16 @@
2
2
title: Create Office Add-in projects using the Yeoman Generator
3
3
description: Learn how to create Office Add-in projects using the Yeoman generator for Office Add-ins.
4
4
ms.topic: tutorial
5
-
ms.date: 04/12/2024
5
+
ms.date: 04/16/2025
6
6
ms.localizationpriority: high
7
7
---
8
8
9
9
# Create Office Add-in projects using the Yeoman Generator
10
10
11
-
The [Yeoman Generator for Office Add-ins](https://github.com/OfficeDev/generator-office) (also called "Yo Office") is an interactive Node.js-based command line tool that creates Office Add-in development projects. We recommend that you use this tool to create add-in projects except when you want the server-side code of the add-in to be in a .NET-based language (such as C# or VB.Net) or you want the add-in hosted in Internet Information Server (IIS). In either of the latter two situations, [use Visual Studio to create the add-in](develop-add-ins-visual-studio.md).
11
+
The [Yeoman Generator for Office Add-ins](https://github.com/OfficeDev/generator-office) (also called "Yo Office") is an interactive Node.js-based command line tool that creates Office Add-in development projects. These projects are Node.js-based. When you want the server-side code of the add-in to be in a .NET-based language (such as C# or VB.Net) or you want the add-in hosted in Internet Information Server (IIS), [use Visual Studio to create the add-in](develop-add-ins-visual-studio.md).
12
12
13
13
> [!NOTE]
14
-
> Office add-ins can also be created with the Teams Toolkit (Prerelease version). For more information about how to do this and the limitations, see [Create Office Add-in projects using the Teams Toolkit (preview)](teams-toolkit-overview.md).
14
+
> Office add-ins can also be created with the [Teams Toolkit](teams-toolkit-overview.md) or the [Office Add-in Development Kit](development-kit-overview.md).
15
15
16
16
The projects that the tool creates have the following characteristics.
17
17
@@ -27,7 +27,7 @@ The projects that the tool creates have the following characteristics.
27
27
> [!TIP]
28
28
> If you want to deviate from these choices significantly, such as using a different task runner or a different server, we recommend that when you run the tool you choose the [Manifest-only option](#manifest-only-option).
29
29
30
-
## Install the generator
30
+
## Prerequisites
31
31
32
32
>[!NOTE]
33
33
> If you aren't familiar with Node.js or npm, you should start by [setting up your development environment](../overview/set-up-your-dev-environment.md).
@@ -42,21 +42,24 @@ Start the tool with the following command in a system prompt (not a bash window)
42
42
yo office
43
43
```
44
44
45
-
A lot needs to load, so it may take 20 seconds before the tool starts. The tool asks you a series of questions. For some, you just type an answer to the prompt. For others, you're given a list of possible answers. If given a list, select one and then select Enter.
45
+
A lot needs to load, so it may take 40 seconds before the tool starts. The tool asks you a series of questions. For some, you just type an answer to the prompt. For others, you're given a list of possible answers. If given a list, use the up and down arrow keys to select one and then select <kbd>Enter</kbd>.
46
46
47
47
The first question asks you to choose between several types of projects. The options are:
48
48
49
49
-**Office Add-in Task Pane project**
50
+
-**Excel, PowerPoint, and/or Word Task Pane with unified manifest for Microsoft 365 (preview)**
50
51
-**Office Add-in Task Pane project using React framework**
51
52
-**Excel Custom Functions using a Shared Runtime**
52
53
-**Excel Custom Functions using a JavaScript-only Runtime**
53
54
-**Office Add-in Task Pane project supporting single sign-on**
-**Office Add-in project containing the manifest only**
55
57
56
58

57
59
58
60
> [!NOTE]
59
-
> The **Office Add-in project containing the manifest only** option produces a project that contains a basic add-in manifest and minimal scaffolding. For more information about the option, see [Manifest-only option](#manifest-only-option).
61
+
> - The **Office Add-in project containing the manifest only** option produces a project that contains a basic add-in manifest and minimal scaffolding. For more information about the option, see [Manifest-only option](#manifest-only-option).
62
+
> - The **Excel, PowerPoint, and/or Word Task Pane with unified manifest for Microsoft 365 (preview)** option creates a project for Excel, PowerPoint, Word, or all three, that uses the unified manifest for Microsoft 365. For more information about the option, see [Word, PowerPoint, or Excel with unified manifest option](#word-powerpoint-or-excel-with-unified-manifest-option).
60
63
61
64
The next question asks you to choose between **TypeScript** and **JavaScript**. (This question is skipped if you chose the manifest-only option in the preceding question.)
62
65
@@ -74,7 +77,7 @@ If you choose **Outlook** as the Office application, you get an additional quest
After you've answered this question, the generator creates the project and installs the dependencies. You may see **WARN** messages in the npm output on screen. You can ignore these. You may also see messages that vulnerabilities were found. You can ignore these for now, but you'll eventually need to fix them before your add-in is released to production. For more information about fixing vulnerabilities, open your browser and search for "npm vulnerability".
80
+
After you've answered all questions, the generator creates the project and installs the dependencies. You may see **WARN** messages in the npm output on screen. You can ignore these. You may also see messages that vulnerabilities were found. You can ignore these for now, but you'll eventually need to fix them before your add-in is released to production. For more information about fixing vulnerabilities, open your browser and search for "npm vulnerability".
78
81
79
82
If the creation is successful, you'll see a **Congratulations!** message in the command window, followed by some suggested next steps. (If you're using the generator as part of a quick start or tutorial, ignore the next steps in the command window and continue with the instructions in the article.)
80
83
@@ -88,7 +91,7 @@ If the creation is successful, you'll see a **Congratulations!** message in the
88
91
> When you're ready to install the dependencies, navigate to the root folder of the project in a command prompt and enter `npm install`.
89
92
90
93
> [!WARNING]
91
-
> If you choose **Office Add-in Task Pane project supporting single sign-on** and **TypeScript**, and you are using a Node.js version greater than 18.16.0, then a bug in Node.js causes the project file **\<root\>\src\middle-tier\ssoauth-helper.ts** to be corrupted. To fix it, copy the contents of the file from the repo, [ssoauth-helper.ts](https://github.com/OfficeDev/Office-Addin-Taskpane-SSO/blob/master/src/middle-tier/ssoauth-helper.ts), over the contents of the file in the generated project.
94
+
> If you choose **Office Add-in Task Pane project supporting single sign-on** and **TypeScript**, and you are using a Node.js version greater than 18.16.0, then a bug in Node.js may cause the project file **\<root\>\src\middle-tier\ssoauth-helper.ts** to be corrupted. To fix it, copy the contents of the file from the repo, [ssoauth-helper.ts](https://github.com/OfficeDev/Office-Addin-Taskpane-SSO/blob/master/src/middle-tier/ssoauth-helper.ts), over the contents of the file in the generated project.
92
95
93
96
## Manifest-only option
94
97
@@ -97,6 +100,10 @@ This option creates only a manifest for an add-in. The resulting project doesn't
97
100
- You want to use different tools from the ones a Yeoman generator project installs and configures by default. For example, you want to use a different bundler, transpiler, task runner, or development server.
98
101
- You want to use a web application development framework, other than React, such as Vue.
99
102
103
+
## Word, PowerPoint, or Excel with unified manifest option
104
+
105
+
The unified manifest for Microsoft 365 is in preview for Excel, PowerPoint, and Word add-ins. It should not be used for production add-ins, but you can select this option in Yo Office to create an add-in for one (or all three) of those Office applications. You'll be asked to choose which Office application. You can also choose **All** to create an add-in that is installable on all three Office applications. The project that is created uses TypeScript.
106
+
100
107
## Use command line parameters
101
108
102
109
You can also add parameters to the `yo office` command. The two most common are:
@@ -108,4 +115,4 @@ For detailed reference about the command line parameters, see the readme for the
108
115
109
116
## Troubleshooting
110
117
111
-
If you encounter problems using the tool, your first step should be to reinstall it to be sure that you have the latest version. (See [Install the generator](#install-the-generator) for details.) If doing so doesn't fix the problem, search the [issues of the GitHub repo for the tool](https://github.com/OfficeDev/generator-office/issues) to see if anyone else has encountered the same problem and found a solution. If no one has, [create a new issue](https://github.com/OfficeDev/generator-office/issues/new?assignees=&labels=needs+triage&template=bug_report.md&title=).
118
+
If you encounter problems using the tool, your first step should be to reinstall it to be sure that you have the latest version. (See [Prerequisites](#prerequisites) for details.) If doing so doesn't fix the problem, search the [issues of the GitHub repo for the tool](https://github.com/OfficeDev/generator-office/issues) to see if anyone else has encountered the same problem and found a solution. If no one has, [create a new issue](https://github.com/OfficeDev/generator-office/issues/new?assignees=&labels=needs+triage&template=bug_report.md&title=).
0 commit comments