@freetison/git-super 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +201 -0
- package/README.md +384 -0
- package/bin/git-super.mjs +576 -0
- package/lib/ARCHITECTURE.md +254 -0
- package/lib/auth/auth-strategy.mjs +132 -0
- package/lib/auth/credential-store.mjs +222 -0
- package/lib/auth/oauth-flows.mjs +266 -0
- package/lib/auth/token-manager.mjs +246 -0
- package/lib/cli/auth-commands.mjs +327 -0
- package/lib/config/config-loader.mjs +167 -0
- package/lib/fallback/add-files-strategy.mjs +15 -0
- package/lib/fallback/base-fallback-strategy.mjs +34 -0
- package/lib/fallback/delete-files-strategy.mjs +15 -0
- package/lib/fallback/fallback-resolver.mjs +54 -0
- package/lib/fallback/modify-files-strategy.mjs +15 -0
- package/lib/providers/anthropic-provider.mjs +44 -0
- package/lib/providers/azure-openai-provider.mjs +185 -0
- package/lib/providers/base-oauth-provider.mjs +62 -0
- package/lib/providers/base-provider.mjs +29 -0
- package/lib/providers/generic-oidc-provider.mjs +144 -0
- package/lib/providers/github-copilot-provider.mjs +113 -0
- package/lib/providers/ollama-provider.mjs +109 -0
- package/lib/providers/openai-provider.mjs +44 -0
- package/lib/providers/provider-registry.mjs +99 -0
- package/package.json +59 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,384 @@
|
|
|
1
|
+
# @theia-core/git-super
|
|
2
|
+
|
|
3
|
+
> AI-powered git commits with one command. Works with **any** git repository (Node.js, Python, Java, C++, etc.)
|
|
4
|
+
|
|
5
|
+
Automates the workflow: `git add .` → AI-generated commit message → `git commit` → `git push`
|
|
6
|
+
|
|
7
|
+
## Features
|
|
8
|
+
|
|
9
|
+
- ✨ **AI-powered commit messages** using Ollama (local), Claude, GPT, or enterprise providers
|
|
10
|
+
- 🎯 **Customizable templates** - Add Jira tickets, Linear issues, or custom prefixes
|
|
11
|
+
- 📝 **Conventional Commits** format by default
|
|
12
|
+
- 🌍 **Framework-agnostic** - Works with any git repo, not just Node.js
|
|
13
|
+
- 🔧 **Minimal dependencies** - Only 1 required dependency (open), optional keytar for secure storage
|
|
14
|
+
- ⚡ **Fast** - No compilation, direct execution
|
|
15
|
+
- 🏢 **Enterprise Support** - OAuth/SSO authentication for Azure OpenAI, GitHub Copilot Enterprise
|
|
16
|
+
- 🔐 **Secure** - OS keychain integration for token storage
|
|
17
|
+
- 🏗️ **Multi-Organization** - Switch between work/personal contexts easily
|
|
18
|
+
|
|
19
|
+
## Enterprise & OAuth Support (NEW in v0.2.0)
|
|
20
|
+
|
|
21
|
+
git-super now supports enterprise authentication with OAuth/SSO, perfect for companies using corporate AI services:
|
|
22
|
+
|
|
23
|
+
### Supported OAuth Providers
|
|
24
|
+
|
|
25
|
+
- **Azure OpenAI** with Azure AD (Microsoft Entra ID)
|
|
26
|
+
- **GitHub Copilot Enterprise** with GitHub OAuth
|
|
27
|
+
- **Generic OIDC** for any OpenID Connect compliant provider
|
|
28
|
+
|
|
29
|
+
### Quick OAuth Example
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
# Setup Azure OpenAI with SSO (no API key needed!)
|
|
33
|
+
git super auth login --provider azure-openai
|
|
34
|
+
# Browser opens, authenticate with your company SSO
|
|
35
|
+
# ✅ Token stored securely in OS keychain
|
|
36
|
+
|
|
37
|
+
# Use normally - token auto-refreshes
|
|
38
|
+
git super
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
### Multi-Organization Contexts
|
|
42
|
+
|
|
43
|
+
Switch between different organizational contexts (work, personal, client projects):
|
|
44
|
+
|
|
45
|
+
```bash
|
|
46
|
+
# List contexts
|
|
47
|
+
git super context list
|
|
48
|
+
|
|
49
|
+
# Switch to work (Azure OpenAI with SSO)
|
|
50
|
+
git super context switch work
|
|
51
|
+
|
|
52
|
+
# Switch to personal (local Ollama)
|
|
53
|
+
git super context switch local
|
|
54
|
+
|
|
55
|
+
# Use git super - automatically uses active context settings
|
|
56
|
+
git super
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
**📚 Full Documentation:**
|
|
60
|
+
- [OAuth/SSO Setup Guide](docs/OAUTH_SETUP.md)
|
|
61
|
+
- [Multi-Organization Configuration](docs/MULTI_ORG_CONFIG.md)
|
|
62
|
+
|
|
63
|
+
## Installation
|
|
64
|
+
|
|
65
|
+
### From Verdaccio (Local Testing)
|
|
66
|
+
|
|
67
|
+
```bash
|
|
68
|
+
npm install -g @theia-core/git-super --registry http://localhost:4873
|
|
69
|
+
git config --global alias.super '!git-super'
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
### From npm (Public)
|
|
73
|
+
|
|
74
|
+
```bash
|
|
75
|
+
npm install -g @theia-core/git-super
|
|
76
|
+
git config --global alias.super '!git-super'
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
## Quick Start
|
|
80
|
+
|
|
81
|
+
```bash
|
|
82
|
+
# Make changes to your code
|
|
83
|
+
git super # Stage, commit with AI message, and push
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
## Usage
|
|
87
|
+
|
|
88
|
+
```bash
|
|
89
|
+
git super # add + commit + push
|
|
90
|
+
git super --no-push # add + commit only (no push)
|
|
91
|
+
git super --dry-run # preview message without committing
|
|
92
|
+
git super --amend # amend last commit with new AI message
|
|
93
|
+
git super --no-verify # skip pre-commit hooks
|
|
94
|
+
git super --init # create config file with defaults
|
|
95
|
+
git super --help # show help
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
## Configuration
|
|
99
|
+
|
|
100
|
+
### Create Config File
|
|
101
|
+
|
|
102
|
+
```bash
|
|
103
|
+
git super --init
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
This creates `~/.gitsuperrc` with customizable settings:
|
|
107
|
+
|
|
108
|
+
```json
|
|
109
|
+
{
|
|
110
|
+
"aiProvider": "ollama",
|
|
111
|
+
"aiModel": "mistral:latest",
|
|
112
|
+
"ollamaUrl": "http://localhost:11434",
|
|
113
|
+
"messageTemplate": null,
|
|
114
|
+
"commitRules": {
|
|
115
|
+
"types": ["feat", "fix", "docs", "style", "refactor", "test", "chore", "perf", "ci", "build"],
|
|
116
|
+
"maxLength": 72,
|
|
117
|
+
"allowEmptyScope": true
|
|
118
|
+
}
|
|
119
|
+
}
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
### Message Templates
|
|
123
|
+
|
|
124
|
+
Add custom prefixes to all commit messages:
|
|
125
|
+
|
|
126
|
+
```json
|
|
127
|
+
{
|
|
128
|
+
"messageTemplate": "VTT-3020: {type}({scope}): {message}"
|
|
129
|
+
}
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
**Template Variables:**
|
|
133
|
+
- `{message}` - AI-generated description
|
|
134
|
+
- `{type}` - Commit type (feat, fix, etc.)
|
|
135
|
+
- `{scope}` - Commit scope (if any)
|
|
136
|
+
- `{ticket}` - Custom ticket number (set via `ticketNumber` config)
|
|
137
|
+
|
|
138
|
+
**Examples:**
|
|
139
|
+
|
|
140
|
+
```json
|
|
141
|
+
// Jira tickets
|
|
142
|
+
"messageTemplate": "VTT-3020: {type}({scope}): {message}"
|
|
143
|
+
// Output: VTT-3020: feat(auth): add OAuth login
|
|
144
|
+
|
|
145
|
+
// Linear issues
|
|
146
|
+
"messageTemplate": "LIN-{ticket}: {type}({scope}): {message}"
|
|
147
|
+
|
|
148
|
+
// GitHub issues
|
|
149
|
+
"messageTemplate": "#{ticket}: {type}({scope}): {message}"
|
|
150
|
+
|
|
151
|
+
// Simple prefix
|
|
152
|
+
"messageTemplate": "PROJECT: {type}: {message}"
|
|
153
|
+
|
|
154
|
+
// No template (default Conventional Commits)
|
|
155
|
+
"messageTemplate": null
|
|
156
|
+
```
|
|
157
|
+
|
|
158
|
+
### Environment Variables
|
|
159
|
+
|
|
160
|
+
Override config file settings:
|
|
161
|
+
|
|
162
|
+
```bash
|
|
163
|
+
AI_PROVIDER=anthropic git super # Use Claude
|
|
164
|
+
AI_MODEL=llama3.2 git super # Use different Ollama model
|
|
165
|
+
OLLAMA_URL=http://remote:11434 git super # Remote Ollama instance
|
|
166
|
+
```
|
|
167
|
+
|
|
168
|
+
## AI Providers
|
|
169
|
+
|
|
170
|
+
### Ollama (Default - Local & Free)
|
|
171
|
+
|
|
172
|
+
1. Install Ollama: https://ollama.ai
|
|
173
|
+
2. Pull a model: `ollama pull mistral`
|
|
174
|
+
3. Run: `git super`
|
|
175
|
+
|
|
176
|
+
**Recommended models:**
|
|
177
|
+
- `qwen2.5-coder` - Best for code
|
|
178
|
+
- `deepseek-coder` - Great for commits
|
|
179
|
+
- `mistral` - Fast and accurate
|
|
180
|
+
- `codellama` - Good all-rounder
|
|
181
|
+
|
|
182
|
+
### Anthropic Claude
|
|
183
|
+
|
|
184
|
+
```bash
|
|
185
|
+
export ANTHROPIC_API_KEY='sk-ant-...'
|
|
186
|
+
AI_PROVIDER=anthropic git super
|
|
187
|
+
```
|
|
188
|
+
|
|
189
|
+
### OpenAI GPT
|
|
190
|
+
|
|
191
|
+
```bash
|
|
192
|
+
export OPENAI_API_KEY='sk-...'
|
|
193
|
+
AI_PROVIDER=openai git super
|
|
194
|
+
```
|
|
195
|
+
|
|
196
|
+
## Examples
|
|
197
|
+
|
|
198
|
+
### Basic Workflow
|
|
199
|
+
|
|
200
|
+
```bash
|
|
201
|
+
# Make changes
|
|
202
|
+
echo "new feature" > feature.js
|
|
203
|
+
|
|
204
|
+
# One command does everything
|
|
205
|
+
git super
|
|
206
|
+
# ✨ Output:
|
|
207
|
+
# → git add .
|
|
208
|
+
# 🤖 Generating AI message...
|
|
209
|
+
# 📝 Commit message: "feat(core): add new feature implementation"
|
|
210
|
+
# → git commit
|
|
211
|
+
# ✅ Commit successful
|
|
212
|
+
# → git push origin HEAD
|
|
213
|
+
# ✅ Push successful
|
|
214
|
+
```
|
|
215
|
+
|
|
216
|
+
### With Custom Template
|
|
217
|
+
|
|
218
|
+
```bash
|
|
219
|
+
git super --init
|
|
220
|
+
# Edit ~/.gitsuperrc: "messageTemplate": "PROJ-123: {type}: {message}"
|
|
221
|
+
|
|
222
|
+
git super
|
|
223
|
+
# Output: "PROJ-123: feat: add authentication module"
|
|
224
|
+
```
|
|
225
|
+
|
|
226
|
+
### Preview Before Committing
|
|
227
|
+
|
|
228
|
+
```bash
|
|
229
|
+
git super --dry-run
|
|
230
|
+
# Shows AI-generated message without committing
|
|
231
|
+
```
|
|
232
|
+
|
|
233
|
+
### Commit Without Pushing
|
|
234
|
+
|
|
235
|
+
```bash
|
|
236
|
+
git super --no-push
|
|
237
|
+
# Useful for local branches or when you want to amend later
|
|
238
|
+
```
|
|
239
|
+
|
|
240
|
+
## Configuration Priority
|
|
241
|
+
|
|
242
|
+
Settings are applied in this order (later overrides earlier):
|
|
243
|
+
|
|
244
|
+
1. Built-in defaults
|
|
245
|
+
2. `~/.gitsuperrc` (global config)
|
|
246
|
+
3. Environment variables
|
|
247
|
+
4. Command-line flags
|
|
248
|
+
|
|
249
|
+
## Use Cases
|
|
250
|
+
|
|
251
|
+
### Team Standards
|
|
252
|
+
|
|
253
|
+
Create a shared config template for your team:
|
|
254
|
+
|
|
255
|
+
```json
|
|
256
|
+
{
|
|
257
|
+
"messageTemplate": "TEAM-{ticket}: {type}({scope}): {message}",
|
|
258
|
+
"commitRules": {
|
|
259
|
+
"types": ["feat", "fix", "docs", "refactor", "test", "chore"],
|
|
260
|
+
"maxLength": 100
|
|
261
|
+
}
|
|
262
|
+
}
|
|
263
|
+
```
|
|
264
|
+
|
|
265
|
+
### Multiple Projects
|
|
266
|
+
|
|
267
|
+
Different teams, different prefixes - just edit `~/.gitsuperrc` when switching contexts or set per-project ENV vars.
|
|
268
|
+
|
|
269
|
+
### Non-Node.js Projects
|
|
270
|
+
|
|
271
|
+
Works perfectly with **any** language:
|
|
272
|
+
|
|
273
|
+
```bash
|
|
274
|
+
# Python project
|
|
275
|
+
cd my-python-app/
|
|
276
|
+
git super # ✅ Works!
|
|
277
|
+
|
|
278
|
+
# Java project
|
|
279
|
+
cd my-java-app/
|
|
280
|
+
git super # ✅ Works!
|
|
281
|
+
|
|
282
|
+
# C++ project
|
|
283
|
+
cd my-cpp-app/
|
|
284
|
+
git super # ✅ Works!
|
|
285
|
+
```
|
|
286
|
+
|
|
287
|
+
## Troubleshooting
|
|
288
|
+
|
|
289
|
+
### Ollama not found
|
|
290
|
+
|
|
291
|
+
```bash
|
|
292
|
+
# Check if Ollama is running
|
|
293
|
+
curl http://localhost:11434
|
|
294
|
+
|
|
295
|
+
# Start Ollama
|
|
296
|
+
ollama serve
|
|
297
|
+
|
|
298
|
+
# Install a model
|
|
299
|
+
ollama pull mistral
|
|
300
|
+
```
|
|
301
|
+
|
|
302
|
+
### Model not found
|
|
303
|
+
|
|
304
|
+
The tool auto-detects available models. If your configured model isn't found, it will suggest alternatives.
|
|
305
|
+
|
|
306
|
+
### Commit rejected by hooks
|
|
307
|
+
|
|
308
|
+
```bash
|
|
309
|
+
git super --no-verify # Skip pre-commit hooks (use with caution)
|
|
310
|
+
```
|
|
311
|
+
|
|
312
|
+
## Development
|
|
313
|
+
|
|
314
|
+
```bash
|
|
315
|
+
# Clone repo
|
|
316
|
+
git clone https://github.com/Theia-plataform/theia-core-packages
|
|
317
|
+
cd theia-core-packages/packages/git-super
|
|
318
|
+
|
|
319
|
+
# Install globally for testing
|
|
320
|
+
npm install -g .
|
|
321
|
+
|
|
322
|
+
# Test
|
|
323
|
+
git super --help
|
|
324
|
+
```
|
|
325
|
+
|
|
326
|
+
## License
|
|
327
|
+
|
|
328
|
+
MIT © Angel Sola
|
|
329
|
+
|
|
330
|
+
## Contributing
|
|
331
|
+
|
|
332
|
+
Issues and PRs welcome at [theia-core-packages](https://github.com/Theia-plataform/theia-core-packages)
|
|
333
|
+
|
|
334
|
+
## Related
|
|
335
|
+
|
|
336
|
+
- Part of the [@theia-core](https://github.com/Theia-plataform/theia-core-packages) package ecosystem
|
|
337
|
+
- Works standalone - no Theia dependencies required
|
|
338
|
+
|
|
339
|
+
---
|
|
340
|
+
|
|
341
|
+
## Testing Session ✅
|
|
342
|
+
|
|
343
|
+
Follow this quick testing session to verify package behavior and CI readiness.
|
|
344
|
+
|
|
345
|
+
1. **Prerequisites**
|
|
346
|
+
- Ensure Verdaccio is running: `curl http://localhost:4873`
|
|
347
|
+
- Ensure Ollama is running: `curl http://localhost:11434` (or set `AI_PROVIDER`/API keys for remote providers)
|
|
348
|
+
|
|
349
|
+
2. **Publish locally**
|
|
350
|
+
- `npm publish --registry http://localhost:4873`
|
|
351
|
+
|
|
352
|
+
3. **Install & verify**
|
|
353
|
+
- `npm install -g @theia-core/git-super --registry http://localhost:4873`
|
|
354
|
+
- `git super --help` to confirm installation
|
|
355
|
+
|
|
356
|
+
4. **Basic checks (dry-run & commit)**
|
|
357
|
+
- `git super --init` creates `~/.gitsuperrc`
|
|
358
|
+
- In a test repo: `git super --dry-run` to preview message
|
|
359
|
+
- `git super --no-push` to commit locally without pushing
|
|
360
|
+
|
|
361
|
+
5. **Templates & env vars**
|
|
362
|
+
- Edit `~/.gitsuperrc` `messageTemplate` (e.g., Jira or custom prefixes) and test with changes
|
|
363
|
+
- Override settings with env vars like `AI_PROVIDER`, `AI_MODEL`, `OLLAMA_URL`
|
|
364
|
+
|
|
365
|
+
6. **Cross-language smoke tests**
|
|
366
|
+
- Run `git super --dry-run` in Python, Java, and C++ repos (no build required) to ensure language-agnostic behavior
|
|
367
|
+
|
|
368
|
+
7. **Edge cases & error handling**
|
|
369
|
+
- Non-git directory: expect a clear "Not a git repository" message
|
|
370
|
+
- No changes: expect "No changes to commit"
|
|
371
|
+
- Ollama or provider down: expect graceful fallback messaging
|
|
372
|
+
|
|
373
|
+
8. **Validation & limits**
|
|
374
|
+
- Test `commitRules.maxLength` (e.g., set to a small number) to verify truncation/warnings
|
|
375
|
+
|
|
376
|
+
9. **Success criteria ✅**
|
|
377
|
+
- Package publishes to Verdaccio and installs globally
|
|
378
|
+
- `--init` creates a valid `~/.gitsuperrc`
|
|
379
|
+
- `--dry-run` shows expected AI messages
|
|
380
|
+
- Templates and template variables apply correctly
|
|
381
|
+
- Works across different languages and with alternate AI providers
|
|
382
|
+
- Clear error messages and fallback behavior when providers fail
|
|
383
|
+
|
|
384
|
+
For a full, step-by-step testing workflow and troubleshooting tips, see the repository's testing docs or the original `TESTING.md` (now consolidated into this README).
|