Class: VcsOnlyStenographer

@pvm/vcs.VcsOnlyStenographer

Implements

• VcsOnly

Constructors

constructor

• new VcsOnlyStenographer(cwd)

Parameters

Name	Type
cwd	string

Defined in

packages/pvm-vcs/lib/vcs-only-stenographer.ts:20

Properties

_transcript

• _transcript: LineEntry[]

Defined in

packages/pvm-vcs/lib/vcs-only-stenographer.ts:17

---

cwd

• cwd: string

Implementation of

VcsOnly.cwd

Defined in

packages/pvm-vcs/lib/vcs-only-stenographer.ts:16

---

isDryRun

• isDryRun: boolean = true

Implementation of

VcsOnly.isDryRun

Defined in

packages/pvm-vcs/lib/vcs-only-stenographer.ts:18

Accessors

isEmpty

• get isEmpty(): boolean

Returns

boolean

Defined in

packages/pvm-vcs/lib/vcs-only-stenographer.ts:25

Methods

addFiles

▸ addFiles(filePaths): Promise<unknown>

Parameters

Name	Type
filePaths	string[]

Returns

Promise<unknown>

Implementation of

VcsOnly.addFiles

Defined in

packages/pvm-vcs/lib/vcs-only-stenographer.ts:60

---

addTag

▸ addTag(tagName, ref, opts?): Promise<void>

Parameters

Name	Type
tagName	string
ref	string
opts?	AddTagOptions

Returns

Promise<void>

Implementation of

VcsOnly.addTag

Defined in

packages/pvm-vcs/lib/vcs-only-stenographer.ts:72

---

addTranscript

▸ addTranscript(title, body?): Promise<void>

Parameters

Name	Type	Default value
title	string	undefined
body	string	''

Returns

Promise<void>

Defined in

packages/pvm-vcs/lib/vcs-only-stenographer.ts:52

---

appendFile

▸ appendFile(filePath, content): Promise<unknown>

Parameters

Name	Type
filePath	string
content	string

Returns

Promise<unknown>

Implementation of

VcsOnly.appendFile

Defined in

packages/pvm-vcs/lib/vcs-only-stenographer.ts:84

---

beginCommit

▸ beginCommit(): UnknownCommitContext

Returns

UnknownCommitContext

Implementation of

VcsOnly.beginCommit

Defined in

packages/pvm-vcs/lib/vcs-only-stenographer.ts:39

---

commit

▸ commit(message, _opts?): Promise<undefined | CommitResult>

Parameters

Name	Type
message	string
_opts?	Record<string, unknown>

Returns

Promise<undefined | CommitResult>

Implementation of

VcsOnly.commit

Defined in

packages/pvm-vcs/lib/vcs-only-stenographer.ts:88

---

deleteFile

▸ deleteFile(filePath): Promise<unknown>

Parameters

Name	Type
filePath	string

Returns

Promise<unknown>

Implementation of

VcsOnly.deleteFile

Defined in

packages/pvm-vcs/lib/vcs-only-stenographer.ts:68

---

isSomethingForCommit

▸ isSomethingForCommit(): boolean

Returns

boolean

Implementation of

VcsOnly.isSomethingForCommit

Defined in

packages/pvm-vcs/lib/vcs-only-stenographer.ts:48

---

join

▸ join(separator?): string

Parameters

Name	Type	Default value
separator	string	'\n'

Returns

string

Defined in

packages/pvm-vcs/lib/vcs-only-stenographer.ts:29

---

push

▸ push(opts?): Promise<unknown>

Parameters

Name	Type
opts	PushOptions

Returns

Promise<unknown>

Implementation of

VcsOnly.push

Defined in

packages/pvm-vcs/lib/vcs-only-stenographer.ts:92

---

rollbackCommit

▸ rollbackCommit(_commitContext): Promise<void>

Parameters

Name	Type
_commitContext	UnknownCommitContext

Returns

Promise<void>

Implementation of

VcsOnly.rollbackCommit

Defined in

packages/pvm-vcs/lib/vcs-only-stenographer.ts:43

---

updateFile

▸ updateFile(filePath, content): Promise<unknown>

Parameters

Name	Type
filePath	string
content	string

Returns

Promise<unknown>

Implementation of

VcsOnly.updateFile

Defined in

packages/pvm-vcs/lib/vcs-only-stenographer.ts:64