@pvm/vcs
Classes
Interfaces
- AbstractVcs
- AddTagOptions
- AlterReleaseResult
- CommitOptions
- CommitResult
- CreateReleasePayload
- FileCommitApi
- LineEntry
- MetaComment
- PlatformRelease
- PlatformReleaseTag
- PushError
- PushOptions
- ReleasePayload
- UnknownCommitContext
- VcsOnly
- VcsRelease
Type aliases
GetReleaseResult
ฦฌ GetReleaseResult: [OK
, PlatformRelease
] | [NOT_FOUND
| NO_SUCH_TAG
, null
]
Defined in
packages/pvm-vcs/types/index.ts:82
Properties
default
โข default: { configExt
: RecursivePartial
<Config
> ; factory
: PluginFactory
; name
: string
= __filename } | { factory
: PluginFactory
; name
: string
= __filename } | { configExt
: RecursivePartial
<Config
> ; name
: string
= __filename }
Variables
command
โข command: "vcs <command>"
Defined in
packages/pvm-vcs/cli/pvm-vcs.ts:51
description
โข description: "cli for version control system"
Defined in
packages/pvm-vcs/cli/pvm-vcs.ts:52
Functions
builder
โธ Const
builder(yargs
): Argv
<Object
>
Parameters
Name | Type |
---|---|
yargs | Argv <Object > |
Returns
Argv
<Object
>
Defined in
packages/pvm-vcs/cli/pvm-vcs.ts:53
getNoteBody
โธ getNoteBody(frontMatter
, text
): string
Parameters
Name | Type |
---|---|
frontMatter | [string , string ][] |
text | string |
Returns
string
Defined in
packages/pvm-vcs/lib/utils.ts:2
handler
โธ Const
handler(): void
Returns
void
Defined in
packages/pvm-vcs/cli/pvm-vcs.ts:85
initVcsPlatform
โธ initVcsPlatform(opts?
): Promise
<VcsPlatform
>
Parameters
Name | Type |
---|---|
opts | InitVcsOpts |
Returns
Promise
<VcsPlatform
>
Defined in
packages/pvm-vcs/lib/vcs.ts:311
lazyInitVcs
โธ lazyInitVcs(cwd
, opts?
): Promise
<VcsPlatform
>
Parameters
Name | Type |
---|---|
cwd | string |
opts | Omit <InitVcsOpts , "cwd" > |
Returns
Promise
<VcsPlatform
>