waldekm/spfx

SharePoint Framework Docker镜像文档

重要说明

本仓库的镜像已迁移至https://hub.docker.com/r/m365pnp/spfx%E3%80%82%E6%89%80%E6%9C%89%E6%9C%AA%E6%9D%A5%E7%89%88%E6%9C%AC%E5%B0%86%E5%8F%91%E5%B8%83%E5%88%B0m365pnp/spfx%EF%BC%8C%E6%9C%AC%E4%BB%93%E5%BA%93%E5%B0%86%E4%BF%9D%E6%8C%81%E7%8E%B0%E7%8A%B6%E3%80%82

使用方法

1. 在Docker设置 > 共享驱动器中，确保创建项目的驱动器已共享。
2. 为SharePoint Framework项目创建一个文件夹。
3. 在命令行中（根据操作系统选择）：

macOS

sh
cd [你的项目路径]
docker run -it --rm --name ${PWD##*/} -v $PWD:/usr/app/spfx -p 4321:4321 -p 35729:35729 waldekm/spfx

Windows PowerShell

PowerShell
cd [你的项目路径]
docker run -it --rm --name spfx-helloworld -v ${PWD}:/usr/app/spfx -p 4321:4321 -p 35729:35729 waldekm/spfx

Windows 其他命令行

cmd
cd [你的项目路径]
docker run -it --rm --name spfx-helloworld -v %cd%:/usr/app/spfx -p 4321:4321 -p 35729:35729 waldekm/spfx

容器启动后，即可像在本地安装SharePoint Framework一样操作。要在容器命令行中创建新的SharePoint Framework项目，执行：

sh
yo @microsoft/sharepoint

生成器创建的所有文件将存储在主机的项目目录中，可从该目录提交到源代码控制。

要关闭容器，在容器命令行中运行：

sh
exit

可用标签

• latest：包含1.13.1版本的SharePoint Framework Yeoman生成器
• online：包含1.13.1版本的SharePoint Framework Yeoman生成器
• onprem：包含1.12.1版本的SharePoint Framework Yeoman生成器
• 1.13.1：包含1.13.1版本的SharePoint Framework Yeoman生成器
• 1.13.0：包含1.13.0版本的SharePoint Framework Yeoman生成器
• 1.12.1：包含1.12.1版本的SharePoint Framework Yeoman生成器
• 1.12.0：包含1.12.0版本的SharePoint Framework Yeoman生成器
• 1.11.0：包含1.11.0版本的SharePoint Framework Yeoman生成器
• 1.10.0：包含https://github.com/sharepoint/sp-dev-docs/wiki/SharePoint-Framework-v1.10-release-notes%E7%89%88%E6%9C%AC%E7%9A%84SharePoint Framework Yeoman生成器
• 1.9.1：包含https://github.com/sharepoint/sp-dev-docs/wiki/SharePoint-Framework-v1.9.1-release-notes%E7%89%88%E6%9C%AC%E7%9A%84SharePoint Framework Yeoman生成器
• 1.8.2：包含https://github.com/sharepoint/sp-dev-docs/wiki/SharePoint-Framework-v1.8.2-release-notes%E7%89%88%E6%9C%AC%E7%9A%84SharePoint Framework Yeoman生成器
• 1.8.1：包含https://github.com/sharepoint/sp-dev-docs/wiki/SharePoint-Framework-v1.8.1-release-notes%E7%89%88%E6%9C%AC%E7%9A%84SharePoint Framework Yeoman生成器
• 1.8.0：包含https://github.com/sharepoint/sp-dev-docs/wiki/SharePoint-Framework-v1.8-release-notes%E7%89%88%E6%9C%AC%E7%9A%84SharePoint Framework Yeoman生成器
• 1.7.1：包含https://github.com/sharepoint/sp-dev-docs/wiki/Release-Notes-for-SPFx-Package-Version-1.7.1%E7%89%88%E6%9C%AC%E7%9A%84SharePoint Framework Yeoman生成器
• 1.7.0：包含https://github.com/SharePoint/sp-dev-docs/wiki/SharePoint-Framework-v1.7-release-notes%E7%89%88%E6%9C%AC%E7%9A%84SharePoint Framework Yeoman生成器
• 1.6.0：包含https://github.com/sharepoint/sp-dev-docs/wiki/v-1.6-release-notes%E7%89%88%E6%9C%AC%E7%9A%84SharePoint Framework Yeoman生成器
• 1.5.1：包含https://github.com/SharePoint/sp-dev-docs/wiki/Release-Notes-for-SPFx-Package-Version-1.5.1%E7%89%88%E6%9C%AC%E7%9A%84SharePoint Framework Yeoman生成器
• 1.5.0：包含https://github.com/sharepoint/sp-dev-docs/wiki/Release-Notes-for-SharePoint-Framework-Package-v1.5%E7%89%88%E6%9C%AC%E7%9A%84SharePoint Framework Yeoman生成器
• 1.4.1：包含https://github.com/sharepoint/sp-dev-docs/wiki/Release-Notes-for-SPFx-Package-Version-1.4.1%E7%89%88%E6%9C%AC%E7%9A%84SharePoint Framework Yeoman生成器
• 1.4.0：包含https://github.com/SharePoint/sp-dev-docs/wiki/Release-Notes-for-SPFx-Package-Version-1.4%E7%89%88%E6%9C%AC%E7%9A%84SharePoint Framework Yeoman生成器
• 1.3.4：包含1.3.4版本的SharePoint Framework Yeoman生成器
• 1.3.2：包含1.3.2版本的SharePoint Framework Yeoman生成器
• 1.3.1：包含1.3.1版本的SharePoint Framework Yeoman生成器
• 1.3.0：包含1.3.0版本的SharePoint Framework Yeoman生成器
• 1.2.0：包含https://github.com/SharePoint/sp-dev-docs/wiki/Release-Notes---Extensions-RC-Drop-1.2%E7%89%88%E6%9C%AC%E7%9A%84SharePoint Framework Yeoman生成器
• 1.1.3：包含1.1.3版本的SharePoint Framework Yeoman生成器
• 1.1.1：包含https://github.com/SharePoint/sp-dev-docs/wiki/Release-Notes---Extensions-Dev-Preview-Drop-1%E7%89%88%E6%9C%AC%E7%9A%84SharePoint Framework Yeoman生成器
• 1.1.0：包含https://github.com/SharePoint/sp-dev-docs/wiki/Release-Notes---Extensions-Dev-Preview-Drop-1%E7%89%88%E6%9C%AC%E7%9A%84SharePoint Framework Yeoman生成器
• 1.0.2：包含1.0.2版本的SharePoint Framework Yeoman生成器
• ga：包含https://github.com/SharePoint/sp-dev-docs/wiki/Release-Notes-GA%E7%89%88%E6%9C%AC%E7%9A%84SharePoint Framework Yeoman生成器
• rc0：包含https://github.com/SharePoint/sp-dev-docs/wiki/Release-Notes-RC0%E7%89%88%E6%9C%AC%E7%9A%84SharePoint Framework Yeoman生成器
• drop-6：包含https://github.com/SharePoint/sp-dev-docs/wiki/Release-Notes-Drop-6%E7%9A%84SharePoint Framework Yeoman生成器
• drop-5：包含https://github.com/SharePoint/sp-dev-docs/wiki/Release-Notes-Drop-5%E7%9A%84SharePoint Framework Yeoman生成器
• drop-4：包含https://github.com/SharePoint/sp-dev-docs/wiki/Release-Notes-Drop-4-and-MDL2%E7%9A%84SharePoint Framework Yeoman生成器

已知问题

无法将文件写入磁盘

运行yo @microsoft/sharepoint时出现容器无法将文件写入磁盘的错误。大多数情况下，这是由于Docker中未共享驱动器导致的。进入Docker > 设置 > 共享，启用项目所在驱动器的共享。

SharePoint Framework >=1.6.0无法访问工作台和捆绑包

使用SharePoint Framework >=v1.6.0的容器时，无法访问本地工作台或无法在托管工作台中加载捆绑包。这是由于工作台默认映射到localhost，容器外部无法访问。要解决此问题，通过修改SharePoint Framework项目中的./config/serve.json文件，将工作台映射到0.0.0.0：

json
{
  "$schema": "https://developer.microsoft.com/json-schemas/core-build/serve.schema.json",
  "port": 4321,
  "hostname": "0.0.0.0",
  "https": true,
  "initialPage": "https://输入你的SharePoint网站/_layouts/workbench.aspx"
}

SharePoint Framework >=1.12.1无法访问捆绑包

修改node_modules\@microsoft\spfx-heft-plugins\lib\plugins\webpackConfigurationPlugin\WebpackConfigurationGenerator.js:393：

javascript
const debugBaseUrl = `${serveConfig.https ? 'https' : 'http'}://${serveConfig.hostname || 'localhost'}:${serveConfig.port || 4321}/dist/`;

为：

javascript
const debugBaseUrl = `${serveConfig.https ? 'https' : 'http'}://localhost:${serveConfig.port || 4321}/dist/`;

Windows上SharePoint Framework >=1.6.0 <=1.11.0无法访问工作台和捆绑包

在Windows上使用SharePoint Framework >=v1.6.0的容器时，即使按照上一节步骤操作，仍无法访问本地工作台。这与Windows无法正确访问0.0.0.0有关。要解决此问题，首先修改config\write-manifests.json（添加debugBasePath属性）：

json
{
  "$schema": "https://developer.microsoft.com/json-schemas/spfx-build/write-manifests.schema.json",
  "cdnBasePath": "<!-- CDN路径 -->",
  "debugBasePath": "https://localhost:4321/"
}

然后，打开node_modules\@microsoft\sp-build-web\lib\SPWebBuildRig.js，将以下行：

js
spBuildCoreTasks.writeManifests.mergeConfig({
    debugBasePath: `${serve.taskConfig.https ? 'https' : 'http'}://${serve.taskConfig.hostname}:${serve.taskConfig.port}/`
});

修改为（添加if语句）：

js
if (!spBuildCoreTasks.writeManifests.taskConfig.debugBasePath) {
    spBuildCoreTasks.writeManifests.mergeConfig({
        debugBasePath: `${serve.taskConfig.https ? 'https' : 'http'}://${serve.taskConfig.hostname}:${serve.taskConfig.port}/`
    });
}

根据SPFx版本，需替换的行有所不同：

SharePoint Framework 1.5.0无法访问工作台和捆绑包

使用SharePoint Framework v1.5.0的容器时，无法访问本地工作台或无法在托管工作台中加载捆绑包。这是由于gulp serve任务使用的gulp-connect包变更导致的。要解决此问题，在搭建项目后，在代码编辑器中打开./node_modules/gulp-connect/index.js文件，将第106行从：

js
return this.server.listen(this.port, this.host, (function(_this) {

修改为（移除this.host参数）：

js
return this.server.listen(this.port, (function(_this) {

限制

Windows 10 Anniversary Update和Windows Server 2016原生支持容器。目前Windows仅支持基于Windows Server Core或Nano Server构建的容器，因此无法在Windows上原生运行此容器。应使用Docker for Windows或Docker Toolbox。