@codearts/plugin / "@codearts/plugin" / SourceControl
"@codearts/plugin".SourceControl
An source control is able to provide resource states to the editor and interact with the editor in several source control related ways.
- acceptInputCommand
- commitTemplate
- count
- id
- inputBox
- label
- quickDiffProvider
- rootUri
- statusBarCommands
• Optional acceptInputCommand: Command
Optional accept input command.
This command will be invoked when the user accepts the value in the Source Control input.
• Optional commitTemplate: string
Optional commit template string.
The Source Control viewlet will populate the Source Control input with this value when appropriate.
• Optional count: number
The UI-visible count of resource states of this source control.
If undefined, this source control will
- display its UI-visible count as zero, and
- contribute the count of its resource states to the UI-visible aggregated count for all source controls
• Readonly id: string
The id of this source control.
• Readonly inputBox: SourceControlInputBox
The input box for this source control.
• Readonly label: string
The human-readable label of this source control.
• Optional quickDiffProvider: QuickDiffProvider
An optional quick diff provider.
• Readonly rootUri: undefined | Uri
The (optional) Uri of the root of this source control.
• Optional statusBarCommands: Command[]
Optional status bar commands.
These commands will be displayed in the editor's status bar.
▸ createResourceGroup(id, label): SourceControlResourceGroup
Create a new resource group.
| Name | Type |
|---|---|
id |
string |
label |
string |
▸ dispose(): void
Dispose this source control.
void