Automatically wrap the body

Fixes #52

.eslintignore

@@ -3,3 +3,4 @@ install/
 flatpak/
 node_modules/
 repo/
+src/wordwrap.js

.prettierignore

@@ -3,3 +3,4 @@ install/
 flatpak/
 node_modules/
 repo/
+src/wordwrap.js

TODO.md

@@ -15,3 +15,7 @@
 14. [ ] detect non imperative mood
 
 https://tekin.co.uk/2020/03/git-commit-verbose-mode
+https://robertcooper.me/post/git-commit-messages
+https://www.freecodecamp.org/news/how-to-write-better-git-commit-messages/
+https://wiki.gnome.org/Git/CommitMessages
+https://cbea.ms/git-commit/

data/re.sonny.Commit.gschema.xml

@@ -3,9 +3,16 @@
   <schema id="re.sonny.Commit" path="/re/sonny/Commit/">
     <key name='title-length-hint' type='i'>
       <default>50</default>
-      <range min="1" />
+      <range min="50" max="200" />
       <summary>Message title length hint</summary>
     </key>
+
+    <key name='body-length-wrap' type='i'>
+      <default>75</default>
+      <range min="72" max="200" />
+      <summary>Message body length wrap</summary>
+    </key>
+
     <key name='dark-mode' type='b'>
       <default>false</default>
       <summary>Use dark mode</summary>

data/re.sonny.Commit.metainfo.xml

@@ -97,8 +97,9 @@
           <li>Add keyboard shortcuts for moving lines up and down</li>
           <li>Highlight syntax for Git, Mercurial and diffs</li>
           <li>Add a shortcuts window</li>
-          <li>Support for multiple comments</li>
+          <li>Support multiple comments</li>
           <li>Auto capitalize the commit title</li>
+          <li>Add a setting to automatically wrap commit message body</li>
           <li>Various fixes</li>
         </ul>
       </description>

re.sonny.Commit.json

@@ -87,7 +87,7 @@
       "sources": [
         {
           "type": "dir",
-          "path": "./"
+          "path": "."
         }
       ]
     }

src/Editor.js → src/CommitEditor.js

@@ -6,7 +6,7 @@ import Adw from "gi://Adw";
 
 import { relativePath } from "./util.js";
 
-const file = Gio.File.new_for_path(relativePath("./Editor.ui"));
+const file = Gio.File.new_for_path(relativePath("./CommitEditor.ui"));
 const [, template] = file.load_contents(null);
 
 const scheme_manager = GtkSource.StyleSchemeManager.get_default();
@@ -19,7 +19,7 @@ language_manager.set_search_path([
 
 export default GObject.registerClass(
   {
-    GTypeName: "Editor",
+    GTypeName: "CommitEditor",
     Properties: {
       language: GObject.ParamSpec.string(
         "language",
@@ -35,7 +35,7 @@ export default GObject.registerClass(
       "style-updated": {},
     },
   },
-  class Editor extends Gtk.ScrolledWindow {
+  class CommitEditor extends Gtk.ScrolledWindow {
     _init(params = {}) {
       super._init(params);
 

src/CommitEditor.ui

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<interface>
+  <template class="CommitEditor" parent="GtkScrolledWindow">
+    <property name="vexpand">true</property>
+    <child>
+      <object class="GtkSourceView" id="view">
+        <property name="buffer">
+          <object class="GtkSourceBuffer" id="buffer" />
+        </property>
+        <property name="monospace">true</property>
+        <!-- <property name="show-right-margin">true</property> -->
+        <property name="wrap_mode">word-char</property>
+        <property name="top-margin">6</property>
+        <property name="left-margin">6</property>
+        <property name="right-margin">6</property>
+        <property name="bottom-margin">6</property>
+        <property name="input_hints">
+          GTK_INPUT_HINT_SPELLCHECK | GTK_INPUT_HINT_WORD_COMPLETION |
+          GTK_INPUT_HINT_EMOJI | GTK_INPUT_HINT_UPPERCASE_SENTENCES
+        </property>
+      </object>
+    </child>
+  </template>
+</interface>

src/application.js

@@ -111,7 +111,7 @@ function openEditor({ file, application, readonly }) {
   try {
     [, commitMessage] = GLib.file_get_contents(filePath);
   } catch (err) {
-    printerr(err);
+    logError(err);
     application.quit();
     return;
   }

src/editor.js

@@ -2,30 +2,20 @@ import Gtk from "gi://Gtk";
 import GLib from "gi://GLib";
 import GtkSource from "gi://GtkSource";
 
-import Editor from "./Editor.js";
+import CommitEditor from "./CommitEditor.js";
 
 import { settings } from "./util.js";
-import { parse, hasCommitMessage } from "./scm.js";
+import { hasCommitMessage } from "./scm.js";
 
 const HIGHLIGHT_BACKGROUND_TAG_NAME = "highlightBackground";
 
 export default function editor({
   builder,
   commitButton,
   type,
-  commitMessage,
   window,
+  parsed,
 }) {
-  let parsed = {};
-
-  try {
-    parsed = parse(commitMessage, type);
-  } catch (err) {
-    if (__DEV__) {
-      logError(err);
-    }
-  }
-
   const {
     body,
     comment,
@@ -51,7 +41,7 @@ export default function editor({
   let previousNumberOfLinesInCommitMessage = 1;
 
   const main = builder.get_object("main");
-  const widget = new Editor({ language });
+  const widget = new CommitEditor({ language });
   main.append(widget);
   const source_view = widget.view;
 

src/scm.js

@@ -78,6 +78,13 @@ export function parse(commit, type) {
     read_only_index,
     language,
     capitalize,
+    wrap: [
+      "hg",
+      "commit",
+      "git-merge-squash",
+      "git-rebase-squash",
+      "merge",
+    ].includes(type),
   };
 }
 

src/welcome.js

@@ -12,15 +12,26 @@ export default function Welcome({ application }) {
 
   loadStyleSheet(relativePath("./style.css"));
 
-  const spinButton = builder.get_object("spinButton");
-  spinButton.set_range(50, 200);
-  spinButton.set_increments(1, 10);
+  const button_hint = builder.get_object("button_hint");
+  button_hint.set_range(50, 200);
+  button_hint.set_increments(1, 10);
   settings.bind(
     "title-length-hint",
-    spinButton,
+    button_hint,
     "value",
     Gio.SettingsBindFlags.DEFAULT,
   );
+
+  const button_wrap = builder.get_object("button_wrap");
+  button_wrap.set_range(72, 200);
+  button_wrap.set_increments(1, 10);
+  settings.bind(
+    "body-length-wrap",
+    button_wrap,
+    "value",
+    Gio.SettingsBindFlags.DEFAULT,
+  );
+
   const darkSwitch = builder.get_object("darkSwitch");
   Adw.StyleManager.get_default().bind_property(
     "dark",

src/welcome.ui

@@ -30,11 +30,28 @@
                         <property
                           name="title"
                           translatable="yes"
-                        >Message title length hint</property>
+                        >Commit title max length</property>
                         <child>
-                          <object class="GtkSpinButton" id="spinButton">
-                            <property name="value">50</property>
-                            <property name='numeric'>True</property>
+                          <object class="GtkSpinButton" id="button_hint">
+                            <property name='numeric'>true</property>
+                            <property name='valign'>center</property>
+                          </object>
+                        </child>
+                      </object>
+                    </child>
+                  </object>
+                </child>
+                <child>
+                  <object class="AdwPreferencesRow">
+                    <child>
+                      <object class="AdwActionRow">
+                        <property
+                          name="title"
+                          translatable="yes"
+                        >Message body max length</property>
+                        <child>
+                          <object class="GtkSpinButton" id="button_wrap">
+                            <property name='numeric'>true</property>
                             <property name='valign'>center</property>
                           </object>
                         </child>

src/window.js

@@ -5,6 +5,8 @@ import Gio from "gi://Gio";
 import Editor from "./editor.js";
 
 import { relativePath } from "./util.js";
+import { parse } from "./scm.js";
+import wordwrap from "./wordwrap.js";
 
 export default function Window({
   application,
@@ -13,20 +15,36 @@ export default function Window({
   type,
   readonly,
 }) {
-  const builder = Gtk.Builder.new_from_file(relativePath("./window.ui"));
+  let parsed = {};
+  try {
+    parsed = parse(commitMessage, type);
+  } catch (err) {
+    if (__DEV__) {
+      logError(err);
+    }
+  }
 
+  const builder = Gtk.Builder.new_from_file(relativePath("./window.ui"));
   const window = builder.get_object("window");
   const cancelButton = builder.get_object("cancelButton");
   const commitButton = builder.get_object("commitButton");
 
+  const { buffer, source_view } = Editor({
+    builder,
+    commitButton,
+    type,
+    window,
+    parsed,
+  });
+
   window.set_application(application);
 
   const cancelAction = new Gio.SimpleAction({
     name: "cancel",
     parameter_type: null,
   });
   cancelAction.connect("activate", () => {
-    save({ file, application, value: "", readonly });
+    save({ file, window, value: "", readonly });
   });
   window.add_action(cancelAction);
 
@@ -35,33 +53,31 @@ export default function Window({
     parameter_type: null,
   });
   commitAction.connect("activate", () => {
-    const value = buffer.text;
-    save({ file, application, value, readonly });
+    const { text } = buffer;
+    const value = parsed.wrap ? wordwrap(0, 75, { mode: "hard" })(text) : text;
+    save({
+      file,
+      window,
+      value,
+      readonly,
+    });
   });
   window.add_action(commitAction);
 
-  const { buffer, source_view } = Editor({
-    builder,
-    commitButton,
-    type,
-    commitMessage,
-    window,
-  });
-
   // https://github.com/sonnyp/Commit/issues/33
   window.set_focus(source_view);
 
   return { window, cancelButton, commitButton, buffer };
 }
 
-function save({ file, value, application, readonly }) {
+function save({ file, value, window, readonly }) {
   if (!readonly) {
     try {
       GLib.file_set_contents(file.get_path(), value);
     } catch (err) {
-      printerr(err);
+      logError(err);
     }
   }
 
-  application.quit();
+  window.close();
 }