設定

Config Loader は、yaml ファイルと json ファイルをサポートしています。ディレクトリ内のすべてのファイルを読み込むことができます。 また、ファイルを指定された形式に自動的に変換します。

インストール

npm i @sumor/config --save

前提条件

Node.JS バージョン

Node.JS バージョン 16.x 以上が必要です

Node.JS の ES モジュールを必要とします

このパッケージは ES モジュールで書かれているため、お使いの package.json ファイル内の以下のコードを変更してください:

{
  "type": "module"
}

使用方法

メソッド

load

• root: string - ルートディレクトリ
• name: string - ファイル名
• ext: string - 変換するファイルの拡張子 (yml, json)

find

* root: string - ルートディレクトリ
* category: string - カテゴリ名
* ext: string - 変換するファイルの拡張子 (yml, json)

設定ファイルの読み込み

import { load } from '@sumor/config'

const config1 = await load(process.cwd(), 'demo')
// ルートディレクトリ内の demo.yml または demo.json を読み込みます

const config2 = await load(process.cwd(), 'demo', 'yaml')
// ルートディレクトリ内の demo.yml または demo.json を読み込み、yaml 形式のファイルに変換します

設定ファイルの検索

import { find } from '@sumor/config'

const config = await find(process.cwd(), 'entity')
// ルートディレクトリ内のすべての *.entity.yml または *.entity.json を読み込みます
/*
 * 例:
 *   car.entity.yml、bike.entity.json
 *   {
 *       "car": {...}
 *       "bike": {...}
 *   }
 * */

他のファイルから設定ファイルを検索

例えば .vue、.js ファイルなど、同じ名前の設定ファイルを持っている場合

import { find } from '@sumor/config'

const config = await find(process.cwd(), 'entity', null, ['vue', 'js'])
// ルートディレクトリ内のすべての *.entity.yml または *.entity.json で、*.vue または *.js と同じ名前のものを読み込みます
/*
 * 例:
 *   car.entity.yml、bike.entity.json
 *   car.vue、bike.js
 *   {
 *       "car": {...}
 *       "bike": {...}
 *   }
 * */