Erstellen von Office-Add-In-Projekten mithilfe des Yeoman-Generators

Der Yeoman-Generator für Office-Add-Ins (auch "Yo Office" genannt) ist ein interaktives, auf Node.js basierendes Kommandozeilentool, das Office-Add-In-Entwicklungsprojekte erstellt. Diese Projekte basieren auf Node.js. Wenn der serverseitige Code des Add-Ins in einer .NET-basierten Sprache (wie C# oder VB.Net) geschrieben sein soll oder das Add-In in Internet Information Server (IIS) gehostet werden soll, verwenden Sie Visual Studio, um das Add-In zu erstellen.

Die Projekte, die das Tool erstellt, weisen die folgenden Merkmale auf.

• Sie verfügen über eine standardmäßige npm-Konfiguration, die eine package.json-Datei enthält.
• Sie enthalten mehrere hilfreiche Skripts zum Erstellen des Projekts, zum Starten des Servers, zum Querladen des Add-Ins in Office und anderen Aufgaben.
• Sie verwenden Webpack als Bundler und einfache Aufgabenausführung.
• Im Entwicklungsmodus werden sie auf localhost vom Node.js-basierten webpack-dev-server von webpack gehostet, einer entwicklungsorientierten Version des Express-Servers, die Hot-Reloading und automatisches Neukompilieren bei Änderungen unterstützt.
• Standardmäßig installiert das Tool alle Abhängigkeiten, aber Sie können die Installation mit einem Befehlszeilenargument verzögern.
• Sie enthalten ein vollständiges Add-In-Manifest.
• Sie verfügen über ein Add-in auf „Hello World“-Niveau, das sofort nach Fertigstellung des Tools einsatzbereit ist.
• Sie enthalten einen Transpiler zum Transpilieren von TypeScript in ES5 JavaScript und einen Polyfill, damit ES5 JavaScript Features aus späteren JavaScript-Versionen verwenden kann. Gemeinsam bieten sie Abwärtskompatibilität zu Vorgänger-Webviews wie Trident (Internet Explorer), obwohl Microsoft die Entwicklung von Add-Ins für Office-Versionen, die diese alten Webviews verwenden, nicht unterstützt.

Voraussetzungen

• Node.js (die aktuellsteLTS-Version). Besuchen Sie die Node.js-Website, um die richtige Version für Ihr Betriebssystem herunterzuladen und zu installieren.

• Die neueste Version von Yeoman und des Yeoman-Generators für Office-Add-Ins. Um diese Tools global zu installieren, führen Sie den folgenden Befehl an der Eingabeaufforderung aus.

  npm install -g yo generator-office
  

  Hinweis

  Selbst wenn Sie bereits den Yeoman-Generator installiert haben, empfehlen wir Ihnen, das npm-Paket auf die neueste Version zu aktualisieren.

• Office in Verbindung mit einem Microsoft 365-Abonnement (einschließlich Office im Internet).

  Hinweis

  Wenn Sie noch nicht über Office verfügen, können Sie sich über das Microsoft 365-Entwicklerprogramm für ein Microsoft 365 E5-Entwicklerabonnement qualifizieren. Weitere Informationen finden Sie in den FAQ. Alternativ können Sie sich für eine kostenlose 1-monatige Testversion registrieren oder einen Microsoft 365-Plan erwerben.

Verwenden des Tools

Starten Sie das Tool mit dem folgenden Befehl in einer Systemeingabeaufforderung (nicht in einem Bash-Fenster). Dadurch wird ein neues Projekt in einem neuen Ordner im aktuellen Verzeichnis erstellt.

yo office 

Es muss viel geladen werden, sodass es 40 Sekunden dauern kann, bis das Tool gestartet wird. Das Tool stellt Ihnen eine Reihe von Fragen. Bei einigen geben Sie einfach eine Antwort auf die Eingabeaufforderung ein. Für andere erhalten Sie eine Liste möglicher Antworten. Wenn eine Liste angezeigt wird, verwenden Sie die Pfeiltasten nach oben und unten, um eine Auswahl zu treffen, und drücken Sie dann Enter.

Die erste Frage fordert Sie auf, zwischen verschiedenen Projektarten zu wählen. Mögliche Optionen:

• Office-Add-In-Aufgabenbereichsprojekt
• Excel-, PowerPoint- und/oder Word-Aufgabenbereich mit einheitlichem Manifest für Microsoft 365 (Vorschau)
• Office-Add-In-Aufgabenbereichsprojekts mithilfe des React-Frameworks
• Benutzerdefinierte Excel-Funktionen mit einer freigegebenen Runtime
• Benutzerdefinierte Excel-Funktionen mit einer reinen JavaScript-Runtime
• Office-Add-In-Aufgabenbereichsprojekt zur Unterstützung des einmaligen Anmeldens
• Office-Add-In-Aufgabenbereichsprojekt mit Unterstützung des einmaligen Anmeldens für geschachtelte App-Authentifizierung (Vorschau)
• Office-Add-In-Projekt, das nur das Manifest enthält

Bei der nächsten Frage wählen Sie zwischen TypeScript und JavaScript. (Diese Frage wird übersprungen, wenn Sie in der vorherigen Frage die Nur Manifest-Option ausgewählt haben.)

Anschließend werden Sie aufgefordert, dem Add-In einen Namen zu geben. Der von Ihnen angegebene Name wird im Manifest des Add-Ins verwendet, aber Sie können ihn später ändern. Dies ist auch der Ordnername für das Projekt.

Anschließend werden Sie aufgefordert, die Office-Anwendung auszuwählen, in der das Add-In ausgeführt werden soll. Es stehen sechs mögliche Anwendungen zur Auswahl: Excel, OneNote, Outlook, PowerPoint, Project und Word. Sie müssen genau eine auswählen, können das Manifest aber später ändern, um weitere Office-Anwendungen zu unterstützen. Die Ausnahme bildet Outlook. Ein Manifest, das Outlook unterstützt, kann keine anderen Office-Anwendungen unterstützen.

Wenn Sie Outlook als Office-Anwendung auswählen, erhalten Sie eine zusätzliche Frage, welche Art von Manifest Sie verwenden möchten. Es wird empfohlen, dass Sie das einheitliche Manifest für Microsoft 365 auswählen, es sei denn, Ihr Add-In enthält ein Erweiterbarkeitsfeature, das noch nicht vom einheitlichen Manifest unterstützt wird.

Nachdem Sie alle Fragen beantwortet haben, erstellt der Generator das Projekt und installiert die Abhängigkeiten. Möglicherweise werden WARN-Meldungen in der npm-Ausgabe auf dem Bildschirm angezeigt. Sie können diese ignorieren. Möglicherweise werden auch Meldungen angezeigt, dass Sicherheitsrisiken gefunden wurden. Sie können diese vorerst ignorieren, aber Sie müssen sie irgendwann beheben, bevor Ihr Add-In für die Produktion freigegeben wird. Weitere Informationen finden Sie unter Warnungen und Abhängigkeiten in der Node.js- und npm-Welt.

Wenn die Erstellung erfolgreich war, wird im Befehlsfenster die Meldung Herzlichen Glückwunsch! angezeigt, gefolgt von einigen vorgeschlagenen nächsten Schritten. (Wenn Sie den Generator im Rahmen eines Schnellstarts oder Tutorials verwenden, ignorieren Sie die nächsten Schritte im Befehlsfenster und folgen Sie den Anweisungen im Artikel.)

yo office --skip-install

Option „Nur Manifest“

Mit dieser Option wird nur ein Manifest für ein Add-In erstellt. Das resultierende Projekt verfügt nicht über ein Hallo Welt-Add-In, keines der Skripts oder eine der Abhängigkeiten. Verwenden Sie diese Option in den folgenden Szenarien.

• Sie möchten andere Tools als die Tools verwenden, die ein Yeoman-Generatorprojekt standardmäßig installiert und konfiguriert. Sie möchten z. B. einen anderen Bundler, Transpiler, eine andere Aufgabenausführung oder einen anderen Entwicklungsserver verwenden.
• Sie möchten ein anderes Webanwendungsentwicklungsframework als React verwenden, z. B. Vue.

Word, PowerPoint oder Excel mit einheitlicher Manifestoption

Das einheitliche Manifest für Microsoft 365 befindet sich in der Vorschau für Excel-, PowerPoint- und Word-Add-ins. Es sollte nicht für Produktions-Add-ins verwendet werden, aber Sie können diese Option in Yo Office auswählen, um ein Add-in für eine (oder alle drei) dieser Office-Anwendungen zu erstellen. Sie werden aufgefordert, die Office-Anwendung auszuwählen. Sie können auch Alle auswählen, um ein Add-In zu erstellen, das in allen drei Office-Anwendungen installiert werden kann. Das erstellte Projekt verwendet TypeScript.

Verwenden von Befehlszeilenparametern

Sie können dem yo office Befehl auch Parameter hinzufügen. Die beiden am häufigsten vorkommenden sind:

• yo office --details: Dies gibt eine kurze Hilfe zu allen anderen Befehlszeilenparametern aus.
• yo office --skip-install: Dadurch wird verhindert, dass der Generator die Abhängigkeiten installiert.

Eine ausführliche Referenz zu den Befehlszeilenparametern finden Sie in der Infodatei für den Generator unter Yeoman-Generator für Office-Add-Ins.

Problembehandlung

Wenn bei der Verwendung des Tools Probleme auftreten, sollten Sie es zunächst erneut installieren, um sicherzustellen, dass Sie über die neueste Version verfügen. (Weitere Informationen finden Sie unter Voraussetzungen.) Wenn das Problem dadurch nicht behoben wird, durchsuchen Sie die Probleme des GitHub-Repositorys nach dem Tool, um festzustellen, ob dasselbe Problem bei einer anderen Person aufgetreten ist und eine Lösung gefunden wurde. Wenn niemand dies hat, erstellen Sie ein neues Issue.