API 参考 / @142vip/utils / VipConfig

类: VipConfig

定义于: packages/utils/src/pkgs/config.ts:8

配置加载

构造函数

构造函数

new VipConfig(): VipConfig

返回

VipConfig

方法

loadCliConfig()

loadCliConfig<T>(configName, defaultValue, cosmiconfigOptions?): T

定义于: packages/utils/src/pkgs/config.ts:14

加载配置

• 本地配置，形如：xxx.config.ts
• 包配置，package.json中的xxx字段

类型参数

T

T

参数

configName

string

defaultValue

any

cosmiconfigOptions?

Partial<OptionsSync>

返回

T

---

loadConfig()

loadConfig<T>(configName, cosmiconfigOptions?): T | undefined

定义于: packages/utils/src/pkgs/config.ts:27

加载cli配置

类型参数

T

T

参数

configName

string

cosmiconfigOptions?

Partial<OptionsSync>

返回

T | undefined

---

loadConfigAtPath()

loadConfigAtPath<T>(configName, filepath): T | undefined

定义于: packages/utils/src/pkgs/config.ts:37

从指定配置文件路径加载（fa lint -f / fa commit -f 等 CLI 显式 -f）

类型参数

T

T

参数

configName

string

filepath

string

返回

T | undefined

---

mergeCommanderConfig()

mergeCommanderConfig<T>(cliConfig, commanderConfig): T

定义于: packages/utils/src/pkgs/config.ts:66

合并配置

类型参数

T

T

参数

cliConfig

Partial<T>

cli自定义配置

commanderConfig

Partial<T>

用户在cli终端输入的配置

返回

T

---

searchConfigFilePath()

searchConfigFilePath(configName, cosmiconfigOptions?): string | undefined

定义于: packages/utils/src/pkgs/config.ts:47

已发现的配置文件绝对路径（供 ESLint 等需要 --config 路径的 CLI）

参数

configName

string

cosmiconfigOptions?

Partial<OptionsSync>

返回

string | undefined