flun-env 3.0.6

package/CHANGELOG.md

@@ -0,0 +1,10 @@
+# 变更日志
+## [3.0.6] - 2025-12-15 16:01
+### 变更:
+ - lunjack-env包将不在继续更新,以后将升级为flun-env(用法不变,只是升级了包名);
+## [3.0.5] - 2025-11-20 16:19
+### 优化:
+ - 对处理细节各项进行了深度优化;
+## [3.0.4] - 2025-11-05 15:18
+### 修复:
+ - 修复创建示例文件中，注释引用包变量格式错误的问题;

package/LICENSE

@@ -0,0 +1,15 @@
+ISC License
+
+Copyright (c) 2025, flun
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -0,0 +1,91 @@
+# flun-env一个简单易用的 .env 环境变量文件读取工具
+
+## 安装
+
+```bash
+npm i flun-env
+```
+
+## 特性
+
+- ✅ 自动检查并创建 .env 示例文件
+- ✅ 支持 `env.变量名` 的直接调用方式
+- ✅ 支持自定义 .env 文件路径
+- ✅ 自动将变量注入到 `process.env`
+- ✅ 多路径自动查找 .env 文件
+- ✅ 支持注释和空行
+- ✅ 友好的错误提示
+
+## .env 文件格式
+
+在项目根目录或运行文件根目录创建 `.env` 文件：
+
+```env
+# 数据库配置
+DATABASE_URL=mysql://user:password@localhost:3306/dbname
+API_KEY=your_api_key_here
+
+# 应用配置
+DEBUG=false
+PORT=3000
+NODE_ENV=development
+```
+
+## API
+
+### 属性访问
+- `env.VARIABLE_NAME` - 直接访问变量
+
+### 方法
+- `env.get(key, defaultValue)` - 获取变量值
+- `env.has(key)` - 检查变量是否存在
+- `env.getAll()` - 获取所有变量
+- `env.load()` - 重新加载变量
+
+## 文件查找顺序
+1. 自定义路径
+2. 当前工作目录的 `.env` 文件
+3. C盘用户主目录的 `.env` 文件
+
+## 使用方法
+
+### 默认配置(示例)
+
+```javascript
+const {env} = require('flun-env');
+
+// 直接使用变量
+console.log(env.DATABASE_URL);
+console.log(env.API_KEY);
+console.log('数据库地址:', env.DATABASE_URL);
+console.log('API密钥:', env.API_KEY);
+
+// 或者使用方法
+console.log(env.get('DATABASE_URL'));
+if (env.has('SECRET_KEY')) {
+  console.log('密钥存在');
+}
+
+// 获取所有变量
+const allVars = env.getAll();
+console.log('所有变量:', allVars);
+```
+
+### 自定义配置(示例):
+
+```javascript
+const { config } = require('flun-env');
+const env = config({
+    path: './path/.env',  // 自定义路径 (自定义路径如果是相对路径,那么请以工作路径作为基准设置->向上或向下或同级)
+    encoding: 'utf8',     // 字符集 (默认utf8)
+    debug: true           // 调试模式 (默认false)
+});
+
+console.log(env.PORT); // 访问配置项
+// 其它使用方式同默认配置(示例)...
+```
+
+## 错误处理
+如果未找到 .env 文件，包会自动创建示例文件并退出进程。
+
+这个包提供了完整的 .env 文件管理功能，包括自动创建示例文件、错误处理、多路径查找等特性，用户可以通过简单的 `env.变量名` 方式直接访问环境变量

package/env.js

@@ -0,0 +1,26 @@
+// 导出示例文件供模块使用
+const exampleLines = [
+    '# .nev 环境变量配置文件示例:',
+    '# 每行格式: 变量名 = 变量值',
+    '# 以 # 开头的行是注释',
+    '',
+    'DATABASE_URL = mysql://user:password@localhost:3306/dbname',
+    '',
+    'API_KEY = your_api_key_here',
+    '',
+    'SECRET_KEY = your_secret_key_here',
+    '',
+    'DEBUG = false',
+    '',
+    'PORT = 3000',
+    '',
+    '# 字符串值不需要引号',
+    'APP_NAME = MyApp',
+    '',
+    'NODE_ENV = development',
+    '',
+    `# 调用包: const {env} = require('flun-env');`,
+    '',
+    '# 使用格式: env.变量名'
+];
+module.exports = { exampleLines };

package/index.d.ts

@@ -0,0 +1 @@
+declare module 'flun-env';

package/index.js

@@ -0,0 +1,158 @@
+const fs = require('fs');
+const path = require('path');
+const os = require('os');
+const { exampleLines } = require('./env');
+
+class EnvLoader {
+    constructor(options = {}) {
+        this.options = { ...options }, this.variables = {}, this.loaded = false, this.load(); // 自动加载
+
+        // 返回代理实例以实现 env.变量名 的访问方式
+        return new Proxy(this, {
+            get: (target, prop) => {
+                if (prop in target) return target[prop];
+                const variables = target.getAll();
+                if (prop in variables) return variables[prop];
+                return undefined;
+            },
+            set(target, prop, value) {
+                console.warn('⚠️  警告: 环境变量应在 .env 文件中设置');
+                return false;
+            }
+        });
+    }
+
+    // 解析 .env 文件内容
+    parse(content) {
+        const lines = content.split('\n'), result = {};
+        for (let line of lines) {
+            line = line.trim();                          // 移除前后空白字符
+            if (!line || line.startsWith('#')) continue; // 跳过空行和注释
+
+            // 解析键值对
+            const equalsIndex = line.indexOf('=');
+            if (equalsIndex === -1) continue;             // 跳过无效行
+
+            const key = line.slice(0, equalsIndex).trim();
+            let value = line.slice(equalsIndex + 1).trim();
+
+            // 移除值两端的引号（如果存在）
+            const firstChar = value[0];
+            if (firstChar === value.at(-1) && (firstChar === '"' || firstChar === "'"))
+                value = value.slice(1, -1);
+
+            if (key) {
+                result[key] = value;
+                if (this.options.debug) console.log(`✓ 加载变量: ${key} = ${value}`);
+            }
+        }
+
+        return result;
+    }
+
+    // 查找文件
+    findFile(defaultFileName, customPath) {
+        let createPath; // 首选创建路径
+
+        // 1. 如果有传入自定义路径
+        if (customPath && customPath !== '.env') {
+            createPath = path.isAbsolute(customPath) ? customPath : path.resolve(process.cwd(), customPath);
+
+            // 检查自定义路径的文件是否存在
+            try {
+                if (fs.statSync(createPath).isFile()) return { found: true, path: createPath, createPath };
+            } catch (error) { }
+            return { found: false, path: null, createPath }; // 自定义路径的文件不存在，返回创建路径为自定义路径
+        }
+
+        // 2. 没有自定义路径，检查默认路径(当前工作目录和系统用户主目录)
+        const possiblePaths = [path.join(process.cwd(), defaultFileName), path.join(os.homedir(), defaultFileName)];
+
+        // 检查每个路径是否存在
+        for (const filePath of possiblePaths)
+            try {
+                if (fs.statSync(filePath).isFile()) return { found: true, path: filePath, createPath: filePath };
+            } catch (error) { }
+
+        // 3. 所有路径都不存在，返回创建路径为当前工作目录
+        createPath = path.join(process.cwd(), defaultFileName);
+        return { found: false, path: null, createPath };
+    }
+
+    // 创建示例文件
+    createExampleFile(filePath, exampleContent) {
+        try {
+            const dir = path.dirname(filePath);
+            if (!fs.existsSync(dir)) fs.mkdirSync(dir, { recursive: true }); // 确保目录存在
+
+            fs.writeFileSync(filePath, exampleContent, 'utf8');
+            console.log(`✓ 已创建示例文件:${filePath};请编辑环境变量后重新运行程序`), process.exit(1);
+        } catch (error) {
+            console.error('✗ 创建示例文件失败:', error.message);
+        }
+    }
+
+    // 加载环境变量
+    load() {
+        if (this.loaded) return this.variables;
+
+        const result = this.findFile('.env', this.options.path);
+        if (!result.found) {
+            console.log('未找到 .env 文件!💡 正在为您创建...');
+            this.createExampleFile(result.createPath, exampleLines.join('\n')); // 创建示例文件
+            return this.variables;
+        }
+
+        try {
+            // 读取并解析文件
+            const content = fs.readFileSync(result.path, this.options.encoding);
+            this.variables = this.parse(content), this.loaded = true;
+
+            if (this.options.debug) console.log(`✓ 加载了 ${Object.keys(this.variables).length} 个变量`);
+            for (const [key, value] of Object.entries(this.variables)) process.env[key] = value; // 将变量设置到 process.env
+        } catch (error) {
+            console.error('❌ 读取 .env 文件失败:', error.message), process.exit(1);
+        }
+        return this.variables;
+    }
+
+    // 获取所有变量
+    getAll() {
+        return { ...this.variables };
+    }
+
+    // 获取单个变量
+    get(key, defaultValue = null) {
+        return this.variables[key] || defaultValue;
+    }
+
+    // 检查变量是否存在
+    has(key) {
+        return key in this.variables;
+    }
+}
+
+// 延迟创建默认实例
+let defaultEnv = null;
+
+// 获取默认实例的函数
+function getDefaultEnv() {
+    if (!defaultEnv) defaultEnv = new EnvLoader({ path: '.env', encoding: 'utf8', debug: false });
+    return defaultEnv;
+}
+
+// 导出对象
+module.exports = {
+    // 默认的环境变量实例，通过 getter 延迟创建
+    get env() {
+        return getDefaultEnv();
+    },
+
+    // 配置加载器函数
+    config: (options = {}) => {
+        // 如果传入的是字符串，则视为路径
+        if (typeof options === 'string') options = { path: options };
+        const { path = '.env', encoding = 'utf8', debug = false } = options;
+        return new EnvLoader({ path, encoding, debug });
+    }
+};

package/install.js

@@ -0,0 +1,26 @@
+const fs = require('fs');
+const path = require('path');
+const { exampleLines } = require('./env');
+
+// 检查项目根目录
+const packageDir = __dirname, projectRoot = path.resolve(packageDir, '../..'), // 向上两级到项目根目录
+    projectEnvPath = path.join(projectRoot, '.env');
+// 检查并创建示例文件
+function checkAndCreateEnvFile() {
+    console.log('🔍 检查 .env 环境变量文件...'), console.log(`📁 项目根目录: ${projectRoot}`);
+    try {
+        if (fs.existsSync(projectEnvPath)) return true;  // 检查项目根目录
+        console.log('⚠️  在项目根目录未找到 .env 文件，正在创建...');
+
+        const formattedContent = exampleLines.join('\n'); // 动态处理示例内容
+        fs.writeFileSync(projectEnvPath, formattedContent, 'utf8');
+        console.log(`✓ 已创建 .env 示例文件: ${projectEnvPath}`), console.log('📝 请在该文件中添加环境变量');
+        return true;
+    } catch (error) {
+        console.error('✗ 创建 .env 文件失败:', error.message);
+    }
+}
+
+// 执行脚本并导出函数
+if (require.main === module) checkAndCreateEnvFile();
+module.exports = { checkAndCreateEnvFile };

package/package.json

@@ -0,0 +1,42 @@
+{
+    "name": "flun-env",
+    "version": "3.0.6",
+    "description": "A simple package to read .env environment files",
+    "main": "index.js",
+    "types": "index.d.ts",
+    "scripts": {
+        "postinstall": "node install.js 2>&1",
+        "test": "echo \"Test completed\" && exit 0"
+    },
+    "bin": {
+        "env-init": "./install.js"
+    },
+    "files": [
+        "index.js",
+        "install.js",
+        "env.js",
+        "index.d.ts",
+        "CHANGELOG.md"
+    ],
+    "keywords": [
+        "env",
+        "environment",
+        "variables",
+        "config",
+        "flun"
+    ],
+    "author": "flun <cn@flun.top>",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/flunGit/flun_ENV.git"
+    },
+    "homepage": "https://www.npmjs.com/flunGit/flun-env#readme",
+    "bugs": {
+        "url": "https://github.com/flunGit/flun_ENV/issues"
+    },
+    "license": "ISC",
+    "engines": {
+        "node": ">=10.0.0"
+    },
+    "type": "commonjs"
+}