jj-commit 0.2.0

Simplify the jj commit experience
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161

[![CI](https://github.com/Odonno/jj-commit/actions/workflows/ci.yml/badge.svg)](https://github.com/Odonno/jj-commit/actions/workflows/ci.yml)
[![Crates.io version](https://img.shields.io/crates/v/jj-commit)](https://crates.io/crates/jj-commit)
[![Latest release](https://img.shields.io/github/v/release/Odonno/jj-commit)](https://github.com/Odonno/jj-commit/releases/latest)
[![Rust version](https://img.shields.io/badge/rust-1.94.0%2B-orange)](https://www.rust-lang.org)
[![License](https://img.shields.io/github/license/Odonno/jj-commit)](./LICENSE)

# jj-commit

> A guided, convention-aware commit-message builder for [Jujutsu](https://github.com/martinvonz/jj).

`jjc` wraps the `jj` workflow with interactive prompts that enforce a consistent commit style — either [Conventional Commits](https://www.conventionalcommits.org) or [Gitmoji](https://gitmoji.dev) — so you never have to remember the format again. It auto-detects which convention your project uses by inspecting recent commit history.

---

## Install

```sh
cargo install --git https://github.com/Odonno/jj-commit
```

Or build from source:

```sh
git clone https://github.com/Odonno/jj-commit
cd jj-commit
cargo build --release
# binary is at ./target/release/jjc
```

---

## Get started

### Auto-detect convention

With no flags, `jjc` inspects the last 10 commits and picks the convention used most often.

```sh
jjc
```

```
? Commit type
> feat
  fix
  chore
  docs
  style
  refactor
  perf
[↑↓ to move, enter to select]

? Scope (leave empty to finish): auth

? Description: add OAuth2 login support
```

Resulting commit message:

```
feat(auth): add OAuth2 login support
```

---

### Specify a convention explicitly

```sh
jjc --convention conventional
```

```sh
jjc --convention gitmoji
```

---

### Pre-fill the commit type

Skip the type prompt entirely by passing `--type` (Conventional Commits only):

```sh
jjc --type fix
```

```
? Scope (leave empty to finish):

? Description: handle null pointer in user resolver
```

Resulting commit message:

```
fix: handle null pointer in user resolver
```

---

### Pre-fill scopes

Pass one or more `--scopes` flags to seed the scope list (Conventional Commits only):

```sh
jjc --type feat --scopes api --scopes ui
```

```
? Scope (leave empty to finish):   ← api and ui already added

? Description: expose dark mode toggle
```

Resulting commit message:

```
feat(api,ui): expose dark mode toggle
```

---

### Pre-fill from an existing message

Use `--message` to parse an existing commit string into the prompts so you can review and amend each field:

```sh
jjc --message "fix(auth): wrong token expiry"
```

```
? Commit type  [fix]
? Scope        [auth]
? Description  [wrong token expiry]
```

---

### Gitmoji workflow

```sh
jjc --convention gitmoji
```

```
? Gitmoji
> ✨  Introduce new features.
  🐛  Fix a bug.
  🚑️  Critical hotfix.
  📝  Add or update documentation.
  ♻️   Refactor code.
  🔥  Remove code or files.
[↑↓ to move, enter to select]

? Description: streaming support for chat API
```

Resulting commit message:

```
✨ streaming support for chat API
```