API 参考 / @142vip/utils / VipPackageJSON

const VipPackageJSON: object

定义于: packages/utils/src/core/package-json.ts:214

package.json处理

getCurrentVersion: (cwd?) => null | string

读取package.json文件，获取version字段

string

null | string

getPackageJSON: <T>(cwd?) => T & PackageJSONMainFest

获取package.json信息

T

string

T & PackageJSONMainFest

getPackagePath: (cwd?) => string

获取package.json的路径

string

string

getPkgGreenLabel: (pkgName) => string

string

string

getPkgRedLabel: (pkgName) => string

string

string

getReleaseVersion: (currentVersion, releaseType) => null | string

基于当前版本，生成新的version

string

ReleaseType

null | string

getVersionGitTag: () => null | string

获取仓库Version对应的tag

• 优先从package.json中获取version
• version对应的tag不存在时，再从git记录中获取最新tag

null | string

hasScript: (packageJSON, script) => boolean

判断package.json文件中是否存在指定的脚本

PackageJSONMainFest

string

boolean

isExistPackageJSON: (cwd?) => boolean

判断package.json是否存在，存在则返回绝对路径

string

boolean

isExistPackageLock: (cwd?) => boolean

判断package-lock.json是否存在

string

boolean

isExistPnpmLock: (cwd?) => boolean

判断是否存在pnpm-lock.yaml文件

string

boolean

isPackageJSON: (packageJSON) => boolean

判断是否为package.json读取的JSON对象

• name|version | description 必须存在一个

PackageJSONMainFest

boolean

promptReleaseVersion: (currentVersion, preid?) => Promise<string>

提供选择框，支持用户自动选择version

string

string

Promise<string>

replaceOrAddToJSON: (json, cwd?) => void

增加或替换JSON数据

• add 增加key、value
• replace 替换某个key的值

Record<string, unknown>

string

void

runScript: (scriptName, cwd?) => Promise<void>

执行脚本

string

string

Promise<void>

updateVersion: (newVersion, cwd?) => void

更新package.json中的version字段

string

string

void