Mise à jour des packages de l’infrastructure SharePoint

Les outils de développement SharePoint côté client utilisent le gestionnaire de packages npm pour gérer les dépendances et autres ressources d’aide JavaScript requises. npm est généralement inclus dans le programme de configuration de Node.js.

Lorsque vous créez une nouvelle solution côté client, le générateur Yeoman de SharePoint extrait les derniers packages de SharePoint Framework requis pour votre projet côté client. Lors de la création de votre projet, vos packages peuvent devenir obsolètes si de nouvelles versions liées à un package ou plus sont publiées.

En fonction des notes de publication associées à une version spécifique ou au package le plus récent, vous pouvez décider de mettre à jour vos packages d’infrastructure SharePoint dans votre projet. Les packages d’infrastructure SharePoint incluent à la fois les packages npm que vous avez installés dans votre projet, par exemple : @microsoft/sp-core-library et les packages npm installés globalement, par exemple : @microsoft/generator-sharepoint.

Conseil

Bien que ce ne soit pas obligatoire, nous vous recommandons de mettre à jour les packages de SharePoint Framework fréquemment afin de bénéficier des dernières modifications et des derniers correctifs publiés.

Repérage des packages obsolètes

Pour trouver les packages obsolètes dans votre projet côté client, notamment des packages de l’infrastructure de SharePoint et autres dont votre projet dépend, exécutez la commande suivante dans une console, dans le même répertoire que celui de votre projet.

npm outdated

La commande répertorie les informations suivantes sur les packages dont dépend votre projet. Ces informations sont recherchées dans le fichier package.json situé dans la racine du répertoire de votre projet dans le registre npm.

  • Version actuelle installée dans votre projet
  • Version demandée par votre projet (disponible dans package.json)
  • Version la plus récente disponible

Packages NPM obsolètes

Pour repérer les packages SharePoint Framework, recherchez les noms de package qui commencent par le préfixe et l’étendue npm suivants :

@microsoft/sp-

Outre les paquets SharePoint Framework, vous devrez peut-être aussi mettre à jour les paquets react et office-ui-fabric-react. Vérifiez que vous lisez bien les notes et la feuille de route correspondant à cette version spécifique pour connaître les packages qui nécessitent des mises à jour.

Utiliser « NPM obsolète » avec un projet

SharePoint Server 2016 avec Feature Pack 2 prend en charge les solutions SharePoint Framework. SharePoint Server 2016 utilise une version de SharePoint Framework antérieure à la version disponible dans SharePoint Online.

Lorsque vous établissez la structure de nouveaux projets, le générateur Yeoman pour SharePoint Framework vous invite à indiquer si votre solution doit utiliser la dernière version de SharePoint Framework et SharePoint Online uniquement ou si elle doit utiliser une version plus ancienne de SharePoint Framework avec SharePoint Serveur 2016 et SharePoint Online.

Lorsque vous exécutez la commande npm obsolète dans un projet ciblant à la fois SharePoint Online et SharePoint Server 2016, elle indique les dernières versions des packages SharePoint Framework. Toutefois, ces versions fonctionnent uniquement avec SharePoint Online. Si vous mettez à jour votre solution pour qu’elle utilise ces derniers packages, elle ne fonctionnera plus avec SharePoint Server 2016.

Lorsque vous utilisez des solutions SharePoint Framework compatibles avec SharePoint hébergé localement, vous devez toujours vérifier le niveau de correctif de la batterie de serveurs SharePoint cible et la version de SharePoint Framework prise en charge.

Mettre à jour des packages

Lorsque vous effectuez une mise à jour vers des versions plus récentes, vous devez toujours utiliser votre gestionnaire de packages (npm ou Yarn). Nous vous recommandons de ne pas modifier manuellement le fichier package.json. Si vous suivez la pratique recommandée consistant à utiliser un fichier de verrouillage, les modifications que vous apportez au fichier package.json sont ignorées.

Commencez par identifier les packages qui nécessitent une mise à jour et la version la plus récente que vous souhaitez utiliser. Il n’est pas toujours possible d’utiliser la dernière version du package donné car il peut être incompatible avec d’autres dépendances de SharePoint Framework, telles que TypeScript.

Pour chaque package à mettre à jour, exécutez la commande suivante :

npm install mypackage@newversion --save

Par exemple, si vous utilisiez date-fns version v2.9.0 et que vous souhaitez effectuer une mise à jour vers la version 2.16.1, exécutez :

npm install date-fns@2.16.1 --save

La mise à jour du package à l’aide de npm installe la version spécifiée du package dans votre projet, et met à jour le numéro de version dans les dépendances du fichier package.json et le fichier de verrouillage utilisé dans votre projet.

Une fois que les packages sont installés, exécutez la commande suivante pour nettoyer les anciens artefacts de build :

gulp clean

Il est recommandé de supprimer tous les anciens packages en supprimant le dossier node_modules et de télécharger (c’est-à-dire, réinstaller) toutes les dépendances avec le package.json mis à jour. Sans cette étape, les anciennes versions peuvent entrer en conflit avec les versions plus récentes la prochaine fois que vous générez le projet.

npm install

Mettre à jour votre code

Selon l’importance des modifications apportées aux API, il se peut que vous deviez mettre à jour le code et les fichiers de configuration de votre projet. Pour chaque version, les notes de publication indiquent les modifications majeures et les changements que vous devez apporter à votre code. Vous devez veiller à apporter ces corrections à votre code.

Vous pouvez toujours générer le projet pour vérifier s’il renvoie des erreurs et des avertissements, en exécutant la commande suivante dans une console du répertoire de votre projet :

gulp build

Mise à jour du générateur Yeoman

Si vous avez installé le générateur Yeoman pour SharePoint Framework globalement, vous pouvez savoir s’il nécessite une mise à jour en exécutant la commande suivante :

npm outdated -g

La commande répertorie les informations suivantes sur les packages installés au niveau global sur votre ordinateur. Ces informations sont recherchées dans les versions installées sur votre ordinateur et sur le Registre npm.

  • Version actuelle installée au niveau global sur votre ordinateur
  • Version demandée par vous lors de l’installation
  • Version la plus récente disponible

Packages npm globaux obsolètes

Le package du générateur est celui qui porte le nom suivant :

@microsoft/generator-sharepoint

Mettre à jour le package du générateur

Ouvrez la console de votre choix et exécutez la commande suivante pour mettre à jour le générateur vers la dernière version publiée :

npm install @microsoft/generator-sharepoint@latest -g

La commande met à jour le générateur Yeoman pour SharePoint, ainsi que ses dépendances, vers la dernière version publiée. Vous pouvez vérifier que l’opération a fonctionné en exécutant la commande suivante dans la console :

npm ls @microsoft/generator-sharepoint -g --depth=0

Voir aussi