dotenv-safe 项目教程

1. 项目目录结构及介绍

dotenv-safe/
├── examples/
│   ├── example1.js
│   ├── example2.js
│   └── ...
├── lib/
│   ├── main.js
│   └── ...
├── test/
│   ├── test1.js
│   ├── test2.js
│   └── ...
├── .env.example
├── .gitignore
├── package.json
├── README.md
└── ...

目录结构介绍

• examples/: 包含项目的示例代码，展示了如何使用 dotenv-safe 加载环境变量。
• lib/: 包含项目的主要逻辑代码，main.js 是核心文件。
• test/: 包含项目的测试代码，确保项目的功能正常。
• .env.example: 示例环境变量文件，用户可以根据此文件创建自己的 .env 文件。
• .gitignore: 指定 Git 忽略的文件和目录。
• package.json: 项目的配置文件，包含依赖、脚本等信息。
• README.md: 项目的说明文档，介绍项目的基本信息和使用方法。

2. 项目启动文件介绍

dotenv-safe 项目的启动文件主要是 lib/main.js。这个文件负责加载环境变量并确保所有必需的环境变量都已定义。

lib/main.js 文件介绍

const dotenv = require('dotenv');
const fs = require('fs');

function config(options = {}) {
    const { example, allowEmptyValues = false } = options;
    const envConfig = dotenv.parse(fs.readFileSync('.env'));
    const exampleConfig = dotenv.parse(fs.readFileSync(example));

    for (let key in exampleConfig) {
        if (!envConfig[key] && !allowEmptyValues) {
            throw new Error(`Missing environment variable: ${key}`);
        }
    }

    return { parsed: envConfig };
}

module.exports = { config };

• config 函数: 该函数负责加载 .env 文件中的环境变量，并检查是否所有在 .env.example 文件中定义的变量都已在 .env 文件中定义。如果缺少必需的变量，函数会抛出错误。

3. 项目的配置文件介绍

package.json

{
  "name": "dotenv-safe",
  "version": "9.0.0",
  "description": "Load environment variables from .env and ensure they are defined",
  "main": "lib/main.js",
  "scripts": {
    "test": "jest",
    "start": "node lib/main.js"
  },
  "dependencies": {
    "dotenv": "^10.0.0"
  },
  "devDependencies": {
    "jest": "^27.0.0"
  }
}

• name: 项目名称。
• version: 项目版本号。
• description: 项目描述。
• main: 项目的入口文件。
• scripts: 定义了项目的脚本命令，如 test 和 start。
• dependencies: 项目的依赖包，dotenv 是核心依赖。
• devDependencies: 开发依赖包，如 jest 用于测试。

.env.example

# 示例环境变量文件
DB_HOST=localhost
DB_USER=root
DB_PASS=password

• .env.example: 这是一个示例环境变量文件，用户可以根据此文件创建自己的 .env 文件，确保所有必需的环境变量都已定义。

通过以上介绍，您应该对 dotenv-safe 项目的目录结构、启动文件和配置文件有了基本的了解。希望这篇教程能帮助您更好地使用和理解 dotenv-safe 项目。