config

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

インストール

npm i @sumor/config --save

前提条件

Node.JS バージョン

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

require Node.JS ES モジュール

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

{
  "type": "module"
}

使用方法

エントリメソッド

load

import { load } from '@sumor/config'

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

meta

ディレクトリ内のすべてのファイルをロードします。

• root: string - ルートディレクトリ
• suffix: string - config にロードされるオブジェクトのサフィックス (js はパスのみロードされます)

import { meta } from '@sumor/config'

const config = await meta(process.cwd(), ['js', 'sql'])

/*
デモディレクトリ構造
- root
  - car.json
  - car.sql
  - ship.js
  - plane.yml
*/

// 以下のようにすべての config ファイルがロードされます
/*
{
  car: {
    name: 'car',
    sql: "..."
  },
  ship: {
    name: 'ship'
    js: '<root>/ship.js'
  },
  plane: {
    name: 'plane'
  }
}
*/

旧メソッド

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)

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'])
// ルートディレクトリ内の *.vue または *.js と同じ名前の *.entity.yml または *.entity.json がすべてロードされます
/*
 * 例:
 *   car.entity.yml, bike.entity.json
 *   car.vue, bike.js
 *   {
 *       "car": {...}
 *       "bike": {...}
 *   }
 * */