📜  打开 rails secrets 文件 - TypeScript (1)

📅  最后修改于: 2023-12-03 15:10:03.132000             🧑  作者: Mango

打开 Rails Secrets 文件 - TypeScript

在 Rails 项目中,secrets 文件中存储了加密的敏感配置信息,如 API 密钥、数据库密码等等。为确保安全性,secrets 文件不应当被提交到版本控制系统中,而应该被保存在本地。

本文将介绍如何在 TypeScript 环境下打开 secrets 文件。

步骤一:安装依赖

首先,我们需要安装相应的依赖。在命令行中运行如下命令:

npm install dotenv-safe @types/dotenv-safe --save-dev

dotenv-safe 是一个 Node.js 应用程序的环境变量加载器,可以从一个 .env 文件中加载变量。在 Rails 项目中,secrets 文件就是作为 .env 文件来使用的。

@types/dotenv-safe 是 typescript 的类型定义文件。

步骤二:创建 .env 文件

在项目的根目录下新建一个 .env 文件,并在其中添加需要隐藏的敏感参数,如下所示:

API_KEY=xxxxxx
DATABASE_PASSWORD=xxxxxx
步骤三:在 TypeScript 文件中读取 .env 文件

在 TypeScript 中读取 .env 文件需要借助 dotenv-safe 库。

在需要使用敏感参数的 TypeScript 文件中添加如下代码:

import * as dotenv from 'dotenv-safe';

dotenv.config();

const apiKey = process.env.API_KEY;
const dbPwd = process.env.DATABASE_PASSWORD;

console.log(apiKey);
console.log(dbPwd);

在代码中,我们首先使用 import 引入 dotenv-safe 库,然后使用 dotenv.config() 加载 .env 文件中的变量。

最后,我们可以使用 process.env 对象来获取 .env 文件中的变量。

总结

本文介绍了在 TypeScript 中打开 Rails 项目的 secrets 文件的过程,通过依赖 dotenv-safe 库,我们可以方便地读取本地的敏感参数,从而提高了程序的安全性。

注: 需要注意的是,.env 文件中的敏感参数仅仅是隐藏,而不是加密,因此仍然需要谨慎保存。