❯ Glitter
Git tooling of the future.
❯
👀
Features
- Config files
- Fast
- Easy to use
- Friendly errors
❯
📚
Documentation
For proper docs, see here
❯
✋
What, how and why?
Glitter is a wrapper for Git essentially, allowing you to compress multiple commands into one. Glitter is written in rust which not only makes it fast but also efficient. We simply parse your .glitterrc and run a few git commands under the hood. Why? Simplicity. If you maintain a project, this is probably the thing for you.
❯
😀
Installation
Windows
scoop install glitter
Other
Please build from source. Make sure to have rust installed.
❯
🎉
Get started
We're so happy to see your interest in Glitter! Leave a
Firstly, lets create a .glitterrc - the configuration file for Glitter.
The glitterrc is basically JSON but a fancy extension. If we want to make it so it automatically templates our commit message we can do it like so:
{
"commit_message": "$1($2): $3+"
}
and you can use it like so: glitter push chore deps bump deps, this would produce the message chore(deps): bump deps. As you probably understand, $ is the prefix of arguments, ie, you can do $1 for the first argument, $2 for the second, etc. The + basically means all arguments after the one you specify will be placed there. Lets say we want it to be chore(Deps): bump deps and it formats with that case. How? Easy. Lets add another key to our file:
{
...
"commit_message_arguments": []
}
inside this key we can then add the argument to configure, in this case, the 2nd one, let's add that.
{
...
"commit_message_arguments": [
{
"argument": 2
}
]
}
and then, to configure the case, add the key case and watch the magic!
{
...
"commit_message_arguments": [
{
"argument": 2,
"case": "pascal"
}
]
}
Running glitter push chore deps bump deps would then give us the commit message of chore(Deps): bump deps
❯
📷
FAQ
Does "this hello" count as 1 or 2 arguments?
This example counts as 1. For example glitter push hello "world how" are you would give the following arguments:
1: hello
2: world how
3: are
4: you
Why is it fast sometimes but not the next?
That's reliant on your internet connection. - We are just running git commands under the hood. Git will be the thing taking it's sweet time.
❯
📣
Available Cases
- lower
- upper
- snake
- screaming-snake
- kebab
- train
- sentence
- title
- class
- pascal
.. got a suggestion? Please make a discussion.
INSTALLATION ERRORS are to go in issues.
3 Sep 19, 2022
54 Sep 17, 2022
20 Jul 16, 2022
13 Aug 20, 2022
15 Dec 28, 2022
12 Jul 2, 2023
214 Dec 26, 2022
18 Nov 16, 2022
68 Dec 19, 2022
1 Jul 18, 2022
26 Dec 18, 2022
3 Mar 22, 2022
32 Dec 30, 2022
3 Oct 30, 2022
126 Dec 11, 2022
6 May 6, 2022
3 Jan 19, 2023
4 Feb 13, 2023
12 May 29, 2023