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)

Configファイルのロード

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形式のファイルに変換します

Configファイルの検索

import { find } from '@sumor/config'

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

他のファイルからのConfigファイルの検索

.vue、.jsファイルなど、同じ名前のConfigファイルを持つ場合

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