feat: implement issues #12, #13, #14

rkristelijn · rkristelijn · commit e51b5aa041ba · 2025-09-24T06:54:16.000+02:00
- Add demo GIF back to README (#14) - Implement interactive configuration setup (#13) - Add config templates for different environments (basic, NVM, Nix, mixed, Cursor) - Prompt users to create config when none exists - Support custom configuration setup - Fix config creation bug (#12) - Config is now properly created when --init is used - Interactive prompts work correctly in TTY environments - Add comprehensive tests for new features - Update documentation with new interactive setup process - Bump version to 2.2.0
diff --git a/README.md b/README.md
@@ -6,6 +6,8 @@ A lightning-fast CLI tool to search your git repositories and open them in your
 [![npm version](https://badge.fury.io/js/@rkristelijn%2Flcode.svg)](https://www.npmjs.com/package/@rkristelijn/lcode)
 [![License: ISC](https://img.shields.io/badge/License-ISC-blue.svg)](https://opensource.org/licenses/ISC)
 
+![lcode demo](docs/demo.gif)
+
 ## `(◕‿◕)` Features
 
 - `(⌐■_■)` **Lightning Fast**: Smart caching system with 5-minute TTL
@@ -46,6 +48,31 @@ lcode --select 0
 
 ## `(╯°□°）╯` Usage Guide
 
+### First Time Setup
+
+When you run lcode for the first time, it will automatically prompt you to create a configuration file:
+
+```bash
+lcode
+# 🔧 No configuration found. Let's set one up!
+# ? Would you like to create a configuration file? (Y/n)
+```
+
+You can also manually create a configuration:
+
+```bash
+lcode --init
+```
+
+This will show an interactive setup with these options:
+
+- **Basic setup** - Simple VS Code + terminal setup
+- **Node.js with NVM** - Automatic Node version switching
+- **Nix development environment** - Nix shell integration  
+- **Mixed environments** - Auto-detect Nix/NVM projects
+- **Cursor editor** - Alternative to VS Code
+- **Custom setup** - Define your own commands
+
 ### Interactive Mode (Default)
 
 Perfect for daily development workflow:
diff --git a/index.mjs b/index.mjs
@@ -8,6 +8,7 @@ import { execSync } from 'child_process';
 import ora from 'ora';
 import { expandHomeDir, isGitRepo, validateMaxDepth, getExecuteCommand, validateConfig, getReadmePreview } from './src/utils.mjs';
 import { RepoCache } from './src/cache.mjs';
+import { createInteractiveConfig } from './src/config.mjs';
 
 // Register the autocomplete prompt
 inquirer.registerPrompt('autocomplete', inquirerAutocompletePrompt);
@@ -31,7 +32,7 @@ Arguments:
   command   Command to execute in selected repo (default: "code .")
 
 Options:
-  --init     Create configuration file
+  --init     Create configuration file (interactive)
   --cleanup  Remove configuration file
   --list     List all repositories (non-interactive)
   --select N Select repository by index (0-based)
@@ -49,23 +50,8 @@ Examples:
 
 // Check if the program is called with --init
 if (process.argv.includes('--init')) {
-  const defaultConfig = {
-    path: '~',
-    maxDepth: 5,
-    execute: 'code .',
-    execute2: 'zsh',
-    execute3: '[ -f .nvmrc ] && . ~/.nvm/nvm.sh && nvm use; code .',
-    previewLength: 80
-  };
-  try {
-    fs.writeFileSync(configPath, JSON.stringify(defaultConfig, null, 2));
-    console.log(`✓ Configuration file created at ${configPath}`);
-    console.log(JSON.stringify(defaultConfig, null, 2));
-  } catch (error) {
-    console.error(`✗ Failed to create config file: ${error.message}`);
-    process.exit(1);
-  }
-  process.exit(0);
+  const success = await createInteractiveConfig();
+  process.exit(success ? 0 : 1);
 }
 
 // Check if the program is called with --cleanup
@@ -101,6 +87,34 @@ if (fs.existsSync(configPath)) {
     console.error(`✗ Invalid configuration file: ${error.message}`);
     process.exit(1);
   }
+} else {
+  // No config exists - prompt user to create one (only in interactive mode)
+  const isNonInteractive = process.argv.includes('--list') || 
+                           process.argv.includes('--select') ||
+                           !process.stdin.isTTY;
+  
+  if (!isNonInteractive) {
+    console.log('🔧 No configuration found. Let\'s set one up!');
+    
+    const shouldCreate = await inquirer.prompt([
+      {
+        type: 'confirm',
+        name: 'create',
+        message: 'Would you like to create a configuration file?',
+        default: true
+      }
+    ]);
+    
+    if (shouldCreate.create) {
+      const success = await createInteractiveConfig();
+      if (success) {
+        // Reload the config
+        config = JSON.parse(fs.readFileSync(configPath, 'utf-8'));
+      }
+    } else {
+      console.log('Continuing with default settings...');
+    }
+  }
 }
 
 // Parse arguments properly
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -5,7 +5,7 @@
     "type": "git",
     "url": "git+https://github.com/rkristelijn/lcode.git"
   },
-  "version": "2.1.0",
+  "version": "2.2.0",
   "main": "index.mjs",
   "bin": {
     "lcode": "index.mjs"
@@ -35,6 +35,7 @@
   "license": "ISC",
   "type": "module",
   "dependencies": {
+    "@rkristelijn/lcode": "^2.1.0",
     "glob": "^11.0.0",
     "inquirer": "^9.3.7",
     "inquirer-autocomplete-prompt": "^3.0.1",
diff --git a/src/config.mjs b/src/config.mjs
@@ -0,0 +1,163 @@
+import fs from 'fs';
+import path from 'path';
+import inquirer from 'inquirer';
+
+export const CONFIG_TEMPLATES = {
+  basic: {
+    name: 'Basic setup',
+    config: {
+      path: '~',
+      maxDepth: 3,
+      execute: 'code .',
+      execute2: 'zsh',
+      execute3: 'bash'
+    }
+  },
+  nvm: {
+    name: 'Node.js with NVM',
+    config: {
+      path: '~',
+      maxDepth: 3,
+      execute: '[ -f .nvmrc ] && . ~/.nvm/nvm.sh && nvm use; code .',
+      execute2: '. ~/.nvm/nvm.sh && nvm use && npm start',
+      execute3: 'nvm use && yarn dev'
+    }
+  },
+  nix: {
+    name: 'Nix development environment',
+    config: {
+      path: '~',
+      maxDepth: 3,
+      execute: 'nix develop -c code .',
+      execute2: 'nix-shell --run "code ."',
+      execute3: 'direnv allow && code .'
+    }
+  },
+  mixed: {
+    name: 'Mixed environments (auto-detect)',
+    config: {
+      path: '~',
+      maxDepth: 3,
+      execute: 'bash -c "if [ -f flake.nix ]; then nix develop; elif [ -f .nvmrc ]; then . ~/.nvm/nvm.sh && nvm use; fi; zsh"',
+      execute2: 'code .',
+      execute3: 'zsh'
+    }
+  },
+  cursor: {
+    name: 'Cursor editor',
+    config: {
+      path: '~',
+      maxDepth: 3,
+      execute: 'cursor .',
+      execute2: 'zsh',
+      execute3: 'bash'
+    }
+  }
+};
+
+export async function createInteractiveConfig() {
+  console.log('\n🚀 Welcome to lcode configuration setup!\n');
+
+  const answers = await inquirer.prompt([
+    {
+      type: 'list',
+      name: 'template',
+      message: 'Choose a configuration template:',
+      choices: [
+        { name: CONFIG_TEMPLATES.basic.name, value: 'basic' },
+        { name: CONFIG_TEMPLATES.nvm.name, value: 'nvm' },
+        { name: CONFIG_TEMPLATES.nix.name, value: 'nix' },
+        { name: CONFIG_TEMPLATES.mixed.name, value: 'mixed' },
+        { name: CONFIG_TEMPLATES.cursor.name, value: 'cursor' },
+        { name: 'Custom setup', value: 'custom' }
+      ]
+    }
+  ]);
+
+  let config;
+
+  if (answers.template === 'custom') {
+    const customAnswers = await inquirer.prompt([
+      {
+        type: 'input',
+        name: 'path',
+        message: 'Default search path:',
+        default: '~'
+      },
+      {
+        type: 'input',
+        name: 'maxDepth',
+        message: 'Default search depth (1-10):',
+        default: '3',
+        validate: (input) => {
+          const num = parseInt(input, 10);
+          if (isNaN(num) || num < 1 || num > 10) {
+            return 'Please enter a number between 1 and 10';
+          }
+          return true;
+        }
+      },
+      {
+        type: 'input',
+        name: 'execute',
+        message: 'Primary command:',
+        default: 'code .'
+      },
+      {
+        type: 'input',
+        name: 'execute2',
+        message: 'Alternative command:',
+        default: 'zsh'
+      },
+      {
+        type: 'input',
+        name: 'execute3',
+        message: 'Third command:',
+        default: 'bash'
+      }
+    ]);
+
+    config = {
+      path: customAnswers.path,
+      maxDepth: parseInt(customAnswers.maxDepth, 10),
+      execute: customAnswers.execute,
+      execute2: customAnswers.execute2,
+      execute3: customAnswers.execute3
+    };
+  } else {
+    config = { ...CONFIG_TEMPLATES[answers.template].config };
+  }
+
+  // Show preview and confirm
+  console.log('\n📋 Configuration preview:');
+  console.log(JSON.stringify(config, null, 2));
+
+  const confirm = await inquirer.prompt([
+    {
+      type: 'confirm',
+      name: 'save',
+      message: 'Save this configuration?',
+      default: true
+    }
+  ]);
+
+  if (confirm.save) {
+    const dynamicConfigPath = path.resolve(process.env.HOME, '.lcodeconfig');
+    try {
+      fs.writeFileSync(dynamicConfigPath, JSON.stringify(config, null, 2));
+      console.log(`\n✅ Configuration saved to ${dynamicConfigPath}`);
+      return true;
+    } catch (error) {
+      console.error(`\n❌ Failed to save configuration: ${error.message}`);
+      return false;
+    }
+  } else {
+    console.log('\n❌ Configuration not saved');
+    return false;
+  }
+}
+
+export function configExists() {
+  const dynamicConfigPath = path.resolve(process.env.HOME, '.lcodeconfig');
+  return fs.existsSync(dynamicConfigPath);
+}
diff --git a/test/config.test.mjs b/test/config.test.mjs
@@ -0,0 +1,59 @@
+import { test, describe, beforeEach, afterEach } from 'node:test';
+import assert from 'node:assert';
+import fs from 'fs';
+import path from 'path';
+import { configExists } from '../src/config.mjs';
+
+const testConfigPath = path.join(process.cwd(), '.test-lcodeconfig');
+const originalHome = process.env.HOME;
+
+describe('Config Module', () => {
+  beforeEach(() => {
+    // Set test home directory
+    process.env.HOME = process.cwd();
+    
+    // Clean up any existing test config
+    if (fs.existsSync(testConfigPath)) {
+      fs.unlinkSync(testConfigPath);
+    }
+  });
+
+  afterEach(() => {
+    // Restore original HOME
+    process.env.HOME = originalHome;
+    
+    // Clean up test config
+    if (fs.existsSync(testConfigPath)) {
+      fs.unlinkSync(testConfigPath);
+    }
+  });
+
+  test('configExists returns false when no config file exists', () => {
+    assert.strictEqual(configExists(), false);
+  });
+
+  test('configExists returns true when config file exists', () => {
+    const configPath = path.resolve(process.env.HOME, '.lcodeconfig');
+    fs.writeFileSync(configPath, '{}');
+    
+    try {
+      assert.strictEqual(configExists(), true);
+    } finally {
+      fs.unlinkSync(configPath);
+    }
+  });
+
+  test('config templates are properly structured', async () => {
+    // Import the templates directly for testing
+    const { CONFIG_TEMPLATES } = await import('../src/config.mjs');
+    
+    // Check that all templates have required properties
+    Object.values(CONFIG_TEMPLATES).forEach(template => {
+      assert(template.name, 'Template should have a name');
+      assert(template.config, 'Template should have a config');
+      assert(template.config.path, 'Config should have a path');
+      assert(template.config.maxDepth, 'Config should have maxDepth');
+      assert(template.config.execute, 'Config should have execute command');
+    });
+  });
+});
diff --git a/test/integration.test.mjs b/test/integration.test.mjs
