|
1 | | -# Git Ranger |
| 1 | +<p align="center"> |
| 2 | + <img src="src/CodingWithCalvin.GitRanger/Resources/Icons/icon.png" alt="Git Ranger Logo" width="128" /> |
| 3 | +</p> |
2 | 4 |
|
3 | | -A visually exciting Git management extension for Visual Studio 2022/2026, bringing GitLens-style functionality with theme-adaptive vibrant colors. |
| 5 | +# 🤠 Git Ranger |
4 | 6 |
|
5 | | -## Features |
| 7 | +> *Taming your Git history, one line at a time!* 🐎 |
6 | 8 |
|
7 | | -### Inline Blame Annotations |
8 | | -See who changed each line directly in the editor, with author name, commit date, and message displayed at the end of each line. |
| 9 | +[](https://visualstudio.microsoft.com/) |
| 10 | +[](https://dotnet.microsoft.com/) |
| 11 | +[](LICENSE) |
9 | 12 |
|
10 | | -- Color-coded by author (each contributor gets a unique vibrant color) |
11 | | -- Optional age-based heat map (green = recent, red = old) |
12 | | -- Configurable opacity and display format |
13 | | -- Hover for full commit details |
| 13 | +--- |
| 14 | + |
| 15 | +A **visually stunning** Git management extension for Visual Studio 2022/2026, bringing GitLens-style functionality with theme-adaptive vibrant colors. 🎨✨ |
| 16 | + |
| 17 | +--- |
| 18 | + |
| 19 | +## 🚀 Features |
| 20 | + |
| 21 | +### 🔍 Inline Blame Annotations |
| 22 | + |
| 23 | +See who changed each line **directly in the editor** — author name, commit date, and message displayed right at the end of each line! |
| 24 | + |
| 25 | +- 🎨 **Color-coded by author** — each contributor gets a unique vibrant color |
| 26 | +- 🔥 **Heat map mode** — green = recent, red = old (optional) |
| 27 | +- 👁️ **Configurable opacity** and display format |
| 28 | +- 💬 **Hover for full commit details** |
| 29 | + |
| 30 | +### 📊 Blame Gutter Margin |
14 | 31 |
|
15 | | -### Blame Gutter Margin |
16 | | -A visual indicator in the editor margin showing commit history at a glance. |
| 32 | +A visual indicator in the editor margin showing commit history **at a glance**. |
17 | 33 |
|
18 | | -- Age bars showing relative commit age |
19 | | -- Author color indicators |
20 | | -- Click to copy commit SHA |
21 | | -- Hover for commit details |
| 34 | +- 📈 Age bars showing relative commit age |
| 35 | +- 🎯 Author color indicators |
| 36 | +- 📋 Click to copy commit SHA |
| 37 | +- 🔎 Hover for commit details |
22 | 38 |
|
23 | | -### Planned Features |
24 | | -- **File History** - View all commits affecting the current file |
25 | | -- **Commit Details** - Deep dive into any commit |
26 | | -- **Interactive Git Graph** - Visual branch/merge history (SkiaSharp-powered) |
27 | | -- **Comparison Tools** - Compare with previous revisions |
| 39 | +### 🔮 What's Next? |
28 | 40 |
|
29 | | -## Installation |
| 41 | +Check out our [issues list](https://github.com/CodingWithCalvin/VS-GitRanger/issues) to see what features are planned and vote on what you'd like to see next! |
| 42 | + |
| 43 | +--- |
| 44 | + |
| 45 | +## 📦 Installation |
30 | 46 |
|
31 | 47 | ### From Visual Studio Marketplace |
32 | | -*(Coming soon)* |
| 48 | + |
| 49 | +🚧 *Coming soon!* 🚧 |
33 | 50 |
|
34 | 51 | ### From Source |
35 | | -1. Clone the repository |
36 | | -2. Open `CodingWithCalvin.GitRanger.sln` in Visual Studio 2022 |
37 | | -3. Build the solution |
38 | | -4. The VSIX will be created in the output directory |
39 | 52 |
|
40 | | -## Configuration |
| 53 | +```bash |
| 54 | +# 1. Clone the repository |
| 55 | +git clone https://github.com/CodingWithCalvin/VS-GitRanger.git |
| 56 | + |
| 57 | +# 2. Open in Visual Studio 2022 |
| 58 | +# 3. Build the solution (F5 to debug) |
| 59 | +# 4. VSIX will be created in the output directory |
| 60 | +``` |
| 61 | + |
| 62 | +--- |
| 63 | + |
| 64 | +## ⚙️ Configuration |
41 | 65 |
|
42 | | -Configure Git Ranger via **Tools > Options > Git Ranger** |
| 66 | +Configure Git Ranger via **Tools → Options → Git Ranger** |
| 67 | + |
| 68 | +### 🏷️ Blame Settings |
43 | 69 |
|
44 | | -### Blame Settings |
45 | 70 | | Setting | Description | Default | |
46 | 71 | |---------|-------------|---------| |
47 | | -| Enable Inline Blame | Show blame at end of lines | `true` | |
48 | | -| Enable Blame Gutter | Show blame in margin | `true` | |
49 | | -| Show Author Name | Display author in inline blame | `true` | |
50 | | -| Show Commit Date | Display date in inline blame | `true` | |
51 | | -| Show Commit Message | Display message in inline blame | `true` | |
| 72 | +| Enable Inline Blame | Show blame at end of lines | ✅ `true` | |
| 73 | +| Enable Blame Gutter | Show blame in margin | ✅ `true` | |
| 74 | +| Show Author Name | Display author in inline blame | ✅ `true` | |
| 75 | +| Show Commit Date | Display date in inline blame | ✅ `true` | |
| 76 | +| Show Commit Message | Display message in inline blame | ✅ `true` | |
52 | 77 | | Date Format | `relative` or custom format string | `relative` | |
53 | 78 |
|
54 | | -### Color Settings |
| 79 | +### 🎨 Color Settings |
| 80 | + |
55 | 81 | | Setting | Description | Default | |
56 | 82 | |---------|-------------|---------| |
57 | 83 | | Color Mode | `Author`, `Age`, or `None` | `Author` | |
58 | 84 | | Max Age (days) | Maximum age for heat map | `365` | |
59 | 85 |
|
60 | | -### Display Settings |
| 86 | +### 🖥️ Display Settings |
| 87 | + |
61 | 88 | | Setting | Description | Default | |
62 | 89 | |---------|-------------|---------| |
63 | 90 | | Inline Blame Opacity | Transparency (0.0 - 1.0) | `0.7` | |
64 | | -| Compact Mode | Condensed display format | `false` | |
| 91 | +| Compact Mode | Condensed display format | ❌ `false` | |
65 | 92 | | Gutter Width | Width in pixels | `40` | |
66 | | -| Show Age Bars | Visual age indicators | `true` | |
| 93 | +| Show Age Bars | Visual age indicators | ✅ `true` | |
67 | 94 |
|
68 | | -## Requirements |
| 95 | +--- |
69 | 96 |
|
70 | | -- Visual Studio 2022 (17.0) or later |
71 | | -- .NET Framework 4.8 |
| 97 | +## 📋 Requirements |
72 | 98 |
|
73 | | -## Technology Stack |
| 99 | +- 💻 Visual Studio 2022 (17.0) or later |
| 100 | +- 🔧 .NET Framework 4.8 |
74 | 101 |
|
75 | | -- **Git Integration**: LibGit2Sharp |
76 | | -- **UI Framework**: WPF |
77 | | -- **Graph Rendering**: SkiaSharp (planned) |
78 | | -- **VS Integration**: Community.VisualStudio.Toolkit |
| 102 | +--- |
79 | 103 |
|
80 | | -## Contributing |
| 104 | +## 🛠️ Technology Stack |
81 | 105 |
|
82 | | -Contributions are welcome! Please feel free to submit issues and pull requests. |
| 106 | +| Component | Technology | |
| 107 | +|-----------|------------| |
| 108 | +| 🔗 Git Integration | LibGit2Sharp | |
| 109 | +| 🎨 UI Framework | WPF | |
| 110 | +| 📊 Graph Rendering | SkiaSharp *(planned)* | |
| 111 | +| 🔌 VS Integration | Community.VisualStudio.Toolkit | |
83 | 112 |
|
84 | | -1. Fork the repository |
85 | | -2. Create a feature branch (`git checkout -b feature/amazing-feature`) |
86 | | -3. Commit your changes (`git commit -m 'Add amazing feature'`) |
87 | | -4. Push to the branch (`git push origin feature/amazing-feature`) |
88 | | -5. Open a Pull Request |
| 113 | +--- |
| 114 | + |
| 115 | +## 🤝 Contributing |
89 | 116 |
|
90 | | -## License |
| 117 | +Contributions are welcome! Feel free to submit issues and pull requests. 💪 |
91 | 118 |
|
92 | | -This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. |
| 119 | +1. 🍴 Fork the repository |
| 120 | +2. 🌿 Create a feature branch (`git checkout -b feature/amazing-feature`) |
| 121 | +3. 💾 Commit your changes (`git commit -m 'feat: add amazing feature'`) |
| 122 | +4. 📤 Push to the branch (`git push origin feature/amazing-feature`) |
| 123 | +5. 🎉 Open a Pull Request |
| 124 | + |
| 125 | +--- |
93 | 126 |
|
94 | | -## Author |
| 127 | +## 📄 License |
| 128 | + |
| 129 | +This project is licensed under the **MIT License** — see the [LICENSE](LICENSE) file for details. |
| 130 | + |
| 131 | +--- |
| 132 | + |
| 133 | +## 👨💻 Author |
95 | 134 |
|
96 | 135 | **Calvin A. Allen** |
97 | | -- Website: [codingwithcalvin.net](https://codingwithcalvin.net) |
98 | | -- GitHub: [@CodingWithCalvin](https://github.com/CodingWithCalvin) |
| 136 | + |
| 137 | +[](https://codingwithcalvin.net) |
| 138 | +[](https://github.com/CodingWithCalvin) |
99 | 139 |
|
100 | 140 | --- |
101 | 141 |
|
102 | | -*Git Ranger - Taming your Git history, one line at a time.* |
| 142 | +<div align="center"> |
| 143 | + |
| 144 | +### ⭐ If you find Git Ranger useful, please consider giving it a star! ⭐ |
| 145 | + |
| 146 | +*Made with ❤️ for the Visual Studio community from Coding With Calvin* |
| 147 | + |
| 148 | +</div> |
0 commit comments