更新 SharePoint Framework 包

SharePoint 客户端开发工具通过 npm 软件包管理器管理依赖项和其他所需的 JavaScript 帮助程序。npm 通常是 Node.js 安装程序的一部分。

创建新的客户端解决方案时,SharePoint 的 Yeoman 生成器将提取客户端项目所需的最新的 SharePoint Framework 包。构建项目时,现有包可能已过时,因为可能有一个或多个包的新版本可用。

根据特定版本或最新包的发行说明,你可能会决定更新项目中要使用的 SharePoint 框架包。 SharePoint 框架包同时包含项目中已安装的 nmp 包(如 @microsoft/sp-core-library)以及全局安装的 nmp 包(如 @microsoft/generator-sharepoint)。

提示

尽管可能并非必需,但仍建议经常更新 SharePoint 框架包,以便可获得发布的最新更改和修补程序。

查找过时的包

若要在客户端项目中查找过时的包(包括 SharePoint Framework 以及项目依赖的其他包),请在项目所在的目录的控制台中运行以下命令。

npm outdated

该命令将列出项目依赖的包的以下相关信息。 可从位于项目根目录和 npm 注册表中的 package.json 文件中找到此信息。

  • 项目中当前安装的版本
  • 项目请求的版本(位于 package.json 中)
  • 最新可用版本

NPM 过时的包

若要标识 SharePoint Framework 包,请查找按以下 npm 范围和前缀开头的包名称:

@microsoft/sp-

除 SharePoint Framework 包外,可能还需要更新 office-ui-fabric-react 包。 请确保阅读了 发行说明和路线图 来推断哪些包需要更新。

在项目上使用 "npm outdated"

配有功能包 2 的 SharePoint Server 2016 支持 SharePoint 框架解决方案。 SharePoint Server 2016 使用 SharePoint 框架的较旧版本,而不是 SharePoint Online 中提供的版本。

在搭建新项目基架时,SharePoint 框架 Yeoman 生成器会提示你选择解决方案是使用最新版本的 SharePoint 框架且仅与 SharePoint Online 一起使用,还是应使用较早版本的 SharePoint 框架且同时与 SharePoint Server 2016 和 SharePoint Online 一起使用。

在针对 SharePoint Online 和 SharePoint Server 2016 的项目中运行 npm outdated 命令时,它将显示最新版本的 SharePoint 框架包。 然而,这些版本仅适用于 SharePoint Online。 如果更新解决方案以使用这些最新的程序包,它将不再适用于 SharePoint Server 2016。

使用与本地托管的 SharePoint 兼容的 SharePoint 框架解决方案时,应始终验证目标 SharePoint 服务器场具有的修补程序级别以及它支持哪个版本的 SharePoint 框架。

更新包

将程序包更新到新版本时,应该始终使用程序包管理器(npm 或 Yarn)。 不应手动编辑 package.json 文件。 如果按照建议的做法使用锁定文件,则系统会忽略对 package.json 文件所作的更改。

首先确定哪些程序包需要更新以及要使用哪个较新版本。 可能无法始终使用给定程序包的最新版本,因为它可能与其他 SharePoint 框架依赖项(例如 TypeScript)不兼容。

对于每个要更新的程序包,请运行以下命令:

npm install mypackage@newversion --save

例如,如果你使用的是 date-fns 版本 v2.9.0,并且想要更新到版本 2.16.1,则可以运行:

npm install date-fns@2.16.1 --save

使用 npm 更新程序包将在项目中安装指定版本的程序包,并更新 package.json 文件依赖项中的版本号以及项目中使用的锁定文件。

安装包后,请执行下述命令以清除所有旧的内部版本项目:

gulp clean

建议通过删除 node_modules 文件夹删除所有旧数据包并利用更新的 package.json 下载(即,重新安装)所有依赖项。 如果没有此步骤,旧版本可能会在下次构建项目时与较新版本冲突。

npm install

更新代码

如果有重大的 API 更改,可能需要更新现有项目代码和配置文件。 对于每个版本,发行说明将突出显示现有代码所需的所有此类重大更改和修改。 请务必使用这些修补程序更新代码。

始终可生成项目,便于通过在项目目录的控制台中运行命令查看是否出现任何错误和警告:

gulp build

更新 Yeoman 生成器

如果已全局安装 SharePoint 框架 Yeoman 生成器,则可以通过运行以下命令来确定是否需要更新:

npm outdated -g

该命令将列出计算机中全局安装的包的下述相关信息。此信息位于计算机中安装的版本和 npm 注册表。

  • 计算机上全局安装的当前版本
  • 安装时请求的版本
  • 最新可用版本

NPM 过时的全局包

若要标识生成器包,请查找以下包名称:

@microsoft/generator-sharepoint

更新生成器包

打开最喜爱的控制台,并执行以下命令将生成器更新到最新发布版本:

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

此命令可将 SharePoint 的 Yeoman 生成器连同其依赖项一起更新到最新发布版本。可在控制台中执行以下命令进行验证:

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

另请参阅