在 Node.js 开发中，良好的文件和文件夹命名约定可以提高代码可读性、可维护性和可扩展性。本文将介绍一些常见的 Node.js 项目文件和文件夹的命名约定，并提供相应的示例代码。
文件名命名约定
JavaScript 文件名
- 文件名应该以小写字母开头。
- 文件名应该与其导出的默认模块或变量名称保持一致。
- 如果文件包含多个导出，文件名应该使用驼峰式命名法，并使用一个描述性单词作为前缀或后缀。
例如，在一个导出默认模块的文件中，命名约定如下：
// 导出默认模块
export default function myFunc() {
// ...函数实现
}
// 文件名: myfunc.js如果文件包含多个导出，则可以在文件名中添加一个描述性单词作为前缀或后缀：
-- -------------------- ---- ------- -- ------ ------ -------- --------- - -- ------- - ------ -------- --------- - -- ------- - -- ---- ------------------ -- ------------------
配置文件名
- 配置文件名应该使用全大写字母。
- 不同配置文件类型应该使用不同的扩展名，如
.json或.yaml。
例如：
// JSON 配置文件
{
"PORT": 3000,
"DATABASE_URL": "mongodb://localhost:27017/my-db"
}
// 文件名: config.json测试文件名
- 测试文件名应该与其相应的被测试文件名称保持一致，并在其后添加
.test或.spec扩展名。
例如：
-- -------------------- ---- ------- -- ----- -------- -------- - -- ------- - -- ------ ------------ ------ -- ----------- -- -- - -- ------- --- -- ---- -------------- -- --------------
文件夹命名约定
模块文件夹命名
- 模块文件夹名应该使用小写字母。
- 如果模块有多个功能，则可以使用一个描述性单词作为前缀或后缀。
例如，在一个包含多个功能的模块中，命名约定如下：
- my-module/ - index.js - utils.js
测试文件夹命名
- 测试文件夹名应该与其相应的被测试文件（或模块）名称保持一致，并在其后添加
.test或.spec后缀。 - 内部测试文件应当放在
__tests__文件夹内，以避免与其他类型文件混淆。
例如：
- my-module/
- index.js
- utils.js
- __tests__/
- index.test.js
- utils.test.js结论
Node.js 项目文件和文件夹的命名约定可以帮助开发者提高代码可读性、可维护性和可扩展性。以上是一些常见的命名约定，但不应该被视为硬性规则，而应该根据实际项目需要进行调整。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/15454