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