互联网技术部程序员代码开发规范手册.docxVIP

互联网技术部程序员代码开发规范手册

第1章

项目结构与配置管理

1.1项目根目录与核心依赖包管理

项目根目录必须严格遵循语义化命名规范，以`project-root`作为顶层文件夹，所有子目录和文件均在此范围内，严禁在根目录之外创建独立项目文件夹，确保代码库结构清晰，便于团队协作。根目录下必须包含一个名为`package.json`的文件，该文件是Node.js项目的标准配置，需明确列出所有依赖包名称、版本号及描述信息，例如`{name:my-project,version:1.0.0,dependencies:{express:^4.18.0}}`，确保依赖关系一目了然。

根目录下必须包含一个名为`tsconfig.json`或`package-lock.json`的文件，前者用于TypeScript编译器配置，后者用于锁定依赖版本，防止因版本冲突导致项目运行不稳定，二者缺一不可。根目录下必须包含一个名为`.gitignore`的文件，该文件需明确列出敏感信息（如`.env`配置文件、`node_modules`文件夹、编译产物）以及测试数据，防止泄露或污染代码仓库。根目录下必须包含一个名为`.eslintrc.json`或`.prettierrc.json`的文件，前者用于配置ESLint代码检查规则，