Erstellen von Gerüsten für Projekte unter Verwendung des Yeoman-Generators von SharePointScaffold projects by using Yeoman SharePoint generator

Yeoman hilft Ihnen bei den ersten Schritten mit neuen Projekten und stellt bewährte Methoden und Tools bereit, mit denen Sie produktiv arbeiten können.Yeoman helps you to kickstart new projects, prescribing best practices and tools to help you stay productive. Unter Verwendung des Yeoman-Generators von SharePoint können Entwickler Gerüste für neue clientseitige Lösungsprojekte zum Erstellen, Verpacken und Bereitstellen von SharePoint-Lösungen bereitstellen.Using the Yeoman SharePoint generator, developers are able to scaffold new client-side solution projects to build, package, and deploy SharePoint solutions. Der Generator bietet allgemeine Buildtools, Codebausteine und eine allgemeine Textwebsite zum testweisen Hosten von Webparts.The generator provides common build tools, boilerplate code, and a common playground website to host web parts for testing.

Installieren des Yeoman SharePoint-GeneratorsInstall the Yeoman SharePoint generator

Der Yeoman SharePoint-Generator steht als Teil des Framework als ein npm-Paket zur Verfügung.Yeoman SharePoint generator is available as part of the framework as an npm package. Sie können den Generator installieren, indem Sie den folgenden Befehl in einer Konsole ausführen:You can install the generator by executing the following command in a console:

npm install @microsoft/generator-sharepoint -g

Hinweis

Der Yeoman-Generator für SharePoint ist für die globale Bereitstellung mit der Erstversion General Availability (GA) vorgesehen.The Yeoman SharePoint generator is targeted to get deployed globally with the initial General Availability (GA) version. Bei lokaler Installation im Projekt treten bekannte Probleme auf, die nach der GA-Version behoben werden.There are some known issues if it's installed locally to the project, which are planned to be addressed post-GA.

Es wird empfohlen, dass Sie die Anweisungen zur die Einrichtung Ihrer Entwicklungsumgebung befolgen, um Ihren Computer mit dem vollständigen Satz der Entwicklertools, einschließlich Yeoman SharePoint-Generator, zu konfigurieren.We recommend that you follow the set up your development environment instructions to configure your machine with the complete set of developer tools, including Yeoman SharePoint generator.

Verwenden des Yeoman SharePoint-GeneratorsUse the Yeoman SharePoint generator

Nach der Installation des Generators können Sie den Generator aufrufen, indem Sie einfach den folgenden Befehl in einer Konsole eingeben:After the generator is installed, you can invoke the generator by just typing the following command in a console:

yo

Der Befehl führt alle der auf Ihrem Computer verfügbaren Generatoren auf.The command lists all the generators available on your machine. Wählen Sie @microsoft/sharepoint aus, um den SharePoint-Generator aufzurufen, und fahren Sie mit den Aufforderungen fort, um die clientseitige Lösung erfolgreich zu erstellen:Select @microsoft/sharepoint to invoke the SharePoint generator and continue with the prompts to successfully create your client-side solution:

Yeoman SharePoint-Generator

Verwenden der verfügbaren Befehlszeilenoptionen für den GeneratorUse available command-line options for the generator

Sie können die im Yeoman SharePoint-Generator verfügbaren Befehlszeilenoptionen verwenden, um Gerüste für Projekte in einem Befehl anstelle der Aufforderungen zu erstellen.You can use the command-line options available with the Yeoman SharePoint generator to scaffold projects in one command instead of going through the prompts. Führen Sie den folgenden Befehl aus, um die Liste der für den SharePoint-Generator verfügbaren Befehlszeilenoptionen anzuzeigen:Execute the following command to see the list of command-line options available for the SharePoint generator:

yo @microsoft/sharepoint --help

Befehlszeilenoptionen für den Yeoman SharePoint-Generator


BefehlszeilenoptionenCommand-line options

OptionOption BeschreibungDescription
--help--help Ausgabe der Generator-Optionen und -Nutzung.Print the generator's options and usage.
--skip-cache--skip-cache Antworten der Eingabeaufforderungen werden nicht gespeichert.Do not remember prompt answers. Standard: False.Default: false.
--skip-install--skip-install Abhängigkeiten werden nicht automatisch installiert.Do not automatically install dependencies. Standard: False.Default: false.
--component-type--component-type Der Typ der Komponente.The type of component. Derzeit werden "Webpart", "Extension" oder "Library" unterstützt.Currently "webpart", "extension", or "library" is supported.
--component-description--component-description Beschreibung der Komponente.Description of the component.
--component-name--component-name Name der Komponente.Name of the component.
--framework--framework Für die Lösung zu verwendendes Framework. Wählen Sie eine Option aus „Keines“, „React“, „Knockout“ aus.Framework to use for the solution. Choose one from "none", "react", "knockout".
--plusbeta--plusbeta Verwenden Sie die Beta-Pakete.Use the beta packages. Der Gerüstbau sollte mit @plusbeta erfolgenScaffolding should be done with @plusbeta
--extension-type--extension-type Der Typ der Erweiterung: Derzeit „ApplicationCustomizer“, „FieldCustomizer“, „ListViewCommandSet“The type of extension: Currently ApplicationCustomizer, FieldCustomizer, ListViewCommandSet.
--solution-name--solution-name Clientseitiger Lösungsname und Ordnername.Client-side solution name, as well as folder name.
--environment--environment Die Zielumgebung für die Lösung.The target environment for the solution. Entweder „onprem“, „onprem19“ oder „spo“.Either "onprem", "onprem19" or "spo".
--package-manager--package-manager Der Paketmanager für die Lösung.The package manager for the solution. Optionen sind „npm“, „pnpm“ oder „yarn“.Options are: "npm", "pnpm", or "yarn". Standard: npmDefault: npm
--skip-feature-deployment--skip-feature-deployment Wenn angegeben, können Mandantenadministratoren festlegen, ob die Komponenten unmittelbar für alle Websites bereitgestellt werden, ohne die Bereitstellung von Features oder das Hinzufügen von Apps zu Websites.If specified, allow the tenant admin the choice of being able to deploy the components to all sites immediately without running any feature deployment or adding apps in sites. Standard: False.Default: false.
--is-domain-isolated--is-domain-isolated Wenn "y", wird das Webpart in einer isolierten Domäne mit IFRAME gerendert.If 'y', web part will be rendered in isolated domain using IFrame. Bei Festlegung auf "y" wird der Typ der Komponente als Webpart festgelegt.If set to "y", sets the component type as web part.

Warnung

Die Befehlszeilenunterstützung für skip-feature-deployment wurde in SharePoint Framework v1.5 eingeführt.skip-feature-deployment command line support was introduced with the SharePoint Framework v1.5. Diese Option war zuvor ein Befehlszeilenargument namens skipFeatureDeployment.This option was previously a command line argument called skipFeatureDeployment. solution-name, extension-type, component-type, component-description und component-name wurden ebenfalls umbenannt.Also solution-name, extension-type, component-type, component-description and component-name have been renamed.

Nachfolgend sehen Sie ein Beispiel eines Befehls, der eine Lösung mit dem Namen „hello-world“ erstellt:Following is an example of a command that creates a solution called "hello-world" with:

  • Das Webpart "HelloWorld"A web part "HelloWorld"
  • Das "React"-Framework, das nur auf SharePoint Online abzieltThe "react" framework targeted only to SharePoint Online
  • Mandantenweite Bereitstellung (optional aktiviert)Tenant-scoped deployment optional enabled

Beachten Sie, dass bei einigen Optionen Abhängigkeiten untereinander bestehen.Notice that some of the options have dependencies between each other. Sie können zum Beispiel die Erweiterung nicht mit der lokalen Option erstellen.You cannot, for example, create an extension with an on-premises option.

yo @microsoft/sharepoint 
--solution-name "hello-world" 
--framework "react" 
--component-type "webpart" 
--component-name "HelloWorld" 
--component-description "HelloWorld web part" 
--skip-install 
--environment "spo" 
--skip-feature-deployment true

Hinweis

Mithilfe des --skip-install-Befehls wird ein Gerüst für das Projekt erstellt, und die Installation von Abhängigkeiten wird übersprungen.Using the --skip-install command scaffolds the project and skips installing dependencies. Dies bedeutet, dass Sie für ein erfolgreiches Erstellen des Projekts die Abhängigkeiten später installieren müssen, nachdem ein Gerüst für das Projekt erstellt wurde.This means that to successfully build the project, you need to install the dependencies later after the project is scaffolded.

Wenn Sie versuchen, das Projekt zu erstellen, ohne die Abhängigkeiten zu installieren, wird der folgende Fehler zurückgegeben.If you try to build your project without installing the dependencies, you get the following error. Dies deutet darauf hin, dass Sie die Abhängigkeiten installieren müssen, bevor Sie das Projekt erstellen:This indicates that you need to install the dependencies before building the project:

Local gulp not found in ~/<project-name>
Try running: npm install gulp

Zum Installieren der Abhängigkeiten können Sie den folgenden Befehl ausführen:You can execute the following command to install the dependencies:

npm install

Siehe auchSee also