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'])
// 루트 디렉토리에서 *.vue 또는 *.js와 같은 이름을 가진 모든 *.entity.yml 또는 *.entity.json을 로드합니다.
/*
 * 예:
 *   car.entity.yml, bike.entity.json
 *   car.vue, bike.js
 *   {
 *       "car": {...}
 *       "bike": {...}
 *   }
 * */