VS Code API
    Preparing search index...

    Interface SourceControl

    An source control is able to provide resource states to the editor and interact with the editor in several source control related ways.

    interface SourceControl {
        acceptInputCommand?: Command;
        commitTemplate?: string;
        count?: number;
        id: string;
        inputBox: SourceControlInputBox;
        label: string;
        quickDiffProvider?: QuickDiffProvider;
        rootUri: Uri | undefined;
        statusBarCommands?: Command[];
        createResourceGroup(id: string, label: string): SourceControlResourceGroup;
        dispose(): void;
    }
    Index

    Properties

    acceptInputCommand? commitTemplate? count? id inputBox label quickDiffProvider? rootUri statusBarCommands?

    Methods

    createResourceGroup dispose

    Properties

    acceptInputCommand?: Command

    Optional accept input command.

    This command will be invoked when the user accepts the value in the Source Control input.

    commitTemplate?: string

    Optional commit template string.

    The Source Control viewlet will populate the Source Control input with this value when appropriate.

    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
    id: string

    The id of this source control.

    inputBox: SourceControlInputBox

    The input box for this source control.

    label: string

    The human-readable label of this source control.

    quickDiffProvider?: QuickDiffProvider

    An optional quick diff provider.

    rootUri: Uri | undefined

    The (optional) Uri of the root of this source control.

    statusBarCommands?: Command[]

    Optional status bar commands.

    These commands will be displayed in the editor's status bar.

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods