gitwrit 0.2.8 → 0.3.0

package/README.md

@@ -161,13 +161,19 @@ If that works, restart gitwrit with `gitwrit restart`. If it fails, fix your Git
 
 ---
 
-## Why not Google Docs, Notion, or Obsidian Sync?
+## Why not cloud-based writing tools?
 
-Those tools store your files on their infrastructure. gitwrit does not. Your writing lives in a plain Git repository that you control, pushed wherever you want—GitHub, GitLab, a private server, anywhere that accepts a Git remote.
+Most cloud-based writing and note-taking tools store your files on their 
+infrastructure. gitwrit does not. Your writing lives in a plain Git repository 
+that you control, pushed wherever you want—GitHub, GitLab, a private server, 
+anywhere that accepts a Git remote.
 
-Just to be clear, there is absolutely nothing wrong with using any of these tools. I use them!
+Just to be clear, there is absolutely nothing wrong with using cloud-based 
+tools. Many people use them every day for good reason!
 
-But I thought making this might be especially useful for proprietary documentation like internal specs, research notes, model cards, experiment logs, etc. For when putting files into a third-party cloud is not an option, or when you want to keep everything essential to your codebase **all in one place**.
+But gitwrit might be especially useful when cloud storage isn't an option—for 
+proprietary documentation like internal specs, research notes, model cards, 
+experiment logs, etc. For when putting files into a third-party cloud is not an option, or when you want to keep everything essential to your codebase all in one place.
 
 ---
 

package/bin/gitwrit.js

@@ -14,6 +14,7 @@ import { add }     from '../src/commands/add.js';
 import { remove }  from '../src/commands/remove.js';
 import { logs }    from '../src/commands/logs.js';
 import { help }    from '../src/commands/help.js';
+import { demo }    from '../src/commands/demo.js';
 import { checkForUpdate, currentVersion } from '../src/updater.js';
 import chalk from 'chalk';
 import { TEAL, PINK } from '../src/ui.js';
@@ -74,6 +75,10 @@ program.command('help')
   .description('List all available commands')
   .action(help);
 
+program.command('demo')
+  .description('Preview gitwrit\'s UI with placeholder data')
+  .action(demo);
+
 // ── hidden daemon command ─────────────────────────────────────────────────────
 program.command('__daemon', { hidden: true })
   .action(() => import('../src/daemon.js'));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gitwrit",
-  "version": "0.2.8",
+  "version": "0.3.0",
   "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();
-}
+}

package/src/commands/demo.js

@@ -0,0 +1,81 @@
+import boxen from 'boxen';
+import chalk from 'chalk';
+import { print, TEAL, PINK } from '../ui.js';
+import { renderBanner } from '../banner.js';
+
+// ─── demo ─────────────────────────────────────────────────────────────────────
+//
+// renders gitwrit's UI with placeholder data — no real paths, no real usernames.
+// useful for screenshots, documentation, and promo material.
+//
+// shows three screens in sequence:
+//   1. gitwrit start output
+//   2. gitwrit status output
+//   3. gitwrit stop output
+
+function boxRow(label, value) {
+  return chalk.dim(`  ${label.padEnd(13)}`) + chalk.white(value);
+}
+
+const BOX_OPTS = {
+  padding:     { top: 0, bottom: 0, left: 1, right: 2 },
+  borderStyle: 'round',
+  borderColor: TEAL,
+};
+
+export function demo() {
+  // ── start ──────────────────────────────────────────────────────────────────
+
+  renderBanner();
+
+  print.good('gitwrit is running.');
+  print.gap();
+  print.row('Watching',    '~/notes, ~/projects/docs');
+  print.row('Files',       '.md, .mdx');
+  print.row('Branch',      'Current branch');
+  print.row('Committing',  '3s after last save');
+  print.row('Pushing',     'Every 5 min');
+  print.gap();
+  print.hint('Type all you want, we\'ve got you.');
+  print.gap();
+
+  // ── status ─────────────────────────────────────────────────────────────────
+
+  const statusLines = [
+    '',
+    chalk.hex(TEAL).bold('  gitwrit is running.'),
+    '',
+    boxRow('Uptime',      '42m'),
+    boxRow('Watching',    '~/notes, ~/projects/docs'),
+    boxRow('Branch',      'Current branch'),
+    boxRow('Commits',     '12 this session'),
+    boxRow('Last commit', '26s ago  (ideas.md)'),
+    boxRow('Last push',   '2m ago'),
+    '',
+  ];
+
+  console.log(boxen(statusLines.join('\n'), BOX_OPTS));
+  print.gap();
+
+  // ── stop ───────────────────────────────────────────────────────────────────
+
+  const stopLines = [
+    chalk.hex(TEAL).bold('  gitwrit stopped.'),
+    '',
+    chalk.dim('  Committed   ') + chalk.white('12 times this session'),
+    chalk.dim('  Last push   ') + chalk.white('2m ago'),
+    '',
+    chalk.dim('  Your work is safe. See you next time.'),
+  ];
+
+  console.log(
+    boxen(stopLines.join('\n'), {
+      padding: { top: 0, bottom: 0, left: 1, right: 2 },
+      borderStyle: 'round',
+      borderColor: TEAL,
+    })
+  );
+  print.gap();
+  print.hint('This is a demo. Run gitwrit start to begin a real session.');
+  print.gap();
+}

package/src/commands/help.js

@@ -17,6 +17,7 @@ const commands = [
   { name: 'remove',  desc: 'Remove a directory from your watch list'                     },
   { name: '',        desc: ''                                                             },
   { name: 'help',    desc: 'List all available commands'                                 },
+  { name: 'demo',    desc: 'Preview gitwrit\'s UI with placeholder data'                },
 ];
 
 const tips = [
@@ -25,6 +26,7 @@ const tips = [
   'gitwrit commits to whatever branch you\'re on — switch branches freely.',
   'Branch mode "autogenerated" names your session branch automatically.',
   'gitwrit requires a configured Git remote to push your work offsite.',
+  'Run gitwrit demo to preview the UI with placeholder data — great for screenshots.',
 ];
 
 export function help() {

package/src/commands/start.js

@@ -4,7 +4,7 @@ import { fileURLToPath } from 'url';
 import { dirname, join } from 'path';
 import ora from 'ora';
 
-import { print } from '../ui.js';
+import { print, displayPath } from '../ui.js';
 import { renderBanner } from '../banner.js';
 import { PID_FILE, GITWRIT_DIR } from '../paths.js';
 import { globalConfigExists, loadGlobalConfig } from '../settings.js';
@@ -103,7 +103,7 @@ export async function start() {
   spinner.succeed(wasUnclean ? 'Picked up where you left off.' : 'gitwrit is running.');
 
   print.gap();
-  print.row('Watching',    config.watch.map(w => w.path).join(', '));
+  print.row('Watching',    config.watch.map(w => displayPath(w.path)).join(', '));
   print.row('Files',       config.fileTypes.join(', '));
 
   if (sessionBranch) {

package/src/commands/status.js

@@ -1,7 +1,7 @@
 import { readFile } from 'fs/promises';
 import boxen from 'boxen';
 import chalk from 'chalk';
-import { print, timeAgo, TEAL, PINK } from '../ui.js';
+import { print, timeAgo, TEAL, PINK, displayPath } from '../ui.js';
 import { PID_FILE } from '../paths.js';
 import { readState, STATE } from '../state.js';
 import { loadGlobalConfig, globalConfigExists } from '../settings.js';
@@ -105,7 +105,7 @@ export async function status() {
 
   lines.push('');
   lines.push(row('Uptime',   formatUptime(state.startedAt)));
-  lines.push(row('Watching', config.watch.map(w => w.path).join(', ')));
+  lines.push(row('Watching', config.watch.map(w => displayPath(w.path)).join(', ')));
 
   if (state.sessionBranch) {
     lines.push(row('Branch', state.sessionBranch) + chalk.hex(PINK).dim(' (autogenerated)'));

package/src/ui.js

@@ -1,4 +1,5 @@
 import chalk from 'chalk';
+import { homedir } from 'os';
 
 // ─── palette ──────────────────────────────────────────────────────────────────
 
@@ -59,6 +60,14 @@ export function timeAgo(date) {
   return `${Math.floor(seconds / 86400)}d ago`;
 }
 
+// ─── path display ─────────────────────────────────────────────────────────────
+
+// replaces the full home directory path with ~ for cleaner, safer output.
+// e.g. /Users/terrancebiddle/Documents/notes → ~/Documents/notes
+export function displayPath(p) {
+  return p.replace(homedir(), '~');
+}
+
 // ─── ms formatting ────────────────────────────────────────────────────────────
 
 export function formatMs(ms) {