https://github.com/rkotze/git-ease
Introduce a convenient and connected interface for viewing the Git log and related documents in VS Code SCM panel.
https://github.com/rkotze/git-ease
commit git git-log github linking vscode-extension
Last synced: 9 months ago
JSON representation
Introduce a convenient and connected interface for viewing the Git log and related documents in VS Code SCM panel.
- Host: GitHub
- URL: https://github.com/rkotze/git-ease
- Owner: rkotze
- License: mit
- Created: 2020-11-14T19:19:00.000Z (about 5 years ago)
- Default Branch: trunk
- Last Pushed: 2024-10-02T08:32:29.000Z (over 1 year ago)
- Last Synced: 2025-02-17T16:54:00.429Z (12 months ago)
- Topics: commit, git, git-log, github, linking, vscode-extension
- Language: TypeScript
- Homepage: https://marketplace.visualstudio.com/items?itemName=RichardKotze.git-ease
- Size: 2.26 MB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# 
Git-ease
 [](https://marketplace.visualstudio.com/items?itemName=RichardKotze.git-ease.svg)
> 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](#install)
1. [Features](#features)
1. [Settings](#settings)
## Install
Type **"Git-Ease"** in VS Code extensions panel or VS Code marketplace [Git Ease](https://marketplace.visualstudio.com/items?itemName=RichardKotze.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:
```json
[{
"pattern": "(GE-[0-9]+)",
"urlFormat": "https://jira.com/browse/{0}",
"textFormat": "{0}",
}]
```