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

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

find

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

findReference

* 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": {...}
 *   }
 * */