SharePoint Framework 客户端Web部件示例项目教程

1. 项目的目录结构及介绍

sp-dev-fx-webparts 项目是一个开源项目，旨在展示 SharePoint Framework (SPFx) 客户端Web部件的不同使用模式。以下是项目的目录结构及其简要介绍：

sp-dev-fx-webparts/
├── samples/               # 示例文件夹，包含多个客户端Web部件示例
│   ├── sample1/
│   ├── sample2/
│   └── ...
├── templates/            # 模板文件夹，包含创建新Web部件的模板文件
├── tutorials/            # 教程文件夹，包含有关如何使用这些示例的教程
├── .gitattributes/       # Git属性配置文件
├── .gitignore/           # Git忽略配置文件
├── hintrc/               # TypeScript代码风格配置文件
├── package-lock.json     # npm包锁定文件
├── README.md             # 项目自述文件
├── CODE_OF_CONDUCT.md    # 项目行为准则
├── CONTRIBUTING.md       # 贡献指南
├── LICENSE               # 项目许可证文件
└── ...

• samples/：包含多个独立的Web部件示例项目，每个示例都在自己的文件夹中，并且具有相应的README.md文件，介绍示例的功能和使用方法。
• templates/：提供模板文件，用于快速开始新的Web部件项目。
• tutorials/：包含一些教程，指导用户如何使用这些示例，以及如何开发自己的Web部件。

2. 项目的启动文件介绍

在 samples/ 目录下的每个示例文件夹中，通常包含以下启动文件：

• package.json：定义了示例项目的npm依赖项和脚本。
• tsconfig.json：TypeScript配置文件，指定了编译器的选项。
• gulpfile.js：定义了使用Gulp自动化构建和服务的任务。

以 sample1/ 为例，以下是启动该示例的步骤：

cd samples/sample1
npm install        # 安装npm依赖项
gulp serve         # 启动本地开发服务器，并在SharePoint Workbench中预览Web部件

3. 项目的配置文件介绍

项目的配置文件包括以下内容：

• package.json：这是一个标准的npm配置文件，其中包含了项目依赖、脚本和元数据。例如，它可能包含一个scripts部分，定义了运行项目所需的各种命令：

"scripts": {
  "start": "gulp serve",
  "build": "gulp build"
}

• tsconfig.json：TypeScript项目的配置文件，它指定了TypeScript编译器的选项。例如，它可能定义了编译输出的目标版本、模块系统、以及是否包含调试信息等：

{
  "compilerOptions": {
    "target": "es5",
    "module": "commonjs",
    "strict": true,
    "esModuleInterop": true
  }
}

• gulpfile.js：这是一个Node.js脚本，使用Gulp来自动化构建和测试任务。例如，它可能包含一个serve任务，用于启动一个本地开发服务器：

const gulp = require('gulp');
const serve = require('gulp-serve');

gulp.task('serve', serve({
  root: ['."]
}));

以上是 sp-dev-fx-webparts 项目的基本目录结构、启动文件和配置文件的介绍。通过这些介绍，开发者可以更好地理解项目结构，并开始开发自己的SharePoint客户端Web部件。