Gnomit

Gnomit is a simple Git commit message editor for Gnome, inspired by the excellent Komet app for macOS.

Gnomit is written in GJS¹, uses Flatpak, and is built with Gnome Builder.

Features

• Highlights overflow of subject line when it exceeds 69 characters.
• Inserts empty line between subject line and rest of message.
• Has spell checking.
• Select All selects only your commit message, not the Git commit comment.
• Displays project folder and branch in window header.
• Git Commit comment is not editable.
• Dark theme support: the overflow highlight is adjusted according to your theme.

Like this? Fund us!

Small Technology Foundation is a tiny, independent not-for-profit.

We exist in part thanks to patronage by people like you. If you share our vision and want to support our work, please become a patron or donate to us today and help us continue to exist.

Installation

You can install Gnomit using Gnome Software and Pop!_Shop (Pop!_OS 20.04+), from Flathub, or from my web site.

Gnome Software & Pop!_Shop

1. Launch Gnome Software/Pop!_Shop and search for Gnomit.

2. Hit the Install button.

3. Set Gnomit as your Git editor:

   git config --global core.editor "flatpak run org.small_tech.Gnomit"

Flathub

1. Make sure you’ve set up Flathub.

2. In Terminal:

   flatpak install flathub org.small_tech.Gnomit

3. Set Gnomit as your Git editor:

   git config --global core.editor "flatpak run org.small_tech.Gnomit"

From my web site

Installing from Gnome Software/Pop!_Shop or Flathub is recommeded as you will be notified of updates and can easily update them.

That said, it is nice not to have to rely solely on centralised App Stores.

So, if you want to, you can also install Gnomit directly from my web site:

1. Download Gnomit version 2.0.0.

2. In Terminal, from the directory you downloaded the Gnomit flatpak to:

   flatpak install org.small_tech.Gnomit.flatpak

3. Set Gnomit as your Git editor:

   git config --global core.editor "flatpak run org.small_tech.Gnomit"

Usage

Gnomit will pop up automatically when you make a commit in one of your projects.

To save your commit message, either press the Commit button or press Ctrl+Return.

To dismiss Gnomit and cancel your commit message, press Escape.

Help

To see the help screen, in Terminal:

flatpak run org.small_tech.Gnomit --help

Known issues

Does not use your system theme

This is a Flatpak issue. Gnomit will use your system theme if it is installed via Flatpak.

Development notes

The following setting in org.small_tech.Gnomit.json allows the app to use mock data when run from Gnome Builder. If you want to test the behaviour of the app when it receives no command-line arguments from within Builder, remove this line. Also note that this path is relative to your home folder. You must update it to point to where you stored your Gnomit working directory for your Builder build to succeed.

"x-run-args" : [
    "small-tech/gnomit/gjs/tests/message-with-body"
],

Deployment

To publish to Flathub (proper credentials required):

1. Remember to update Flatpak metadata, including release notes.

2. Update the version string in the main meson.build file.

3. Tag the release in Git and push your tags.

4. Run the publish script:

   ./publish-to-flathub <tag>

   The script will create the Flathub build, run it so you can test it, and then prompt you if you want to deploy to Flathub.

   That’s it! Then wait for the changes to propagate on the Flathub web site.

Deployment Notes

The following setting is hardcoded to the source folder and is required by the deployment script. Since I’m the only one with deployment privileges at the moment, you should be able to ignore this.

"sources" : [
  {
    "type" : "git",
    "url" : "file:///home/aral/small-tech/gnomit/gjs"
  }
]

Also, note that if you change where the source is located, you will also have to delete the local-gnomit-repository flathub repository that is added as a path to your local Flatpak repository:

flatpak remote-delete local-gnomit-repository

The deployment script will recreate it with the correct path for you.

Contributors

• Aral Balkan
• Sergey Bugaev
• Sonny Piers

Like this? Fund us!

Small Technology Foundation is a tiny, independent not-for-profit.

We exist in part thanks to patronage by people like you. If you share our vision and want to support our work, please become a patron or donate to us today and help us continue to exist.

Copyright

Copyright © 2020 Aral balkan, Small Technology Foundation

License

GPLv3 or later. Please see LICENSE file.