Guoguo-notes

4 项目组织规范

项目组织规范定义了如何组织一个前端项目, 例如项目的命名、项目的文件结构、版本号规范等等。尤其对于开源项目，规范化的项目组织就更重要了。

4.1 通用的项目组织规范

一个典型的项目组织规范如下:

README.md: 项目说明, 这个是最重要。你必须在这里提供关于项目的关键信息或者相关信息的入口. 一般包含下列信息:
- 简要描述、项目主要特性
- 运行环境/依赖、安装和构建、测试指南
- 简单示例代码
- 文档或文档入口, 其他版本或相关资源入口
- 联系方式、讨论群
- 许可、贡献/开发指南
CHANGELOG.md: 放置每个版本的变动内容, 通常要描述每个版本变更的内容。方便使用者确定应该使用哪个版本. 关于CHANGELOG的规范可以参考keep a changelog
package.json: 前端项目必须. 描述当前的版本、可用的命令、包名、依赖、环境约束、项目配置等信息.
.gitignore: 忽略不必要的文件，避免将自动生成的文件提交到版本库
.gitattributes: git配置，有一些跨平台差异的行为可能需要在这里配置一下，如换行规则
docs/: 项目的细化文档, 可选.
examples/: 项目的示例代码，可选.
build: 项目工具类脚本放置在这里，非必须。如果使用统一构建工具，则没有这个目录
dist/: 项目构建结果输出目录
src/: 源代码目录
tests/: 单元测试目录. 按照Jest规范, __tests__目录通常和被测试的模块在同一个父目录下, 例如: /src tests/ index.ts a.ts index.ts a.ts 复制代码
tests: 全局的测试目录，通常放应用的集成测试或E2E测试等用例
.env*: 项目中我们通常会使用
```
环境变量
```
来影响应用在不同运行环境下的行为. 可以通过dotEnv来从文件中读取环境变量. 通常有三个文件: 基本上这些文件的变动的频率很少，团队成员应该不要随意变动，以免影响其他成员。所以通常会使用
```
.env.*.local
```
文件来覆盖上述的配置, 另外会设置版本库来忽略
```
*.local
```
文件.
- .env 通用的环境变量
- .env.development 开发环境的环境变量
- .env.production 生成环境的环境变量

对于开源项目通常还包括这些目录:

LICENSE: 说明项目许可
.github: 开源贡献规范和指南
- CONTRIBUTING: 贡献指南, 这里一般会说明贡献的规范、以及项目的基本组织、架构等信息
- CODE_OF_CONDUCT: 行为准则
- COMMIT_CONVENTION: 提交信息规范，上文已经提及
- ISSUE_TEMPLATE: Issue的模板，github可以自动识别这个模板
- PULL_REQUEST_TEMPLATE: PR模板

任意一个优秀的开源项目都是你的老师，例如React、Vue...

 # 启用gzip
    gzip on;
    gzip_min_length 1k;
    gzip_comp_level 6;
    gzip_types text/plain text/css application/json application/javascript text/xml application/xml application/xml+rss text/javascript application/vnd.ms-fontobject application/x-font-ttf font/opentype;
    gzip_vary on;
    gzip_static on; # 启用静态gzip，直接使用预压缩的.gz文件
    
    # 启用brotli（需要安装ngx_brotli模块）
    brotli on;
    brotli_comp_level 6;
    brotli_types text/plain text/css application/json application/javascript text/xml application/xml application/xml+rss text/javascript application/vnd.ms-fontobject application/x-font-ttf font/opentype;
    brotli_static on; # 启用静态brotli，直接使用预压缩的.br文件
    
    # 静态资源缓存设置
    location /web/static/ {
        expires 30d;
        add_header Cache-Control "public, max-age=2592000";
    }
    
    # 禁止访问敏感文件
    location ~ \.(htaccess|env|git) {
        deny all;
    }