Génération automatique de modèles de projet à l’aide du générateur Yeoman SharePoint

Yeoman vous permet de lancer de nouveaux projets, en vous fournissant des pratiques recommandées et des outils pour vous aider à rester productif. En utilisant le générateur Yeoman SharePoint, les développeurs peuvent générer automatiquement des modèles pour les projets de solution côté client afin de générer, mettre en package et déployer des solutions SharePoint. Le générateur fournit des outils de génération, du code réutilisable et un site web d’essai qui vous permettent d’héberger des composants WebPart pour les tester.

Installation du générateur Yeoman SharePoint

Le générateur Yeoman SharePoint est disponible dans le cadre de l’infrastructure en tant que package npm. Vous pouvez installer le générateur en exécutant la commande suivante dans une console :

npm install @microsoft/generator-sharepoint -g

Notes

Le générateur Yeoman SharePoint sera normalement déployé mondialement avec la version de disponibilité générale initiale. Certains problèmes peuvent se produire quand il est installé localement avec le projet ; ces problèmes devaient être résolus après la publication de la version de disponibilité générale.

Nous vous recommandons de suivre la procédure de configuration de votre environnement de développement pour configurer votre ordinateur avec l’ensemble complet d’outils de développement, y compris le générateur Yeoman SharePoint.

Utilisation du générateur Yeoman SharePoint

Une fois le générateur installé, vous pouvez l’appeler en saisissant simplement la commande suivante dans une console :

yo

La commande répertorie tous les générateurs disponibles sur votre ordinateur. Sélectionnez @ microsoft/sharepoint pour appeler le générateur SharePoint et continuez avec les invites pour créer votre solution côté client :

Générateur Yeoman SharePoint

Utilisation des options de ligne de commande disponibles pour le générateur

Vous pouvez utiliser les options de ligne de commande disponibles avec le générateur Yeoman SharePoint pour générer automatiquement des modèles de projet dans une seule commande au lieu de suivre les invites. Exécutez la commande suivante pour afficher la liste des options de ligne de commande disponibles pour le générateur SharePoint :

yo @microsoft/sharepoint --help

Options de ligne de commande du générateur Yeoman SharePoint

Options de ligne de commande**

Pour afficher la liste des options de ligne de commande, passez --help l’argument lors de l’exécution du générateur :

yo @microsoft/sharepoint --help

Voici un exemple de commande permettant de créer une solution appelée « hello-world » avec :

  • un composant WebPart « HelloWorld » ;
  • l’infrastructure « react » destinée uniquement à SharePoint Online ;
  • le déploiement dans l’étendue client facultatif activé.

Certaines options ont des dépendances entre elles. Par exemple, vous ne pouvez pas créer d’extension avec l’option Local.

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

Notes

À l’aide de la commande --skip-install, vous pouvez générer automatiquement des modèles de projet et ignorer les dépendances pendant l’installation. Cela signifie que, pour générer le projet, vous devez installer les dépendances une fois que les modèles du projet sont générés.

Si vous essayez de générer le projet sans installer les dépendances, vous obtenez l’erreur ci-dessous. Celle-ci indique que vous devez installer les dépendances avant la génération du projet :

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

Vous pouvez exécuter la commande suivante pour installer les dépendances :

npm install

Voir aussi