mirror of
https://github.com/atom/atom.git
synced 2026-01-23 05:48:10 -05:00
311 lines
10 KiB
CoffeeScript
311 lines
10 KiB
CoffeeScript
_ = require 'underscore-plus'
|
|
fs = require 'fs-plus'
|
|
Task = require './task'
|
|
{Emitter, Subscriber} = require 'emissary'
|
|
GitUtils = require 'git-utils'
|
|
|
|
# Public: Represents the underlying git operations performed by Atom.
|
|
#
|
|
# This class shouldn't be instantiated directly but instead by accessing the
|
|
# `atom.project` global and calling `getRepo()`. Note that this will only be
|
|
# available when the project is backed by a Git repository.
|
|
#
|
|
# This class handles submodules automically by taking a `path` argument to many
|
|
# of the methods. This `path` argument will determine which underlying
|
|
# repository is used.
|
|
#
|
|
# For a repository with submodules this would have the following outcome:
|
|
#
|
|
# ```coffee
|
|
# repo = atom.project.getRepo()
|
|
# repo.getShortHead() # 'master'
|
|
# repo.getShortHead('vendor/path/to/a/submodule') # 'dead1234'
|
|
# ```
|
|
#
|
|
# ## Example
|
|
#
|
|
# ```coffeescript
|
|
# git = atom.project.getRepo()
|
|
# console.log git.getOriginUrl()
|
|
# ```
|
|
#
|
|
# ## Requiring in packages
|
|
#
|
|
# ```coffee
|
|
# {Git} = require 'atom'
|
|
# ```
|
|
module.exports =
|
|
class Git
|
|
Emitter.includeInto(this)
|
|
Subscriber.includeInto(this)
|
|
|
|
# Public: Creates a new Git instance.
|
|
#
|
|
# path - The path to the Git repository to open.
|
|
# options - An object with the following keys (default: {}):
|
|
# :refreshOnWindowFocus - `true` to refresh the index and statuses when the
|
|
# window is focused.
|
|
#
|
|
# Returns a Git instance or null if the repository could not be opened.
|
|
@open: (path, options) ->
|
|
return null unless path
|
|
try
|
|
new Git(path, options)
|
|
catch
|
|
null
|
|
|
|
@exists: (path) ->
|
|
if git = @open(path)
|
|
git.destroy()
|
|
true
|
|
else
|
|
false
|
|
|
|
constructor: (path, options={}) ->
|
|
@repo = GitUtils.open(path)
|
|
unless @repo?
|
|
throw new Error("No Git repository found searching path: #{path}")
|
|
|
|
@statuses = {}
|
|
@upstream = {ahead: 0, behind: 0}
|
|
{@project, refreshOnWindowFocus} = options
|
|
|
|
refreshOnWindowFocus ?= true
|
|
if refreshOnWindowFocus
|
|
{$} = require './space-pen-extensions'
|
|
@subscribe $(window), 'focus', =>
|
|
@refreshIndex()
|
|
@refreshStatus()
|
|
|
|
if @project?
|
|
@subscribe @project.eachBuffer (buffer) => @subscribeToBuffer(buffer)
|
|
|
|
# Subscribes to buffer events.
|
|
subscribeToBuffer: (buffer) ->
|
|
@subscribe buffer, 'saved reloaded path-changed', =>
|
|
if path = buffer.getPath()
|
|
@getPathStatus(path)
|
|
@subscribe buffer, 'destroyed', => @unsubscribe(buffer)
|
|
|
|
# Public: Destroy this `Git` object. This destroys any tasks and subscriptions
|
|
# and releases the underlying libgit2 repository handle.
|
|
destroy: ->
|
|
if @statusTask?
|
|
@statusTask.terminate()
|
|
@statusTask = null
|
|
|
|
if @repo?
|
|
@repo.release()
|
|
@repo = null
|
|
|
|
@unsubscribe()
|
|
|
|
# Returns the corresponding {Repository}
|
|
getRepo: (path) ->
|
|
unless @repo?
|
|
throw new Error("Repository has been destroyed")
|
|
|
|
@repo.submoduleForPath(path) ? @repo
|
|
|
|
# Reread the index to update any values that have changed since the
|
|
# last time the index was read.
|
|
refreshIndex: -> @getRepo().refreshIndex()
|
|
|
|
# Public: Returns the {String} path of the repository.
|
|
getPath: ->
|
|
@path ?= fs.absolute(@getRepo().getPath())
|
|
|
|
# Public: Returns the {String} working directory path of the repository.
|
|
getWorkingDirectory: -> @getRepo().getWorkingDirectory()
|
|
|
|
# Public: Get the status of a single path in the repository.
|
|
#
|
|
# path - A {String} repository-relative path.
|
|
#
|
|
# Returns a {Number} representing the status. This value can be passed to
|
|
# {::isStatusModified} or {::isStatusNew} to get more information.
|
|
getPathStatus: (path) ->
|
|
currentPathStatus = @statuses[path] ? 0
|
|
repo = @getRepo(path)
|
|
pathStatus = repo.getStatus(repo.relativize(path)) ? 0
|
|
if pathStatus > 0
|
|
@statuses[path] = pathStatus
|
|
else
|
|
delete @statuses[path]
|
|
if currentPathStatus isnt pathStatus
|
|
@emit 'status-changed', path, pathStatus
|
|
pathStatus
|
|
|
|
# Public: Is the given path ignored?
|
|
#
|
|
# Returns a {Boolean}.
|
|
isPathIgnored: (path) -> @getRepo().isIgnored(@relativize(path))
|
|
|
|
# Public: Returns true if the given status indicates modification.
|
|
isStatusModified: (status) -> @getRepo().isStatusModified(status)
|
|
|
|
# Public: Returns true if the given path is modified.
|
|
isPathModified: (path) -> @isStatusModified(@getPathStatus(path))
|
|
|
|
# Public: Returns true if the given status indicates a new path.
|
|
isStatusNew: (status) -> @getRepo().isStatusNew(status)
|
|
|
|
# Public: Returns true if the given path is new.
|
|
isPathNew: (path) -> @isStatusNew(@getPathStatus(path))
|
|
|
|
# Public: Returns true if at the root, false if in a subfolder of the
|
|
# repository.
|
|
isProjectAtRoot: ->
|
|
@projectAtRoot ?= @project?.relativize(@getWorkingDirectory()) is ''
|
|
|
|
# Public: Makes a path relative to the repository's working directory.
|
|
relativize: (path) -> @getRepo().relativize(path)
|
|
|
|
# Public: Retrieves a shortened version of the HEAD reference value.
|
|
#
|
|
# This removes the leading segments of `refs/heads`, `refs/tags`, or
|
|
# `refs/remotes`. It also shortens the SHA-1 of a detached `HEAD` to 7
|
|
# characters.
|
|
#
|
|
# path - An optional {String} path in the repository to get HEAD information
|
|
# about. Only needed if the repository contains submodules.
|
|
#
|
|
# Returns a {String}.
|
|
getShortHead: (path) -> @getRepo(path).getShortHead()
|
|
|
|
# Public: Restore the contents of a path in the working directory and index
|
|
# to the version at `HEAD`.
|
|
#
|
|
# This is essentially the same as running:
|
|
#
|
|
# ```
|
|
# git reset HEAD -- <path>
|
|
# git checkout HEAD -- <path>
|
|
# ```
|
|
#
|
|
# path - The {String} path to checkout.
|
|
#
|
|
# Returns a {Boolean} that's true if the method was successful.
|
|
checkoutHead: (path) ->
|
|
repo = @getRepo(path)
|
|
headCheckedOut = repo.checkoutHead(repo.relativize(path))
|
|
@getPathStatus(path) if headCheckedOut
|
|
headCheckedOut
|
|
|
|
# Public: Checks out a branch in your repository.
|
|
#
|
|
# reference - The String reference to checkout
|
|
# create - A Boolean value which, if true creates the new reference if it
|
|
# doesn't exist.
|
|
#
|
|
# Returns a Boolean that's true if the method was successful.
|
|
checkoutReference: (reference, create) ->
|
|
@getRepo().checkoutReference(reference, create)
|
|
|
|
# Public: Retrieves the number of lines added and removed to a path.
|
|
#
|
|
# This compares the working directory contents of the path to the `HEAD`
|
|
# version.
|
|
#
|
|
# path - The {String} path to check.
|
|
#
|
|
# Returns an {Object} with the following keys:
|
|
# :added - The {Number} of added lines.
|
|
# :deleted - The {Number} of deleted lines.
|
|
getDiffStats: (path) ->
|
|
repo = @getRepo(path)
|
|
repo.getDiffStats(repo.relativize(path))
|
|
|
|
# Public: Is the given path a submodule in the repository?
|
|
#
|
|
# path - The {String} path to check.
|
|
#
|
|
# Returns a {Boolean}.
|
|
isSubmodule: (path) ->
|
|
repo = @getRepo(path)
|
|
repo.isSubmodule(repo.relativize(path))
|
|
|
|
# Public: Get the status of a directory in the repository's working directory.
|
|
#
|
|
# path - The {String} path to check.
|
|
#
|
|
# Returns a {Number} representing the status. This value can be passed to
|
|
# {::isStatusModified} or {::isStatusNew} to get more information.
|
|
getDirectoryStatus: (directoryPath) ->
|
|
{sep} = require 'path'
|
|
directoryPath = "#{directoryPath}#{sep}"
|
|
directoryStatus = 0
|
|
for path, status of @statuses
|
|
directoryStatus |= status if path.indexOf(directoryPath) is 0
|
|
directoryStatus
|
|
|
|
# Public: Retrieves the line diffs comparing the `HEAD` version of the given
|
|
# path and the given text.
|
|
#
|
|
# path - The {String} path relative to the repository.
|
|
# text - The {String} to compare against the `HEAD` contents
|
|
#
|
|
# Returns an {Array} of hunk {Object}s with the following keys:
|
|
# :oldStart - The line {Number} of the old hunk.
|
|
# :newStart - The line {Number} of the new hunk.
|
|
# :oldLines - The {Number} of lines in the old hunk.
|
|
# :newLines - The {Number} of lines in the new hunk
|
|
getLineDiffs: (path, text) ->
|
|
# Ignore eol of line differences on windows so that files checked in as
|
|
# LF don't report every line modified when the text contains CRLF endings.
|
|
options = ignoreEolWhitespace: process.platform is 'win32'
|
|
repo = @getRepo(path)
|
|
repo.getLineDiffs(repo.relativize(path), text, options)
|
|
|
|
# Public: Returns the git configuration value specified by the key.
|
|
getConfigValue: (key) -> @getRepo().getConfigValue(key)
|
|
|
|
# Public: Returns the origin url of the repository.
|
|
getOriginUrl: -> @getConfigValue('remote.origin.url')
|
|
|
|
# Public: Returns the upstream branch for the current HEAD, or null if there
|
|
# is no upstream branch for the current HEAD.
|
|
#
|
|
# path - An optional {String} path in the repo to get branch information for.
|
|
# Only needed if the repository contains submodules.
|
|
#
|
|
# Returns a {String} branch name such as `refs/remotes/origin/master`.
|
|
getUpstreamBranch: (path) -> @getRepo(path).getUpstreamBranch()
|
|
|
|
# Public: Returns the current SHA for the given reference.
|
|
#
|
|
# path - An optional {String} path in the repo to get the reference target
|
|
# for. Only needed if the repository contains submodules.
|
|
getReferenceTarget: (reference) -> @getRepo().getReferenceTarget(reference)
|
|
|
|
# Public: Gets all the local and remote references.
|
|
#
|
|
# Returns an {Object} with the following keys:
|
|
# :heads - An {Array} of head reference names.
|
|
# :remotes - An {Array} of remote reference names.
|
|
# :tags - An {Array} of tag reference names.
|
|
getReferences: -> @getRepo().getReferences()
|
|
|
|
# Public: Returns the number of commits behind the current branch is from the
|
|
# its upstream remote branch.
|
|
#
|
|
# reference - The {String} branch reference name.
|
|
# path - The {String} path in the repository to get ahead/behind branch
|
|
# information for. Only needed if the repository contains
|
|
# submodules.
|
|
getAheadBehindCount: (reference, path) ->
|
|
@getRepo(path).getAheadBehindCount(reference)
|
|
|
|
# Public: Returns true if the given branch exists.
|
|
hasBranch: (branch) -> @getReferenceTarget("refs/heads/#{branch}")?
|
|
|
|
# Refreshes the current git status in an outside process and asynchronously
|
|
# updates the relevant properties.
|
|
refreshStatus: ->
|
|
@statusTask = Task.once require.resolve('./repository-status-handler'), @getPath(), ({statuses, upstream, branch}) =>
|
|
statusesUnchanged = _.isEqual(statuses, @statuses) and _.isEqual(upstream, @upstream) and _.isEqual(branch, @branch)
|
|
@statuses = statuses
|
|
@upstream = upstream
|
|
@branch = branch
|
|
@emit 'statuses-changed' unless statusesUnchanged
|