config

Sumor Cloud ツール。
詳細なドキュメント

Config Loader は .yml、.yaml、.json、.config.js ファイルをサポートしています。ディレクトリ内のすべてのファイルをロードできます。

インストール

npm i @sumor/config --save

前提条件

Node.JS バージョン

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

Node.JS ES モジュールの要求

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

{
  "type": "module"
}

使用法

エントリーメソッド

load

import { load } from '@sumor/config'

const config = await load(process.cwd(), 'config')
// config.yml、config.yaml、config.json、config.config.js をロードします

• root: string - ルートディレクトリ
• name: string - ファイル名

meta

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

• root: string - ルートディレクトリ
• suffix: string - 読み込まれる設定オブジェクトの接尾辞 (js のみパスが読み込まれます)

import { meta } from '@sumor/config'

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

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

// 以下のようにすべての設定ファイルが読み込まれます
/*
{
  car: {
    name: 'car',
    sql: "..."
  },
  ship: {
    name: 'ship'
    js: '<root>/ship.js'
  },
  plane: {
    name: 'plane'
  },
  truck: {
    name: 'truck'
  }
*/