@pvm/core

Enumerations

• CacheTag
• PlatformResult

Classes

• AppliedPkg
• CwdCache
• ImmutablePkgSet
• Pkg
• PkgMap
• PkgSet
• Pvm
• ShellError

Interfaces

• AddTagOptions
• ColumnsProvider
• Config
• ConfigResult
• DrainResult
• FetchOptions
• GetConfigOpts
• GetContentsOpts
• GetRemoteUrlOpts
• HostApi
• HttpReqError
• HttpReqOptions
• HttpResponseSuccess
• LoadPkgOptions
• MemoizedFunction
• NamedDiffShellOpts
• PkgCreateOpts
• PkgDiff
• PluginsApi
• PvmProviderInfo
• RunShellError
• Validator

Type aliases

SafeIterationResult

Ƭ SafeIterationResult<T>: [T, null] | [undefined, Error]

Type parameters

Name
T

Defined in

packages/pvm-core/lib/iter/index.ts:35

Variables

debug

• debug: any

Defined in

packages/pvm-core/lib/logger.ts:52

---

defaultConfig

• defaultConfig: Config

Defined in

packages/pvm-core/pvm-defaults.ts:3

---

env

• env: Env

Defined in

packages/pvm-core/lib/env.ts:70

---

envDefaults

• envDefaults: Env

Defined in

packages/pvm-core/env-defaults.ts:3

---

error

• error: any

Defined in

packages/pvm-core/lib/logger.ts:53

---

features

• features: Object

Type declaration

Name	Type
attributeReleaseData	string
commitsToNotes	string
notifyScriptsPath	string
preReleaseHook	string
releaseInfoFromReleaseCtx	string
releaseInfoFromVcs	string
releaseType	string
releaseTypeBuilder	string
releaseTypeByCommits	string

Defined in

packages/pvm-core/lib/plugins/index.ts:28

---

getTagsPointsAt

• getTagsPointsAt: MemoizedFunction<[cwd: string, ref: string], string[]>

Defined in

packages/pvm-core/lib/git/commands.ts:169

---

isBranchExists

• isBranchExists: MemoizedFunction<[cwd: string, branchName: string], boolean>

Defined in

packages/pvm-core/lib/git/commands.ts:151

---

isRemoteBranchExists

• isRemoteBranchExists: MemoizedFunction<[cwd: string, branchName: string], boolean>

Defined in

packages/pvm-core/lib/git/commands.ts:160

---

isShallowRepository

• isShallowRepository: MemoizedFunction<[cwd: string], boolean>

Defined in

packages/pvm-core/lib/git/commands.ts:130

---

isTag

• isTag: MemoizedFunction<[cwd: string, ref: string], boolean>

Defined in

packages/pvm-core/lib/git/commands.ts:142

---

issueRe

• issueRe: RegExp

Defined in

packages/pvm-core/lib/text/jira.ts:1

---

log

• log: any

Defined in

packages/pvm-core/lib/logger.ts:54

---

logger

• logger: SignaleType<"debug" | "silly" | "deprecate", string>

Defined in

packages/pvm-core/lib/logger.ts:24

---

mrkdwnLinkRe

• mrkdwnLinkRe: RegExp

Defined in

packages/pvm-core/lib/text/markdown.ts:2

---

pagingMeta

• pagingMeta: typeof pagingMeta

Defined in

packages/pvm-core/lib/vcs-meta.ts:2

---

pkgTagRe

• pkgTagRe: RegExp

Defined in

packages/pvm-core/lib/tag-meta.ts:6

---

releaseMark

• releaseMark: "-- release commit --"

Defined in

packages/pvm-core/lib/consts.ts:1

---

releaseTypes

• releaseTypes: Object

Type declaration

Name	Type
eq	(a: PvmReleaseType, b: PvmReleaseType) => boolean
gt	(a: PvmReleaseType, b: PvmReleaseType) => boolean
gte	(a: PvmReleaseType, b: PvmReleaseType) => boolean
lt	(a: PvmReleaseType, b: PvmReleaseType) => boolean
lte	(a: PvmReleaseType, b: PvmReleaseType) => boolean
max	<T>(...args: T) => T extends [] ? undefined : PvmReleaseType

Defined in

packages/pvm-core/lib/semver-extra.ts:32

---

releaseTypesInAscendingOrder

• releaseTypesInAscendingOrder: PvmReleaseType[]

Defined in

packages/pvm-core/lib/semver-extra.ts:4

---

taggedCacheManager

• taggedCacheManager: TaggedCacheManager

Defined in

packages/pvm-core/lib/memoize/tagged-cache-manager.ts:124

---

tags

• tags: RegExp[]

Defined in

packages/pvm-core/lib/analyzer/simple.ts:23

---

tagsCache

• tagsCache: CwdCache<string>

Defined in

packages/pvm-core/lib/git/last-release-tag.ts:9

---

versioningFile

• versioningFile: Object

Type declaration

Name	Type
clearCache	() => void
existsForRef	(config: Config, ref: undefined | string) => boolean
load	(config: Config, ref: undefined | string) => false | Record<string, string>
lookupPkgVersion	(pkg: Pkg, ref: undefined | string) => string | void
save	(config: Config, versions: Record<string, string>, index: boolean) => void
stringify	(versions: Record<string, string>) => string

Defined in

packages/pvm-core/lib/dedicated-versions-file.ts:56

Functions

addTag

▸ addTag(cwd, __namedParameters): void

Parameters

Name	Type
cwd	string
__namedParameters	AddTagOptions

Returns

void

Defined in

packages/pvm-core/lib/git/commands.ts:221

---

bindToCwd

▸ bindToCwd<O, F>(cwd, fn): (cmd: string, opts?: O) => ReturnType<F>

Type parameters

Name	Type
O	extends object
F	extends (cmd: string, opts?: O) => any

Parameters

Name	Type
cwd	string
fn	F

Returns

fn

▸ (cmd, opts?): ReturnType<F>

Parameters

Name	Type
cmd	string
opts?	O

Returns

ReturnType<F>

Defined in

packages/pvm-core/lib/shell/index.ts:89

---

cachedRealPath

▸ Const cachedRealPath(...args): string

Parameters

Name	Type
...args	[dir: string]

Returns

string

Defined in

packages/pvm-core/lib/fs.ts:19

---

checkEnv

▸ checkEnv(checks, action, __namedParameters?): boolean

Parameters

Name	Type	Default value
checks	EnvCheck | EnvCheck[]	undefined
action	string	undefined
__namedParameters	Object	undefined
__namedParameters.logger	Object	undefined
__namedParameters.logger.info	(message?: any, ...optionalParams: any[]) => void	console.info
__namedParameters.silent	boolean	true

Returns

boolean

Defined in

packages/pvm-core/lib/env.ts:13

---

clearConfigCacheFor

▸ clearConfigCacheFor(cwd): void

Parameters

Name	Type
cwd	string

Returns

void

Defined in

packages/pvm-core/lib/config/get-config.ts:312

---

cmdOption

▸ cmdOption(name, value?): string

Parameters

Name	Type
name	string
value?	string | number

Returns

string

Defined in

packages/pvm-core/lib/utils/cmd.ts:1

---

cmpReleaseTypes

▸ cmpReleaseTypes(a, b): -1 | 0 | 1

Parameters

Name	Type
a	null | PvmReleaseType
b	null | PvmReleaseType

Returns

-1 | 0 | 1

Defined in

packages/pvm-core/lib/semver-extra.ts:20

---

cmpStr

▸ cmpStr(a, b): number

Parameters

Name	Type
a	string
b	string

Returns

number

Defined in

packages/pvm-core/lib/utils/string.ts:1

---

collectItemsToRecord

▸ collectItemsToRecord<T>(asyncIterator, key): Promise<Record<string, T>>

Type parameters

Name
T

Parameters

Name	Type
asyncIterator	AsyncIterable<T>
key	(x: T) => string

Returns

Promise<Record<string, T>>

Defined in

packages/pvm-core/lib/iter/collect-items.ts:2

---

concatPackages

▸ concatPackages(left, right): Pkg[]

Parameters

Name	Type
left	Iterable<Pkg>
right	Iterable<Pkg>

Returns

Pkg[]

Defined in

packages/pvm-core/lib/pkg.ts:473

---

cutText

▸ cutText(text, maxLen): string

Parameters

Name	Type
text	string
maxLen	number

Returns

string

Defined in

packages/pvm-core/lib/text/index.ts:3

---

cwdShell

▸ cwdShell(cmd, opts?): string

Parameters

Name	Type
cmd	string
opts	ExecSyncOptions

Returns

string

Defined in

packages/pvm-core/lib/shell/index.ts:77

---

cwdToGitRelativity

▸ cwdToGitRelativity(cwd, p, getWorktreeRootCustom?): string

Parameters

Name	Type	Default value
cwd	string	undefined
p	string	undefined
getWorktreeRootCustom	(...args: [cwd: string]) => string	getWorktreeRoot

Returns

string

Defined in

packages/pvm-core/lib/git/worktree.ts:38

---

default

▸ default(messages, defaultLevel?): PvmReleaseType

Parameters

Name	Type	Default value
messages	string[]	undefined
defaultLevel	PvmReleaseType	'minor'

Returns

PvmReleaseType

Defined in

packages/pvm-core/lib/analyzer/simple.ts:6

---

defaultsFromProvider

▸ defaultsFromProvider(provider): RecursivePartial<Config> | undefined

Parameters

Name	Type
provider	PvmProviderInfo

Returns

RecursivePartial<Config> | undefined

Defined in

packages/pvm-core/lib/config/get-config.ts:365

---

deleteTag

▸ deleteTag(cwd, tagName): void

Parameters

Name	Type
cwd	string
tagName	string

Returns

void

Defined in

packages/pvm-core/lib/git/commands.ts:214

---

dottifyList

▸ dottifyList(text, symbolItem?): string

Parameters

Name	Type	Default value
text	string	undefined
symbolItem	string	'-'

Returns

string

Defined in

packages/pvm-core/lib/text/markdown.ts:18

---

drainWhileResolves

▸ drainWhileResolves<T>(asyncIterable): Promise<DrainResult<T>>

Type parameters

Name
T

Parameters

Name	Type
asyncIterable	AsyncIterable<T>

Returns

Promise<DrainResult<T>>

Defined in

packages/pvm-core/lib/iter/index.ts:11

---

enpl

▸ enpl(forms, count, ...args): string

Parameters

Name	Type
forms	string[]
count	number
...args	any[]

Returns

string

Defined in

packages/pvm-core/lib/text/plural.ts:9

---

escapeFilePath

▸ escapeFilePath(fp): string

Parameters

Name	Type
fp	string

Returns

string

Defined in

packages/pvm-core/lib/fs.ts:12

---

expDropRight

▸ expDropRight<T>(list, filterFn): T[]

Type parameters

Name
T

Parameters

Name	Type
list	T[]
filterFn	(entry: T, index: number) => boolean

Returns

T[]

Defined in

packages/pvm-core/lib/utils/array.ts:1

---

extractDomain

▸ extractDomain(url): string | null

Parameters

Name	Type
url	string

Returns

string | null

Defined in

packages/pvm-core/lib/git/commands.ts:108

---

extractVersionFromSemverTag

▸ extractVersionFromSemverTag(semverTag): string

Parameters

Name	Type
semverTag	string

Returns

string

Defined in

packages/pvm-core/lib/tag-meta.ts:25

---

extractVersionsFromAnnotation

▸ extractVersionsFromAnnotation(annotation): Map<string, string>

Parameters

Name	Type
annotation	string

Returns

Map<string, string>

Defined in

packages/pvm-core/lib/versioning.ts:46

---

fetchTags

▸ fetchTags(cwd): void

Parameters

Name	Type
cwd	string

Returns

void

Defined in

packages/pvm-core/lib/git/last-release-tag.ts:11

---

fsEscape

▸ fsEscape(tagName): string

Parameters

Name	Type
tagName	string

Returns

string

Defined in

packages/pvm-core/lib/tag-meta.ts:108

---

getApp

▸ getApp(cwd?, opts?): Pvm

Parameters

Name	Type
cwd	string
opts	GetConfigOpts

Returns

Pvm

Defined in

packages/pvm-core/lib/config/get-config.ts:415

---

getConfigWithoutIncludes

▸ Const getConfigWithoutIncludes(cwd?, opts?): Config

deprecated Please use getConfig instead

Parameters

Name	Type
cwd	string
opts?	GetConfigOpts

Returns

Config

Defined in

packages/pvm-core/lib/config/get-config.ts:422

---

getContents

▸ getContents(cwd, filePath, opts?): string | null

Parameters

Name	Type
cwd	string
filePath	string
opts	GetContentsOpts

Returns

string | null

Defined in

packages/pvm-core/lib/git/commands.ts:25

---

getCurrentBranchIgnoreEnv

▸ getCurrentBranchIgnoreEnv(cwd): string | undefined

Parameters

Name	Type
cwd	string

Returns

string | undefined

Defined in

packages/pvm-core/lib/git/commands.ts:51

---

getDefault

▸ getDefault(mod): any

Parameters

Name	Type
mod	any

Returns

any

Defined in

packages/pvm-core/lib/interop.ts:1

---

getEnv

▸ getEnv(): Env

Returns

Env

Defined in

packages/pvm-core/lib/env.ts:38

---

getGitVersion

▸ Const getGitVersion(): undefined | string

Returns

undefined | string

Defined in

packages/pvm-core/lib/runtime-env/versions.ts:19

---

getHostApi

▸ getHostApi(cwd?): Promise<HostApi>

Parameters

Name	Type
cwd	string

Returns

Promise<HostApi>

Defined in

packages/pvm-core/lib/plugins/index.ts:303

---

getHostUrl

▸ getHostUrl(cwd): string | void

Parameters

Name	Type
cwd	string

Returns

string | void

Defined in

packages/pvm-core/lib/git/commands.ts:98

---

getMainWorktreePath

▸ getMainWorktreePath(dir): string

Для загрузки конфигов и плагинов нужно уметь искать исходное рабочее дерево т.к. в текущем может не быть нужных конфигурационных файлов и node_modules

Parameters

Name	Type
dir	string

Returns

string

Defined in

packages/pvm-core/lib/git/worktree.ts:10

---

getNpmVersion

▸ Const getNpmVersion(): undefined | string

Returns

undefined | string

Defined in

packages/pvm-core/lib/runtime-env/versions.ts:20

---

getOldestDescendantCommitRef

▸ getOldestDescendantCommitRef(cwd, currentBranch, targetRef): string

Parameters

Name	Type
cwd	string
currentBranch	undefined | string
targetRef	string

Returns

string

Defined in

packages/pvm-core/lib/git/commands.ts:187

---

getPersistentRef

▸ getPersistentRef(config, ref): string

Parameters

Name	Type
config	Config
ref	string

Returns

string

Defined in

packages/pvm-core/lib/git/commands.ts:178

---

getRefContent

▸ getRefContent(cwd, ref): string

Parameters

Name	Type
cwd	string
ref	string

Returns

string

Defined in

packages/pvm-core/lib/git/commands.ts:63

---

getReleaseCommits

▸ getReleaseCommits(config, target?): Promise<Commit[] | void>

Parameters

Name	Type	Default value
config	Config	undefined
target	string	'HEAD'

Returns

Promise<Commit[] | void>

Defined in

packages/pvm-core/lib/git/release-commits.ts:60

---

getReleaseRefs

▸ getReleaseRefs(config, target?): [string, string] | void

Parameters

Name	Type	Default value
config	Config	undefined
target	string	'HEAD'

Returns

[string, string] | void

Defined in

packages/pvm-core/lib/git/release-commits.ts:17

---

getRemoteUrl

▸ getRemoteUrl(cwd): string | void

Parameters

Name	Type
cwd	string

Returns

string | void

Defined in

packages/pvm-core/lib/git/commands.ts:81

---

getStagedFiles

▸ getStagedFiles(cwd): string[]

Parameters

Name	Type
cwd	string

Returns

string[]

Defined in

packages/pvm-core/lib/git/commands.ts:34

---

getTagAnnotation

▸ getTagAnnotation(cwd, tagName): string

Parameters

Name	Type
cwd	string
tagName	string

Returns

string

Defined in

packages/pvm-core/lib/git/commands.ts:70

---

getVersionsFromTagCached

▸ getVersionsFromTagCached(cwd, tagName): Map<string, string>

Parameters

Name	Type
cwd	string
tagName	string

Returns

Map<string, string>

Defined in

packages/pvm-core/lib/versioning.ts:76

---

getWorkspaces

▸ getWorkspaces(cwd?): Promise<string[]>

Parameters

Name	Type
cwd	string

Returns

Promise<string[]>

Defined in

packages/pvm-core/lib/workspaces.ts:104

---

getWorkspacesFromRef

▸ getWorkspacesFromRef(ref, cwd?): string[]

Parameters

Name	Type
ref	string
cwd	string

Returns

string[]

Defined in

packages/pvm-core/lib/workspaces.ts:92

---

getWorkspacesSync

▸ getWorkspacesSync(cwd?): string[]

Parameters

Name	Type
cwd	string

Returns

string[]

Defined in

packages/pvm-core/lib/workspaces.ts:83

---

getWorktreeRoot

▸ Const getWorktreeRoot(...args): string

Для загрузки конфигов и плагинов нужно уметь искать исходное рабочее дерево т.к. в текущем может не быть нужных конфигурационных файлов и node_modules

Parameters

Name	Type
...args	[cwd: string]

Returns

string

Defined in

packages/pvm-core/lib/git/worktree.ts:28

---

gitAuthorDate

▸ gitAuthorDate(cwd, ref): Date

Parameters

Name	Type
cwd	string
ref	string

Returns

Date

Defined in

packages/pvm-core/lib/git/commands.ts:138

---

gitFetch

▸ gitFetch(cwd, __namedParameters?): void

Parameters

Name	Type
cwd	string
__namedParameters	FetchOptions

Returns

void

Defined in

packages/pvm-core/lib/git/commands.ts:240

---

gitToCwdRelativity

▸ gitToCwdRelativity(cwd, p, getWorktreeRootCustom?): string

Parameters

Name	Type	Default value
cwd	string	undefined
p	string	undefined
getWorktreeRootCustom	(...args: [cwd: string]) => string	getWorktreeRoot

Returns

string

Defined in

packages/pvm-core/lib/git/worktree.ts:51

---

gracefullyTruncateText

▸ gracefullyTruncateText(text, maxLen, suffix?): string

Parameters

Name	Type	Default value
text	string	undefined
maxLen	number	undefined
suffix	string	'\n...'

Returns

string

Defined in

packages/pvm-core/lib/utils/string.ts:10

---

handleDifferentComparisonRefs

▸ handleDifferentComparisonRefs(logger, storedPkg, providedPkg): void

Parameters

Name	Type
logger	SignaleType<never, never>
storedPkg	Pkg
providedPkg	Pkg

Returns

void

Defined in

packages/pvm-core/lib/utils.ts:87

---

indexFile

▸ indexFile(config, filepath): void

Parameters

Name	Type
config	Config
filepath	string

Returns

void

Defined in

packages/pvm-core/lib/git/commands.ts:46

---

inspectArgs

▸ inspectArgs(args, maxSizePerArg?): string

Parameters

Name	Type	Default value
args	any[]	undefined
maxSizePerArg	number	165

Returns

string

Defined in

packages/pvm-core/lib/inspect-args.ts:3

---

isArraysDeepEqual

▸ isArraysDeepEqual(left, right): boolean

Parameters

Name	Type
left	unknown[]
right	unknown[]

Returns

boolean

Defined in

packages/pvm-core/lib/utils.ts:71

---

isDeepEqual

▸ isDeepEqual(l, r): boolean

Parameters

Name	Type
l	unknown
r	unknown

Returns

boolean

Defined in

packages/pvm-core/lib/utils.ts:49

---

isFlatArraysEqual

▸ isFlatArraysEqual<T>(left, right): boolean

Type parameters

Name
T

Parameters

Name	Type
left	T[]
right	T[]

Returns

boolean

Defined in

packages/pvm-core/lib/utils.ts:7

---

isGenericTagUsed

▸ isGenericTagUsed(config): boolean

Parameters

Name	Type
config	Config

Returns

boolean

Defined in

packages/pvm-core/lib/tag-meta.ts:14

---

isPkgFromMainUnifiedGroup

▸ isPkgFromMainUnifiedGroup(config, pkg): boolean

Parameters

Name	Type
config	Config
pkg	Pkg

Returns

boolean

Defined in

packages/pvm-core/lib/versioning.ts:17

---

isPlainObject

▸ isPlainObject(x): x is Record<string, unknown>

Parameters

Name	Type
x	unknown

Returns

x is Record<string, unknown>

Defined in

packages/pvm-core/lib/app/index.ts:21

---

isRecordsDeepEqual

▸ isRecordsDeepEqual(left, right): boolean

Parameters

Name	Type
left	Record<string, unknown>
right	Record<string, unknown>

Returns

boolean

Defined in

packages/pvm-core/lib/utils.ts:34

---

isReleaseCommit

▸ isReleaseCommit(cwd, ref): boolean

Parameters

Name	Type
cwd	string
ref	string

Returns

boolean

Defined in

packages/pvm-core/lib/versioning.ts:12

---

isReleaseTag

▸ isReleaseTag(config, tag): boolean

Parameters

Name	Type
config	Config
tag	string

Returns

boolean

Defined in

packages/pvm-core/lib/tag-meta.ts:53

---

isSemverTag

▸ isSemverTag(tagName): boolean

Parameters

Name	Type
tagName	string

Returns

boolean

Defined in

packages/pvm-core/lib/tag-meta.ts:37

---

isSemverTagUsed

▸ isSemverTagUsed(config): boolean

Parameters

Name	Type
config	Config

Returns

boolean

Defined in

packages/pvm-core/lib/tag-meta.ts:33

---

isStubVersion

▸ isStubVersion(version): boolean

Parameters

Name	Type
version	string

Returns

boolean

Defined in

packages/pvm-core/lib/tag-meta.ts:114

---

isTagAnnotated

▸ isTagAnnotated(cwd, tagName): boolean

Parameters

Name	Type
cwd	string
tagName	string

Returns

boolean

Defined in

packages/pvm-core/lib/git/commands.ts:59

---

isValidReleaseType

▸ isValidReleaseType(releaseType): boolean

Parameters

Name	Type
releaseType	string | void

Returns

boolean

Defined in

packages/pvm-core/lib/semver-extra.ts:7

---

isWorkingDirectoryClean

▸ Const isWorkingDirectoryClean(cwd): boolean

Parameters

Name	Type
cwd	string

Returns

boolean

Defined in

packages/pvm-core/lib/git/commands.ts:174

---

issueToLink

▸ issueToLink(jiraUrl, text): string

Parameters

Name	Type
jiraUrl	string
text	string

Returns

string

Defined in

packages/pvm-core/lib/text/jira.ts:9

---

issueToMdLink

▸ issueToMdLink(jiraUrl, text): string

Parameters

Name	Type
jiraUrl	string
text	string

Returns

string

Defined in

packages/pvm-core/lib/text/jira.ts:3

---

issueToSlackLink

▸ issueToSlackLink(jiraUrl, text): string

Parameters

Name	Type
jiraUrl	string
text	string

Returns

string

Defined in

packages/pvm-core/lib/text/jira.ts:15

---

lastMatchedTag

▸ lastMatchedTag(cwd, mask, target?): string

Parameters

Name	Type
cwd	string
mask	string
target	undefined | string

Returns

string

Defined in

packages/pvm-core/lib/git/last-release-tag.ts:44

---

lastReleaseTag

▸ lastReleaseTag(config, targetRef?): string

Parameters

Name	Type
config	Config
targetRef	undefined | string

Returns

string

Defined in

packages/pvm-core/lib/git/last-release-tag.ts:59

---

lastReleaseTagIgnoreEnv

▸ lastReleaseTagIgnoreEnv(config, target?): string

Parameters

Name	Type
config	Config
target	undefined | string

Returns

string

Defined in

packages/pvm-core/lib/git/last-release-tag.ts:55

---

lazyCallee

▸ lazyCallee(targetProto, propKey, desc): void

Parameters

Name	Type
targetProto	object
propKey	string
desc	PropertyDescriptor

Returns

void

Defined in

packages/pvm-core/lib/class-helpers.ts:4

---

loadPkg

▸ loadPkg(config, pkgPath, opts?): Pkg | null

Parameters

Name	Type
config	Config
pkgPath	string
opts	LoadPkgOptions

Returns

Pkg | null

Defined in

packages/pvm-core/lib/pkg.ts:433

---

loadRawConfig

▸ loadRawConfig(cwd, ref?): ConfigResult

Parameters

Name	Type
cwd	string
ref	undefined | string

Returns

ConfigResult

Defined in

packages/pvm-core/lib/config/get-config.ts:321

---

loggerFor

▸ Const loggerFor(scope): SignaleType<"debug" | "silly" | "deprecate", never>

Parameters

Name	Type
scope	string

Returns

SignaleType<"debug" | "silly" | "deprecate", never>

Defined in

packages/pvm-core/lib/logger.ts:50

---

makeReleaseForTag

▸ makeReleaseForTag(vcs, tagObject, prevRef): Promise<void>

Parameters

Name	Type
vcs	VcsPlatform
tagObject	any
prevRef	string

Returns

Promise<void>

Defined in

packages/pvm-core/lib/release-notes.ts:23

---

makeReleaseForTagName

▸ makeReleaseForTagName(vcs, tagName, prevRef, opts?): Promise<void>

Parameters

Name	Type
vcs	VcsPlatform
tagName	string
prevRef	string
opts	MakeReleaseForTagNameOpts

Returns

Promise<void>

Defined in

packages/pvm-core/lib/release-notes.ts:37

---

makeSemverGetter

▸ makeSemverGetter(cmd): () => string | undefined

Parameters

Name	Type
cmd	string

Returns

fn

▸ (): string | undefined

Returns

string | undefined

Defined in

packages/pvm-core/lib/runtime-env/versions.ts:5

---

makeTagForPkg

▸ makeTagForPkg(config, pkg): string

Parameters

Name	Type
config	Config
pkg	Pkg

Returns

string

Defined in

packages/pvm-core/lib/tag-meta.ts:100

---

makeUnifiedReleaseTagTest

▸ makeUnifiedReleaseTagTest(config): (tagName: string) => boolean

Parameters

Name	Type
config	Config

Returns

fn

▸ (tagName): boolean

Parameters

Name	Type
tagName	string

Returns

boolean

Defined in

packages/pvm-core/lib/tag-meta.ts:41

---

matchAny

▸ matchAny(pkg, patterns): boolean

Parameters

Name	Type
pkg	Pkg
patterns	string[] | readonly string[]

Returns

boolean

Defined in

packages/pvm-core/lib/pkg-match.ts:15

---

matchGroup

▸ matchGroup<KeyType>(pkg, groups): KeyType | undefined

Type parameters

Name	Type
KeyType	extends string

Parameters

Name	Type
pkg	Pkg
groups	Partial<Record<KeyType, string | string[]>>

Returns

KeyType | undefined

Defined in

packages/pvm-core/lib/pkg-match.ts:24

---

matchPackage

▸ matchPackage(pkg, pattern): boolean

Parameters

Name	Type
pkg	Pkg
pattern	string

Returns

boolean

Defined in

packages/pvm-core/lib/pkg-match.ts:4

---

mema

▸ mema<A, R>(fn, arg?): (...args: A) => R

Type parameters

Name	Type
A	extends any[]
R	R

Parameters

Name	Type	Default value
fn	(...args: A) => R	undefined
arg	number	0

Returns

fn

▸ (...args): R

Parameters

Name	Type
...args	A

Returns

R

Defined in

packages/pvm-core/lib/memoize/mema.ts:1

---

memoize

▸ memoize<A, R>(fn, tags): MemoizedFunction<A, R>

Type parameters

Name	Type
A	extends any[]
R	R

Parameters

Name	Type
fn	(...args: A) => R
tags	CacheTag[]

Returns

MemoizedFunction<A, R>

Defined in

packages/pvm-core/lib/memoize/tagged-cache-manager.ts:126

---

mergeBase

▸ mergeBase(cwd, from, to): string

Parameters

Name	Type
cwd	string
from	string
to	string

Returns

string

Defined in

packages/pvm-core/lib/git/merge-base.ts:4

---

mergeDefaults

▸ mergeDefaults<T>(a, b): T

Type parameters

Name	Type
T	extends Record<string, any>

Parameters

Name	Type
a	T
b	Record<string, any>

Returns

T

Defined in

packages/pvm-core/lib/config/get-config.ts:52

---

migrateDeprecated

▸ migrateDeprecated(config): void

Parameters

Name	Type
config	Config

Returns

void

Defined in

packages/pvm-core/lib/config/get-config.ts:246

---

mkdirp

▸ mkdirp(dir): void

Parameters

Name	Type
dir	string

Returns

void

Defined in

packages/pvm-core/lib/fs.ts:4

---

nameFromTag

▸ nameFromTag(tag): string

Parameters

Name	Type
tag	string

Returns

string

Defined in

packages/pvm-core/lib/tag-meta.ts:82

---

noPackagesInMugError

▸ noPackagesInMugError(): Error

Returns

Error

Defined in

packages/pvm-core/lib/behaviors/no-packages-in-mug.ts:2

---

nthIndex

▸ nthIndex(str, pattern, n): number

Parameters

Name	Type
str	string
pattern	string
n	number

Returns

number

Defined in

packages/pvm-core/lib/text/index.ts:7

---

parseSubArgs

▸ parseSubArgs(args?): Argv<Default>

Parameters

Name	Type	Default value
args	string[]	[]

Returns

Argv<Default>

Defined in

packages/pvm-core/lib/text/sub-args.ts:11

---

parseSubArgsDashedCase

▸ parseSubArgsDashedCase(opts?): Argv<Default>

Parameters

Name	Type	Default value
opts	string[]	[]

Returns

Argv<Default>

Defined in

packages/pvm-core/lib/text/sub-args.ts:7

---

pkgCommits

▸ pkgCommits(pkg, from, to): Promise<Commit[]>

Parameters

Name	Type
pkg	Pkg
from	string
to	string

Returns

Promise<Commit[]>

Defined in

packages/pvm-core/lib/git/pkg-commits.ts:5

---

pkgTagMask

▸ pkgTagMask(config, pkg): string

Parameters

Name	Type
config	Config
pkg	Pkg

Returns

string

Defined in

packages/pvm-core/lib/tag-meta.ts:63

---

pprintPackages

▸ pprintPackages(packages, columnsProvider): void

Parameters

Name	Type
packages	Iterable<Pkg>
columnsProvider	ColumnsProvider<Pkg>

Returns

void

Defined in

packages/pvm-core/lib/utils/pprint.ts:10

---

prepareReleaseData

▸ prepareReleaseData(cwd, targetTag, prevRef): Promise<ReleasePayload>

Parameters

Name	Type
cwd	string
targetTag	string
prevRef	string

Returns

Promise<ReleasePayload>

Defined in

packages/pvm-core/lib/release-notes.ts:9

---

prevReleaseTag

▸ prevReleaseTag(config, target?): string

Parameters

Name	Type	Default value
config	Config	undefined
target	string	'HEAD'

Returns

string

Defined in

packages/pvm-core/lib/git/last-release-tag.ts:69

---

pullOutLinks

▸ pullOutLinks(text): string

Parameters

Name	Type
text	string

Returns

string

Defined in

packages/pvm-core/lib/text/markdown.ts:4

---

readEnv

▸ readEnv(env?): Record<string, string>

Parameters

Name	Type	Default value
env	ProcessEnv	process.env

Returns

Record<string, string>

Defined in

packages/pvm-core/lib/config/get-config.ts:111

---

releaseCommitsAsString

▸ releaseCommitsAsString(config, opts?): string | void

Parameters

Name	Type
config	Config
opts	ReleaseCommitsOpts

Returns

string | void

Defined in

packages/pvm-core/lib/git/release-commits.ts:47

---

releaseTagFilter

▸ releaseTagFilter(config): (string: any) => boolean

Parameters

Name	Type
config	Config

Returns

fn

▸ (string): boolean

Parameters

Name	Type
string	any

Returns

boolean

Defined in

packages/pvm-core/lib/tag-meta.ts:49

---

releaseTagMask

▸ releaseTagMask(config): string

Parameters

Name	Type
config	Config

Returns

string

Defined in

packages/pvm-core/lib/tag-meta.ts:57

---

releaseTagPrefix

▸ releaseTagPrefix(config): string

Parameters

Name	Type
config	Config

Returns

string

Defined in

packages/pvm-core/lib/tag-meta.ts:67

---

replaceLinks

▸ replaceLinks(text, replacer): string

Parameters

Name	Type
text	string
replacer	any

Returns

string

Defined in

packages/pvm-core/lib/text/markdown.ts:10

---

requestWithRetries

▸ requestWithRetries(requestFn, retryOpts?, retryIndex?): any

Parameters

Name	Type	Default value
requestFn	() => any	undefined
retryOpts	Object	{}
retryOpts.retryCodes?	number[]	undefined
retryOpts.timeouts?	number[]	undefined
retryIndex	number	0

Returns

any

Defined in

packages/pvm-core/lib/httpreq.ts:140

---

requireDefault

▸ requireDefault(path): any

Parameters

Name	Type
path	any

Returns

any

Defined in

packages/pvm-core/lib/interop.ts:5

---

resolvePvmProvider

▸ Const resolvePvmProvider(cwd): undefined | PvmProviderInfo

Parameters

Name	Type
cwd	string

Returns

undefined | PvmProviderInfo

Defined in

packages/pvm-core/lib/plugins/provider.ts:15

---

revSafeParse

▸ revSafeParse(ref, cwd): string | null

Parameters

Name	Type
ref	string
cwd	string

Returns

string | null

Defined in

packages/pvm-core/lib/git/rev-parse.ts:37

---

safeIterate

▸ safeIterate<T>(asyncIterable): AsyncIterableIterator<SafeIterationResult<T>>

Type parameters

Name
T

Parameters

Name	Type
asyncIterable	AsyncIterable<T>

Returns

AsyncIterableIterator<SafeIterationResult<T>>

Defined in

packages/pvm-core/lib/iter/index.ts:37

---

searchAnnotatedVersionInDepth

▸ searchAnnotatedVersionInDepth(config, fromTag, pkgName): string | undefined

Parameters

Name	Type
config	Config
fromTag	string
pkgName	string

Returns

string | undefined

Defined in

packages/pvm-core/lib/versioning.ts:87

---

semverTag

▸ semverTag(pkg): string

Parameters

Name	Type
pkg	Pkg

Returns

string

Defined in

packages/pvm-core/lib/tag-meta.ts:96

---

shell

▸ shell(cmd, opts?): string

Parameters

Name	Type
cmd	string
opts	ExecSyncOptions

Returns

string

Defined in

packages/pvm-core/lib/shell/index.ts:29

---

shellOr

▸ shellOr(def, cmd, opts?): string

Parameters

Name	Type
def	string
cmd	string
opts	ExecSyncOptions

Returns

string

Defined in

packages/pvm-core/lib/shell/index.ts:99

---

someSync

▸ someSync<T>(seq, pred): boolean

Type parameters

Name
T

Parameters

Name	Type
seq	Iterable<T>
pred	(item: T) => boolean

Returns

boolean

Defined in

packages/pvm-core/lib/iter/index.ts:60

---

splitTag

▸ splitTag(tag): [string, string]

Parameters

Name	Type
tag	string

Returns

[string, string]

Defined in

packages/pvm-core/lib/tag-meta.ts:73

---

stringifyPkg

▸ stringifyPkg(pkg, manifest?): string

Parameters

Name	Type	Default value
pkg	Pkg	undefined
manifest	PkgMeta	pkg.meta

Returns

string

Defined in

packages/pvm-core/lib/pkg.ts:469

---

stripPkgNamespace

▸ stripPkgNamespace(pkgName): string

Parameters

Name	Type
pkgName	string

Returns

string

Defined in

packages/pvm-core/lib/tag-meta.ts:86

---

stripServiceLabels

▸ stripServiceLabels(text): string

Parameters

Name	Type
text	string

Returns

string

Defined in

packages/pvm-core/lib/text/commits.ts:3

---

takeFirstSync

▸ takeFirstSync<T>(seq): T | undefined

Type parameters

Name
T

Parameters

Name	Type
seq	Iterable<T>

Returns

T | undefined

Defined in

packages/pvm-core/lib/iter/index.ts:54

---

validateAgainstSchema

▸ validateAgainstSchema(config): void

Parameters

Name	Type
config	Config

Returns

void

Defined in

packages/pvm-core/lib/config/get-config.ts:195

---

validateUpdateHints

▸ validateUpdateHints(config, hints): void

Parameters

Name	Type
config	Config
hints	Record<string, any>

Returns

void

Defined in

packages/pvm-core/lib/hints-file.ts:148

---

verifyRequiredBins

▸ verifyRequiredBins(): Promise<void>

Returns

Promise<void>

Defined in

packages/pvm-core/lib/app/required-bin-versions.ts:7

---

wdShell

▸ wdShell(wd, cmd, opts?): string

Parameters

Name	Type
wd	string
cmd	string
opts	ExecSyncOptions

Returns

string

Defined in

packages/pvm-core/lib/shell/index.ts:81

---

wdmemoize

▸ wdmemoize<A, R>(fn, tags, cwdArgPosition?): MemoizedFunction<A, R>

Type parameters

Name	Type
A	extends any[]
R	R

Parameters

Name	Type	Default value
fn	(...args: A) => R	undefined
tags	CacheTag[]	undefined
cwdArgPosition	number	0

Returns

MemoizedFunction<A, R>

Defined in

packages/pvm-core/lib/memoize/tagged-cache-manager.ts:130