目录结构

目录结构清单

├─ test // 测试相关
├─ scripts // 自定义的脚本
├─ docs // 文档，通常文档较多，有多个 md 文档
├─ examples // 可以运行的示例代码
├─ packages // 要发布的 npm 包，一般用在一个仓库要发多个 npm 包的场景
├─ dist|build // 代码分发的目录
├─ src|lib // 源码目录
├─ bin // 命令行脚本入口文件
├─ website|site // 官方网站相关代码，譬如 antd、react
├─ benchmarks // 性能测试相关
├─ types|typings// typescript 的类型文件
├─ README.md // 仓库介绍或者组件文档
└─ index.js // 入口文件

最小目录结构清单

├─ test // 测试相关
├─ src|lib // 源码目录
├─ README.md // 仓库介绍或者组件文档
└─ index.js // 入口文件

配置文件

├─ .circleci            // 目录。circleci 持续集成相关文件
├─ .github              // 目录。github 扩展配置文件存放目录
│ ├─ CONTRIBUTING.md
│ └─ ...
├─ .babelrc.js          // babel 编译配置
├─ .editorconfig        // 跨编辑器的代码风格统一
├─ .eslintignore        // 忽略 eslint 检测的文件清单
├─ .eslintrc.js         // eslint 配置
├─ .gitignore           // git 忽略清单
├─ .npmignore           // npm 忽略清单
├─ .travis.yml          // travis 持续集成配置文件
├─ .npmrc               // npm 配置文件
├─ .prettierrc.json     // prettier 代码美化插件的配置
├─ .gitpod.yml          // gitpod 云端 IDE 的配置文件
├─ .codecov.yml         // codecov 测试覆盖率配置文件
├─ LICENSE // 开源协议声明
├─ CODE_OF_CONDUCT.md   // 贡献者行为准则
└─ ... // 其他更多配置

通用配置文件

├─ .babelrc.js          // babel 编译配置
├─ .editorconfig        // 跨编辑器的代码风格统一
├─ .eslintignore        // 忽略 eslint 检测的文件清单
├─ .eslintrc.js         // eslint 配置
├─ .gitignore           // git 忽略清单
├─ .npmignore           // npm 忽略清单
├─ LICENSE // 开源协议声明
└─ ... // 其他更多