config

Sumor Cloudのツール。
詳細なドキュメント
Config Loaderはyamlおよびjsonファイルをサポートしています。ディレクトリ内のすべてのファイルをロードできます。
そして、ファイルを指定された形式に自動変換します。

インストール

npm i @sumor/config --save

前提条件

Node.JS バージョン

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

Node.JS ES モジュールの必要性

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

{
  "type": "module"
}

使用法

エントリーメソッド

load

import { load } from '@sumor/config'

• root：string - ルートディレクトリ
• name：string - ファイル名
• ext：string - 変換するファイル拡張子（yml、json）

find

import { find } from '@sumor/config'

• root：string - ルートディレクトリ
• category：string - カテゴリ名
• ext：string - 変換するファイル拡張子（yml、json）

findReference

import { findReference } from '@sumor/config'

• root：string - ルートディレクトリ
• references：array - 参照ファイルの拡張子（vue、js）
• 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 { findReference } from '@sumor/config'

const config = await findReference(process.cwd(), ['vue', 'js'])
// ルートディレクトリにある*.entity.ymlまたは*.entity.jsonのうち、*.vueまたは*.jsと同じ名前のファイルをすべて読み込みます
/*
 * 例：
 *   car.entity.yml、bike.entity.json
 *   car.vue、bike.js
 *   {
 *       "car": {...}
 *       "bike": {...}
 *   }
 * */