Skip to content

Commit 3969cc0

Browse files
committed
feat(git-editor): Adds a new extentsion that lets the user use vicinae as a git editor
1 parent 801ce90 commit 3969cc0

22 files changed

+5091
-0
lines changed

extensions/git-editor/.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
node_modules
2+
vicinae-env.d.ts

extensions/git-editor/README.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# Git Editor
2+
3+
Use Vicinae as your git editor for commits and interactive rebases.
4+
5+
## Features
6+
7+
### Git Commit
8+
9+
Write commit messages with a user-friendly interface. Choose between two commit styles:
10+
11+
- **Conventional Commits** - Structured commit messages with type, scope, and breaking change indicators
12+
- Types: `feat`, `fix`, `docs`, `ci`, `wip`
13+
- Optional scope
14+
- Breaking change flag
15+
- **Simple** - Free-form commit message
16+
17+
You can swap between commit styles at any time while writing your message.
18+
19+
### Interactive Rebase
20+
21+
A visual interface for `git rebase -i` with full control over your commits:
22+
23+
- **Reorder commits** - Move commits up/down with `Ctrl+W` / `Ctrl+S`
24+
- **Change commit actions** - Quick shortcuts for common operations:
25+
- `p` - Pick
26+
- `e` - Edit
27+
- `r` - Reword
28+
- `f` - Fixup
29+
- `d` - Drop
30+
31+
Commits are displayed with their hash, message, date, and current action (color-coded).
32+
33+
## Setup
34+
35+
The extension includes a built-in setup wizard. When you first run it:
36+
37+
1. Open the Git Commit or Git Sequence command in Vicinae
38+
2. Press `Ctrl+Enter` to automatically configure git
39+
40+
This sets the following git configuration:
41+
42+
```bash
43+
git config --global core.editor "git-vicinae-editor"
44+
git config --global sequence.editor "git-vicinae-sequence-editor"
45+
```
46+
47+
## Usage
48+
49+
After setup, simply use git as normal:
50+
51+
```bash
52+
# For commits
53+
git commit
54+
55+
# For interactive rebase
56+
git rebase -i HEAD~5
57+
```
58+
59+
Vicinae will automatically open with the appropriate interface.
60+
61+
## Preferences
62+
63+
| Name | Type | Default | Description |
64+
|------|------|---------|-------------|
65+
| Commit Type | Dropdown | Conventional Commits | Choose between Conventional Commits or Simple format |
66+
38.5 KB
Loading
206 KB
Loading
35.4 KB
Loading

0 commit comments

Comments
 (0)