@quiteer/parser-config

用于读取项目下 'ts', 'mjs', 'js', 'cjs', 'json', 'yaml' 的用户配置

安装

bash

npm i @quiteer/parser-config -D

bash

yarn add @quiteer/parser-config -D

bash

pnpm add @quiteer/parser-config -D

使用

configPath : 传入具体路径或者所在目录路径，configPath 的默认路径为当前命令行启动路径（指定 ·configName· 参数时可传入undefined）

configName : 可选，传入参数后，无需指定具体参数，传入目录路径即可，自动匹配不同后缀的配置文件

import { resolve } from 'path'
import { parserConfig } from '@quiteer/parser-config'

const filePath = (path: string) => resolve(resolve(), path)

const cjs = filePath('./test-cjs/config.cjs')
const js = filePath('./test-js/config.js')
const json = filePath('./test-json/config.json')
const mjs = filePath('./test-mjs/config.mjs')
const ts = filePath('./test-ts/config.ts')
const yaml = filePath('./test-yaml/config.yaml')

const test = async () => {
  const yamlConfig = await parserConfig(yaml)
  console.log('yamlConfig: ', yamlConfig)

  const jsonConfig = await parserConfig(json)
  console.log('jsonConfig: ', jsonConfig)

  const mjsConfig = await parserConfig(mjs)
  console.log('mjsConfig: ', mjsConfig)

  const jsConfig = await parserConfig(js)
  console.log('jsConfig: ', jsConfig)

  const cjsConfig = await parserConfig(cjs)
  console.log('cjsConfig: ', cjsConfig)

  const tsConfig = await parserConfig(ts)
  console.log('tsConfig: ', tsConfig)

  const rootConfig = await parserConfig(undefined, 'config')
  console.log('rootConfig: ', rootConfig)

  const elctornup = await parserConfig(undefined, 'electronup.config')
  console.log('elctornup: ', JSON.stringify(elctornup))
}
test()

暴露的api

/**
 * 描述
 * @param {any} configPath:string  需要读取配置的路径
 * @param {any} configName?:string  配置文件名
 * @returns {any}
 */
declare function parserConfig(configPath?: string, configName?: string): Promise<any>

export { parserConfig }

配置文件优先级

'ts' > 'mjs' > 'cjs' > 'js' > 'json' > 'yaml'

@quiteer/parser-config ​

安装 ​

使用 ​

暴露的api ​

配置文件优先级 ​

@quiteer/parser-config

安装

使用

暴露的api

配置文件优先级