SharePoint Framework 可复用React控件库指南

1. 项目目录结构及介绍

本项目是名为 sp-dev-fx-controls-react 的开源库，旨在提供一系列可重用的React控件，以供在SharePoint Framework（SPFx）解决方案中使用。以下是其基本目录结构概述：

• src
  包含所有的源代码文件，这里是控件的核心实现区域。

  • controls
    存放各种React控件的代码，每个控件通常有自己的子目录。
  • lib
    编译后的输出目录，包含编译后的JavaScript代码和相关资源，用于生产环境。
  • models
    定义项目使用的数据模型或接口。
  • styles
    控制样式相关的CSS或者SCSS文件。

• docs
  文档资料，可能包括开发指南、API说明等。

• config
  配置文件夹，其中包含构建和测试的配置信息。

• tests
  单元测试和集成测试文件存放地。

• tsconfig.json
  TypeScript编译器的配置文件，定义了编译规则。

• package.json
  项目依赖和服务描述文件，包含脚本命令。

• README.md
  主要的项目介绍文档，快速入门指导和重要信息。

• LICENSE
  许可协议文件，声明该项目遵循MIT许可。

2. 项目的启动文件介绍

在SPFx项目中，主要的启动逻辑通常不通过单独的“启动文件”进行，而是通过npm脚本来管理。特别地，在这个项目中：

• 使用gulp serve命令进行本地开发服务器的启动。这在package.json中的scripts部分被定义，例如 "serve": "gulp serve"，允许开发者即时预览他们的控件。
• 开发过程中可能还需运行测试或其他脚本，这些也通常是通过npm命令触发，如测试可能通过 gulp test。

3. 项目的配置文件介绍

package.json

这是Node.js项目的基础配置文件，列出项目依赖、scripts（执行任务的脚本）、项目信息等。对于SPFx项目来说，它还包含了特定的SPFx命令，比如构建和部署步骤。

tsconfig.json

TypeScript编译配置文件，控制TypeScript如何编译到JavaScript。它指定了编译目标（如ES版本）、源码目录、是否启用严格类型检查等。

config/config.json

在SPFx项目中，特别是当涉及到国际化的配置时，config.json文件可能会用来设置资源字符串的路径。对于此项目，安装依赖后会自动配置资源路径，确保国际化支持正确设置。

其他配置文件

• .gitignore: 指示Git应忽略哪些文件或目录。
• .yo-rc.json: SPFx初始化时产生的配置文件，记录了项目初始创建时的选择和设置。

综上所述，sp-dev-fx-controls-react项目通过精心组织的目录结构和配置文件，提供了灵活且易于理解和使用的框架，便于开发者在SPFx环境中整合和定制React控件。