Skip to content

Introduce a convenient and connected interface for viewing the Git log and related documents in VS Code SCM panel.

License

Notifications You must be signed in to change notification settings

rkotze/git-ease

Repository files navigation

Git ease Git-ease

Quick and convenient linking from local a Git repository to external sources.

Problem

The current UI features in VS Code too limiting to represent Git features in a convenient way. There is also so many connected documents to Git repos (issues, PRs, etc) which I think can be better linked from VS Code.

Vision

Introduce a convenient and connected interface for viewing the Git log and related documents in VS Code SCM panel.

Status Currently building Beta release

  1. Install
  2. Features
  3. Settings

Install

Type "Git-Ease" in VS Code extensions panel or VS Code marketplace Git Ease.

Features

Local Git

  • Search commit history
  • Convenient commit history view in SCM panel
    • Supports co-authored-by meta data
  • Support Git emojis
  • Copy any commit message into input
  • List file changes for a commit, open file and open diff.

Link to remote repository:

  • Issues (GitHub, enterprise GitHub and Bit Bucket) Example: Scans for #1 and links to issue 1
  • Commits (GitHub and enterprise GitHub)
  • Link to project management tools like Jira by providing custom Regex patterns. See settings how to setup.

Settings

Commit log -> linkPatterns

gitEase.log.linkPatterns

Default: []

Configurable in JSON settings only

Provide three properties pre pattern to find custom patterns in the commit log to link from.

  • pattern = Regex format as a string. Regex groups are needed to match with format numbers
  • urlFormat = Url to source like Jira issue. Number will be replaced by matching Regex group
  • textFormat = Text to display. Number will be replaced by matching Regex group

Jira example:

[{
  "pattern": "(GE-[0-9]+)",
  "urlFormat": "https://jira.com/browse/{0}",
  "textFormat": "{0}",
}]