gitwrit 0.2.7 → 0.2.9

package/README.md

@@ -4,7 +4,7 @@
 
 Made for `git`-ters and `writ`-ters.
 
-**gitwrit** watches your Markdown files and quietly commits and pushes them to your Git repository — no manual `git add`, no `git commit`, no `git push`. You write. gitwrit handles the rest.
+**gitwrit** watches your Markdown files and quietly commits and pushes them to your Git repository—no manual `git add`, no `git commit`, no `git push`. You write. gitwrit handles the rest.
 
 It is built for engineers writing internal specs, researchers building private knowledge bases, AI practitioners documenting models and experiments, and anyone who wants the safety of version control without the overhead of Git discipline. Your files stay in your own repository, on your own terms—not in someone else's cloud.
 
@@ -99,9 +99,9 @@ Run `gitwrit config` from inside a watched directory to set local overrides. Ove
 
 gitwrit supports two branch modes, configurable globally or per directory.
 
-**`current`** — Commits to whatever branch you currently have checked out. Switch branches freely; gitwrit follows you.
+**`current`**—Commits to whatever branch you currently have checked out. Switch branches freely; gitwrit follows you.
 
-**`autogenerated`** — Creates a fresh named branch at the start of each session. Branch names are generated by combining a random adjective, noun, and verb — like `crimson-walrus-stumbling` or `teal-fox-bouncing`. 64,000 possible combinations. Good for keeping autosave history separate from your main branch.
+**`autogenerated`**—Creates a fresh named branch at the start of each session. Branch names are generated by combining a random adjective, noun, and verb—like `crimson-walrus-stumbling` or `teal-fox-bouncing`. 64,000 possible combinations. Good for keeping autosave history separate from your main branch.
 
 ---
 
@@ -113,16 +113,51 @@ gitwrit checks for updates automatically after every command. If a newer version
   · Update available: 0.2.1 → 0.3.0   Run npm install -g gitwrit to update.
 ```
 
-
 The check runs in the background, caches for 24 hours, and fails silently if you are offline. It will never interrupt or slow down your workflow.
 
 ---
 
+## Compatibility
+
+| Platform | Status |
+|---|---|
+| macOS | ✅ Fully supported |
+| Linux | ✅ Fully supported |
+| Windows | ❌ Not currently supported |
+
+gitwrit is built for macOS and Linux. Windows is not currently supported—the daemon process management and file system watching rely on POSIX signals (`SIGTERM`, `SIGCONT`) that are not available on Windows.
+
+If you are a Windows user and would like to contribute Windows support, please open an issue on [GitHub](https://github.com/TBiddy/gitwrit)—it is a welcome contribution.
+
+---
+
 ## Requirements
 
 - Node.js ≥ 18
 - Git
-- A configured Git remote (`git remote add origin <url>`) — gitwrit requires one before it will initialize a directory
+- A configured Git remote (`git remote add origin <url>`)—gitwrit requires one before it will initialize a directory
+
+---
+
+## Troubleshooting
+
+**gitwrit isn't committing my changes**
+
+gitwrit watches for file save events. Make sure your editor is actually saving to disk—some terminal editors like Pico and Nano require an explicit save (`Ctrl+X` → `Y`) before changes hit the filesystem. gitwrit cannot commit changes that haven't been written to disk yet.
+
+**Push failed notification**
+
+If gitwrit notifies you that a push failed, first verify that git can push manually from your terminal:
+
+```sh
+git push
+```
+
+If that works, restart gitwrit with `gitwrit restart`. If it fails, fix your Git authentication first—gitwrit can only push if git itself can push from a non-interactive terminal session. Make sure your SSH key is configured and registered with your Git provider, or that your HTTPS credentials are cached.
+
+**Something else feels off**
+
+`gitwrit logs` is always your first stop. It shows a timestamped record of every commit, push, and error the daemon has encountered.
 
 ---
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gitwrit",
-  "version": "0.2.7",
+  "version": "0.2.9",
   "description": "Private, versioned writing for people who live in the terminal.",
   "type": "module",
   "license": "MIT",

package/src/commands/config.js

@@ -43,9 +43,11 @@ async function editField(key, currentValue) {
         { name: '5 seconds',                value: 5000  },
         { name: '10 seconds',               value: 10000 },
         { name: 'Custom',                   value: 'custom' },
+        { name: 'Exit',                     value: 'exit' },
       ],
       default: currentValue,
     });
+    if (choice === 'exit') return currentValue; // no change
     if (choice === 'custom') {
       const raw = await input({ message: 'Seconds to wait:' });
       return parseFloat(raw) * 1000;
@@ -61,9 +63,11 @@ async function editField(key, currentValue) {
         { name: 'Every 10 minutes',               value: 600000  },
         { name: 'Every 30 minutes',               value: 1800000 },
         { name: 'Custom',                         value: 'custom' },
+        { name: 'Exit',                           value: 'exit' },
       ],
       default: currentValue,
     });
+    if (choice === 'exit') return currentValue; // no change
     if (choice === 'custom') {
       const raw = await input({ message: 'Minutes between pushes:' });
       return parseFloat(raw) * 60000;
@@ -72,14 +76,17 @@ async function editField(key, currentValue) {
   }
 
   if (key === 'branchMode') {
-    return select({
+    const choice = await select({
       message: 'Default branch mode?',
       choices: [
         { name: "Current branch   — commit to whatever branch you're on", value: 'current'       },
         { name: 'Autogenerated    — create a fresh named branch each session',  value: 'autogenerated' },
+        { name: 'Exit',                                                         value: 'exit'          },
       ],
       default: currentValue,
     });
+    if (choice === 'exit') return currentValue; // no change
+    return choice;
   }
 }
 
@@ -112,10 +119,11 @@ async function configureGlobal() {
     choices: [
       ...FIELDS.map(f => ({ name: f.label, value: f.key })),
       { name: 'Done', value: null },
+      { name: 'Exit', value: 'exit' },
     ],
   });
 
-  if (!field) return;
+  if (!field || field === 'exit') return;
 
   const newValue = await editField(field, config[field]);
   config[field] = newValue;
@@ -167,10 +175,13 @@ async function configureLocal(dir) {
           { name: 'Edit an override',     value: 'edit'   },
           { name: 'Remove an override',   value: 'remove' },
           { name: 'Add another override', value: 'add'    },
+          { name: 'Exit',                 value: 'exit'   },
         ],
       })
     : 'add';
 
+  if (action === 'exit') return;
+
   if (action === 'edit' || action === 'add') {
     const overriddenKeys = Object.keys(local);
     const choices = action === 'edit'
@@ -184,9 +195,14 @@ async function configureLocal(dir) {
 
     const field = await select({
       message: 'Which setting?',
-      choices: choices.map(f => ({ name: f.label, value: f.key })),
+      choices: [
+        ...choices.map(f => ({ name: f.label, value: f.key })),
+        { name: 'Exit', value: 'exit' },
+      ],
     });
 
+    if (field === 'exit') return;
+
     const currentValue = local[field] ?? global[field];
     const newValue = await editField(field, currentValue);
     local[field] = newValue;
@@ -199,11 +215,16 @@ async function configureLocal(dir) {
     const overriddenKeys = Object.keys(local);
     const field = await select({
       message: 'Which override would you like to remove?',
-      choices: FIELDS
-        .filter(f => overriddenKeys.includes(f.key))
-        .map(f => ({ name: f.label, value: f.key })),
+      choices: [
+        ...FIELDS
+          .filter(f => overriddenKeys.includes(f.key))
+          .map(f => ({ name: f.label, value: f.key })),
+        { name: 'Exit', value: 'exit' },
+      ],
     });
 
+    if (field === 'exit') return;
+
     delete local[field];
     await saveLocalConfig(dir, local);
     print.gap();
@@ -235,9 +256,15 @@ export async function config() {
     choices: [
       { name: 'Global defaults',          value: 'global' },
       { name: `This directory  (${dir})`, value: 'local'  },
+      { name: 'Exit',                     value: 'exit'   },
     ],
   });
 
+  if (scope === 'exit') {
+    print.gap();
+    return;
+  }
+
   print.gap();
 
   if (scope === 'global') {
@@ -247,4 +274,4 @@ export async function config() {
   }
 
   print.gap();
-}
+}