Version Control System (VCS) interface, which reads and writes to the local VCS in use.
Defines the API that the editor uses to extract information from the underlying VCS. The implementation of this API is included in VCS plugins, which are GDExtension plugins that inherit [EditorVCSInterface] and are attached (on demand) to the singleton instance of [EditorVCSInterface]. Instead of performing the task themselves, all the virtual functions listed below are calling the internally overridden functions in the VCS plugins to provide a plug-n-play experience. A custom VCS plugin is supposed to inherit from [EditorVCSInterface] and override each of these virtual functions.
$DOCS_URL/tutorials/best_practices/version_control_systems.html
Checks out a [param branch_name] in the VCS.
Commits the currently staged changes and applies the commit [param msg] to the resulting commit.
Creates a new branch named [param branch_name] in the VCS.
Creates a new remote destination with name [param remote_name] and points it to [param remote_url]. This can be an HTTPS remote or an SSH remote.
Discards the changes made in a file present at [param file_path].
Fetches new changes from the [param remote], but doesn't write changes to the current working directory. Equivalent to [code]git fetch[/code].
Gets an instance of an [Array] of [String]s containing available branch names in the VCS.
Gets the current branch name defined in the VCS.
Returns an array of [Dictionary] items (see [method create_diff_file], [method create_diff_hunk], [method create_diff_line], [method add_line_diffs_into_diff_hunk] and [method add_diff_hunks_into_diff_file]), each containing information about a diff. If [param identifier] is a file path, returns a file diff, and if it is a commit identifier, then returns a commit diff.
Returns an [Array] of [Dictionary] items (see [method create_diff_hunk]), each containing a line diff between a file at [param file_path] and the [param text] which is passed in.
Returns an [Array] of [Dictionary] items (see [method create_status_file]), each containing the status data of every modified file in the project folder.
Returns an [Array] of [Dictionary] items (see [method create_commit]), each containing the data for a past commit.
Returns an [Array] of [String]s, each containing the name of a remote configured in the VCS.
Returns the name of the underlying VCS provider.
Initializes the VCS plugin when called from the editor. Returns whether or not the plugin was successfully initialized. A VCS project is initialized at [param project_path].
Pulls changes from the remote. This can give rise to merge conflicts.
Pushes changes to the [param remote]. If [param force] is [code]true[/code], a force push will override the change history already present on the remote.
Remove a branch from the local VCS.
Remove a remote from the local VCS.
Set user credentials in the underlying VCS. [param username] and [param password] are used only during HTTPS authentication unless not already mentioned in the remote URL. [param ssh_public_key_path], [param ssh_private_key_path], and [param ssh_passphrase] are only used during SSH authentication.
Shuts down VCS plugin instance. Called when the user either closes the editor or shuts down the VCS plugin through the editor UI.
Stages the file present at [param file_path] to the staged area.
Unstages the file present at [param file_path] from the staged area to the unstaged area.
Helper function to add an array of [param diff_hunks] into a [param diff_file].
Helper function to add an array of [param line_diffs] into a [param diff_hunk].
Helper function to create a commit [Dictionary] item. [param msg] is the commit message of the commit. [param author] is a single human-readable string containing all the author's details, e.g. the email and name configured in the VCS. [param id] is the identifier of the commit, in whichever format your VCS may provide an identifier to commits. [param unix_timestamp] is the UTC Unix timestamp of when the commit was created. [param offset_minutes] is the timezone offset in minutes, recorded from the system timezone where the commit was created.
Helper function to create a [Dictionary] for storing old and new diff file paths.
Helper function to create a [Dictionary] for storing diff hunk data. [param old_start] is the starting line number in old file. [param new_start] is the starting line number in new file. [param old_lines] is the number of lines in the old file. [param new_lines] is the number of lines in the new file.
Helper function to create a [Dictionary] for storing a line diff. [param new_line_no] is the line number in the new file (can be [code]-1[/code] if the line is deleted). [param old_line_no] is the line number in the old file (can be [code]-1[/code] if the line is added). [param content] is the diff text. [param status] is a single character string which stores the line origin.
Helper function to create a [Dictionary] used by editor to read the status of a file.
Pops up an error message in the editor which is shown as coming from the underlying VCS. Use this to show VCS specific error messages.
A new file has been added.
An earlier added file has been modified.
An earlier added file has been renamed.
An earlier added file has been deleted.
An earlier added file has been typechanged.
A file is left unmerged.
A commit is encountered from the commit area.
A file is encountered from the staged area.
A file is encountered from the unstaged area.