LLM Code Walkthrough.

Author: cpojer

bin/codiff-app

@@ -15,6 +15,28 @@ done
 
 script_dir="$(CDPATH= cd -P "$(dirname "$source_path")" >/dev/null 2>&1 && pwd)"
 app_path="$(CDPATH= cd -P "$script_dir/../../../.." >/dev/null 2>&1 && pwd)"
-repository_path="${1:-$PWD}"
+repository_path=""
+walkthrough=0
 
-open -n "$app_path" --args "$repository_path"
+for arg in "$@"; do
+  case "$arg" in
+    --walkthrough|-w)
+      walkthrough=1
+      ;;
+    -*)
+      ;;
+    *)
+      if [ -z "$repository_path" ]; then
+        repository_path="$arg"
+      fi
+      ;;
+  esac
+done
+
+repository_path="${repository_path:-$PWD}"
+
+if [ "$walkthrough" -eq 1 ]; then
+  open -n "$app_path" --args --walkthrough "$repository_path"
+else
+  open -n "$app_path" --args "$repository_path"
+fi

bin/codiff.js

@@ -7,7 +7,29 @@ import { fileURLToPath } from 'node:url';
 import electron from 'electron';
 
 const root = resolve(dirname(fileURLToPath(import.meta.url)), '..');
-const requestedPath = resolve(process.argv[2] ?? process.cwd());
+
+const parseArguments = (args) => {
+  let walkthrough = false;
+  let requestedPath = null;
+
+  for (const arg of args) {
+    if (arg === '--walkthrough' || arg === '-w') {
+      walkthrough = true;
+      continue;
+    }
+
+    if (!arg.startsWith('-') && requestedPath == null) {
+      requestedPath = arg;
+    }
+  }
+
+  return {
+    requestedPath: resolve(requestedPath ?? process.cwd()),
+    walkthrough,
+  };
+};
+
+const { requestedPath, walkthrough } = parseArguments(process.argv.slice(2));
 
 if (!existsSync(resolve(root, 'dist/index.html')) && !process.env.ELECTRON_RENDERER_URL) {
   console.error('Codiff has not been built yet. Run `pnpm build` first.');
@@ -18,6 +40,7 @@ const child = spawn(electron, [root], {
   env: {
     ...process.env,
     CODIFF_REPOSITORY_PATH: requestedPath,
+    CODIFF_WALKTHROUGH: walkthrough ? '1' : '',
   },
   stdio: 'inherit',
 });

electron/main.cjs

@@ -30,10 +30,12 @@ const {
   readRepositoryState,
   validateRepositoryPath,
 } = require('./git-state.cjs');
+const { readWalkthrough } = require('./walkthrough.cjs');
 
 const root = dirname(__dirname);
 const repositoryWatchers = new Map();
 const windowRepositories = new Map();
+const windowLaunchOptions = new Map();
 let preferences = {
   showWhitespace: false,
 };
@@ -43,9 +45,21 @@ const getCommandLineRepositoryPath = (commandLine = process.argv) => {
   return args.find((arg) => arg && !arg.startsWith('-'));
 };
 
+const getCommandLineLaunchOptions = (commandLine = process.argv) => {
+  const args = commandLine.slice(process.defaultApp ? 2 : 1);
+  return {
+    walkthrough:
+      process.env.CODIFF_WALKTHROUGH === '1' ||
+      args.includes('--walkthrough') ||
+      args.includes('-w'),
+  };
+};
+
 const getLaunchPath = () =>
   resolve(process.env.CODIFF_REPOSITORY_PATH || getCommandLineRepositoryPath() || process.cwd());
 
+const getLaunchOptions = () => getCommandLineLaunchOptions();
+
 const getPreferencesPath = () => join(app.getPath('userData'), 'preferences.json');
 
 const readPreferences = () => {
@@ -138,7 +152,7 @@ const openRepositoryFolder = async (browserWindow) => {
   });
 
   if (!result.canceled && result.filePaths[0]) {
-    createWindow(result.filePaths[0]);
+    createWindow(result.filePaths[0], { walkthrough: false });
   }
 };
 
@@ -279,7 +293,7 @@ const buildApplicationMenu = () =>
     },
   ]);
 
-const createWindow = (repositoryPath) => {
+const createWindow = (repositoryPath, launchOptions = { walkthrough: false }) => {
   const display = screen.getPrimaryDisplay();
   const { height, width } = display.workAreaSize;
   const window = new BrowserWindow({
@@ -303,6 +317,7 @@ const createWindow = (repositoryPath) => {
 
   const webContentsId = window.webContents.id;
   windowRepositories.set(webContentsId, repositoryPath);
+  windowLaunchOptions.set(webContentsId, launchOptions);
   startRepositoryWatcher(window, repositoryPath);
   window.once('ready-to-show', () => window.show());
   window.on('closed', () => {
@@ -312,6 +327,7 @@ const createWindow = (repositoryPath) => {
     }
     repositoryWatchers.delete(webContentsId);
     windowRepositories.delete(webContentsId);
+    windowLaunchOptions.delete(webContentsId);
   });
 
   const rendererURL = process.env.ELECTRON_RENDERER_URL;
@@ -322,7 +338,12 @@ const createWindow = (repositoryPath) => {
   }
 };
 
-const lock = !squirrelStartup && app.requestSingleInstanceLock({ repositoryPath: getLaunchPath() });
+const lock =
+  !squirrelStartup &&
+  app.requestSingleInstanceLock({
+    launchOptions: getLaunchOptions(),
+    repositoryPath: getLaunchPath(),
+  });
 
 if (squirrelStartup || !lock) {
   app.quit();
@@ -336,18 +357,19 @@ if (squirrelStartup || !lock) {
           getCommandLineRepositoryPath(commandLine) ||
           workingDirectory,
       ),
+      additionalData?.launchOptions || getCommandLineLaunchOptions(commandLine),
     );
   });
 
   app.on('ready', () => {
     preferences = readPreferences();
     Menu.setApplicationMenu(buildApplicationMenu());
-    createWindow(getLaunchPath());
+    createWindow(getLaunchPath(), getLaunchOptions());
   });
 
   app.on('activate', () => {
     if (BrowserWindow.getAllWindows().length === 0) {
-      createWindow(getLaunchPath());
+      createWindow(getLaunchPath(), getLaunchOptions());
     }
   });
 
@@ -363,6 +385,20 @@ ipcMain.handle('codiff:getRepositoryState', async (event, source) => {
   return state;
 });
 
+ipcMain.handle(
+  'codiff:getLaunchOptions',
+  (event) =>
+    windowLaunchOptions.get(event.sender.id) || {
+      walkthrough: false,
+    },
+);
+
+ipcMain.handle('codiff:getWalkthrough', async (event, source) => {
+  const repositoryPath = windowRepositories.get(event.sender.id) || getLaunchPath();
+  const state = await readRepositoryState(repositoryPath, source);
+  return readWalkthrough(state);
+});
+
 ipcMain.handle('codiff:getDiffSectionContent', async (event, request) => {
   const repositoryPath = windowRepositories.get(event.sender.id) || getLaunchPath();
   return readDiffSectionContent(repositoryPath, request);

electron/preload.cjs

@@ -3,9 +3,11 @@ const { contextBridge, ipcRenderer } = require('electron');
 contextBridge.exposeInMainWorld('codiff', {
   getDiffSectionContent: (request) => ipcRenderer.invoke('codiff:getDiffSectionContent', request),
   getGitIdentity: () => ipcRenderer.invoke('codiff:getGitIdentity'),
+  getLaunchOptions: () => ipcRenderer.invoke('codiff:getLaunchOptions'),
   getPreferences: () => ipcRenderer.invoke('codiff:getPreferences'),
   getRepositoryHistory: (limit) => ipcRenderer.invoke('codiff:getRepositoryHistory', limit),
   getRepositoryState: (source) => ipcRenderer.invoke('codiff:getRepositoryState', source),
+  getWalkthrough: (source) => ipcRenderer.invoke('codiff:getWalkthrough', source),
   onFindInDiffs: (callback) => {
     const listener = () => callback();
     ipcRenderer.on('codiff:findInDiffs', listener);