npm 包 node-config-yml 使用教程-JavaScript中文网-JavaScript教程资源分享门户

什么是 node-config-yml？

node-config-yml 是一款 Node.js 的配置文件工具库，通过读取 YAML 格式的配置文件，提供了简化及优化配置的方法，以解决项目中的配置文件过于冗长及繁琐的问题。

安装

可以通过以下的 npm 命令进行安装：

npm install node-config-yml

使用方法

基本用法

先创建一个 YAML 格式的文件如 config.yaml

port: 3000
database:
  host: localhost
  username: root
  password: '123456'
  database: my-database

在你的代码中引入 node-config-yml 并使用它

const config = require('node-config-yml');

console.log(config.port); // 输出 3000
console.log(config.database.host); // 输出 localhost

组合环境变量

创建一个 config.yaml 文件，而且将需要使用环境变量的配置用 env 前缀代替值部分的值。

port: 3000
database:
  host: env:DB_HOST
  username: root
  password: env:DB_PASSWORD
  database: env:DB_DATABASE

通过使用 Node.js 环境变量，为特定环境设置变量的值

export DB_HOST="127.0.0.1"
export DB_PASSWORD="mysecretpassword"
export DB_DATABASE="my-database"

在你的代码中使用 node-config-yml

const config = require('node-config-yml');

console.log(config.database); // 输出 { host: '127.0.0.1', username: 'root', password: 'mysecretpassword', database: 'my-database' }

加载多个配置文件

node-config-yml 允许你使用多个配置文件，并且可以在不同的应用程序和环境中使用不同的配置文件（比如，开发环境、生产环境等）。

const config = require('node-config-yml');

config.load('./defaults.yml');
config.load('./development.yml', 'development');
config.load('./production.yml', 'production');

console.log(config.database.host); // 输出相应环境下的数据库主机地址

结论

通过本文，我们了解到了如何使用 node-config-yml 在 Node.js 应用程序中读取 YAML 格式的配置文件。这个 npm 包非常简单易用，可以帮助用户轻松地管理配置文件，以提高应用程序的可维护性。

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/6005541381e8991b448d16ba