Error Handling, Documentation and More (#30)

Author: SatanshuMishra

.changeset/fix-init-template-emoji-placeholder.md

@@ -0,0 +1,11 @@
+---
+"@labcatr/labcommitr": patch
+---
+
+fix: include emoji placeholder in generated config template
+
+- Add {emoji} placeholder to template in buildConfig function
+- Generated configs now include {emoji} in format.template field
+- Fixes issue where emojis didn't appear in commits even when enabled
+- Template now matches default config structure with emoji support
+- Ensures formatCommitMessage can properly replace emoji placeholder

.changeset/fix-preview-emoji-display.md

@@ -0,0 +1,11 @@
+---
+"@labcatr/labcommitr": patch
+---
+
+fix: show actual commit message with emojis in preview
+
+- Preview now displays the exact commit message as it will be stored in Git
+- Removed emoji stripping from preview display logic
+- Users can see emojis even if terminal doesn't support emoji display
+- Ensures preview accurately reflects what will be committed to Git/GitHub
+- Fixes issue where emojis were hidden in preview on non-emoji terminals

.changeset/implement-emoji-detection-and-display.md

@@ -0,0 +1,12 @@
+---
+"@labcatr/labcommitr": minor
+---
+
+feat: implement terminal emoji detection and display adaptation
+
+- Add emoji detection utility with industry-standard heuristics (CI, TERM, NO_COLOR, Windows Terminal)
+- Implement automatic emoji stripping for non-emoji terminals in Labcommitr UI
+- Always store Unicode emojis in Git commits regardless of terminal support
+- Update commit, preview, and revert commands to adapt display based on terminal capabilities
+- Ensure GitHub and emoji-capable terminals always show emojis correctly
+- Improve user experience by cleaning up broken emoji symbols on non-emoji terminals

.npmignore

@@ -24,6 +24,8 @@ docs/
 
 # Exclude build artifacts
 *.map
+**/*.map
+dist/**/*.map
 tsconfig.json
 .prettierrc*
 

CHANGELOG.md

@@ -1,6 +1,6 @@
 # @labcatr/labcommitr
 
-## 0.2.0
+## 0.3.0
 
 ### Minor Changes
 

README.md

@@ -316,8 +316,8 @@ See [`docs/CONFIG_SCHEMA.md`](docs/CONFIG_SCHEMA.md) for complete configuration
 **Configuration discovery:**
 
 - Searches from current directory up to project root
-- Falls back to global configuration if available
 - Uses sensible defaults if no configuration found
+- Global configuration support is planned for future releases (see [Planned Features](#planned-features))
 
 ---
 
@@ -404,10 +404,6 @@ Before implementing any changes, please follow this process:
    - Follow the project's development guidelines
    - Ensure your commits follow the project's commit message format (you can set up using `lab init`)
 
-### Development Guidelines
-
-For detailed development guidelines, coding standards, and architecture information, see [`docs/DEVELOPMENT_GUIDELINES.md`](docs/DEVELOPMENT_GUIDELINES.md).
-
 ### Questions?
 
 If you have questions or need clarification, feel free to open a discussion or issue.
@@ -416,4 +412,27 @@ If you have questions or need clarification, feel free to open a discussion or i
 
 ## Planned Features
 
-_No planned features at this time. Check back later or open an issue to suggest new features!_
+### Global Configuration
+
+Support for user-level global configuration files to enable consistent commit conventions across multiple projects. This will allow you to:
+
+- Set default commit types and preferences in a single location
+- Apply your preferred commit conventions to all projects automatically
+- Override global settings on a per-project basis when needed
+
+**Use cases:**
+
+- Developers working across multiple repositories who want consistent commit message formats
+- Teams that want to standardize commit conventions organization-wide
+- Personal projects where you want the same commit types everywhere
+
+The global configuration will be stored in OS-specific locations:
+
+- **macOS/Linux**: `~/.labcommitr.config.yaml` or XDG config directory
+- **Windows**: `%USERPROFILE%\.labcommitr.config.yaml` or AppData directory
+
+Project-specific configurations will always take precedence over global settings.
+
+---
+
+_Have a feature idea? Open an issue to suggest new features!_

package.json

@@ -1,16 +1,19 @@
 {
   "name": "@labcatr/labcommitr",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Labcommitr is a solution for building standardized git commits, hassle-free!",
   "main": "dist/index.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
     "build": "npx tsc",
+    "build:prod": "npx tsc && pnpm run clean:maps",
+    "clean:maps": "node scripts/clean-maps.js",
     "format": "pnpm run format:code",
     "format:ci": "pnpm run format:code",
     "format:code": "prettier -w \"**/*\" --ignore-unknown --cache",
     "version": "changeset version && pnpm install --no-frozen-lockfile && pnpm run format",
-    "dev:cli": "node dist/index-dev.js"
+    "dev:cli": "node dist/index-dev.js",
+    "prepublishOnly": "pnpm run build:prod"
   },
   "type": "module",
   "bin": {
@@ -29,6 +32,9 @@
   "homepage": "https://github.com/labcatr/labcommitr#readme",
   "author": "Trevor Fox",
   "license": "ISC",
+  "engines": {
+    "node": ">=18.0.0"
+  },
   "dependencies": {
     "@changesets/cli": "^2.29.7",
     "@clack/prompts": "^0.11.0",
@@ -56,7 +62,10 @@
     "dist/cli/commands/revert",
     "dist/cli/commands/shared",
     "dist/cli/utils",
-    "dist/lib"
+    "dist/lib",
+    "README.md",
+    "CHANGELOG.md",
+    "TESTING.md"
   ],
   "publishConfig": {
     "access": "public"

scripts/clean-maps.js

@@ -0,0 +1,36 @@
+#!/usr/bin/env node
+
+/**
+ * Remove all .map files from dist directory
+ * Cross-platform solution for cleaning source maps before publishing
+ */
+
+import { readdir, stat, unlink } from "fs/promises";
+import { join } from "path";
+
+async function removeMaps(dir) {
+  try {
+    const entries = await readdir(dir, { withFileTypes: true });
+
+    for (const entry of entries) {
+      const fullPath = join(dir, entry.name);
+
+      if (entry.isDirectory()) {
+        await removeMaps(fullPath);
+      } else if (entry.isFile() && entry.name.endsWith(".map")) {
+        await unlink(fullPath);
+        console.log(`Removed: ${fullPath}`);
+      }
+    }
+  } catch (error) {
+    if (error.code !== "ENOENT") {
+      throw error;
+    }
+  }
+}
+
+const distDir = join(process.cwd(), "dist");
+removeMaps(distDir).catch((error) => {
+  console.error("Error removing source maps:", error);
+  process.exit(1);
+});

src/cli/commands/commit/editor.ts

@@ -11,32 +11,75 @@ import {
   unlinkSync,
   mkdtempSync,
   rmdirSync,
+  accessSync,
+  constants,
 } from "fs";
 import { join, dirname } from "path";
-import { tmpdir } from "os";
+import { tmpdir, platform } from "os";
 import { Logger } from "../../../lib/logger.js";
 
+/**
+ * Cross-platform command resolver
+ * On Windows: uses 'where' command
+ * On Unix: uses 'which' command
+ *
+ * @param command - Command name to find
+ * @returns Full path to command or null if not found
+ */
+function findCommand(command: string): string | null {
+  const isWindows = platform() === "win32";
+  const findCommand = isWindows ? "where" : "which";
+
+  try {
+    const result = spawnSync(findCommand, [command], {
+      encoding: "utf-8",
+      stdio: ["ignore", "pipe", "ignore"],
+    });
+
+    if (result.status === 0 && result.stdout) {
+      // On Windows, 'where' may return multiple paths, take the first one
+      const path = result.stdout.trim().split("\n")[0].trim();
+      return path || null;
+    }
+  } catch {
+    // Command not found or error occurred
+  }
+
+  return null;
+}
+
 /**
  * Detect available editor in priority order: nvim → vim → vi
  * Also checks $EDITOR and $VISUAL environment variables
+ * Cross-platform: works on Windows, macOS, and Linux
  */
 export function detectEditor(): string | null {
   // Check environment variables first (user preference)
   const envEditor = process.env.EDITOR || process.env.VISUAL;
   if (envEditor) {
-    // Verify the editor exists
-    const check = spawnSync("which", [envEditor], { encoding: "utf-8" });
-    if (check.status === 0) {
-      return envEditor.trim();
+    // If it's already a full path, verify it exists
+    if (envEditor.includes("/") || envEditor.includes("\\")) {
+      try {
+        accessSync(envEditor, constants.F_OK);
+        return envEditor.trim();
+      } catch {
+        // Path doesn't exist, try to find it as a command
+      }
+    }
+
+    // Try to find it as a command in PATH
+    const found = findCommand(envEditor);
+    if (found) {
+      return found;
     }
   }
 
   // Try nvim, vim, vi in order
   const editors = ["nvim", "vim", "vi"];
   for (const editor of editors) {
-    const check = spawnSync("which", [editor], { encoding: "utf-8" });
-    if (check.status === 0) {
-      return editor;
+    const found = findCommand(editor);
+    if (found) {
+      return found;
     }
   }
 
@@ -58,9 +101,11 @@ export function editInEditor(
 
   if (!editorCommand) {
     Logger.error("No editor found");
+    const isWindows = platform() === "win32";
+    const envVar = isWindows ? "%EDITOR%" : "$EDITOR";
     console.error("\n  No editor available (nvim, vim, or vi)");
     console.error(
-      "  Set $EDITOR environment variable to your preferred editor\n",
+      `  Set ${envVar} environment variable to your preferred editor\n`,
     );
     return null;
   }

src/cli/commands/commit/index.ts

@@ -14,6 +14,7 @@
 import { loadConfig, ConfigError } from "../../../lib/config/index.js";
 import type { LabcommitrConfig } from "../../../lib/config/types.js";
 import { Logger } from "../../../lib/logger.js";
+import { formatForDisplay } from "../../../lib/util/emoji.js";
 import { isGitRepository } from "./git.js";
 import {
   stageAllTrackedFiles,
@@ -193,6 +194,7 @@ export async function commitAction(options: {
     }
 
     const config = configResult.config;
+    const emojiModeActive = configResult.emojiModeActive;
 
     // Step 2: Verify git repository
     if (!isGitRepository()) {
@@ -353,7 +355,11 @@ export async function commitAction(options: {
         );
 
         console.log(`${success("✓")} Commit created successfully!`);
-        console.log(`  ${commitHash} ${formattedMessage}`);
+        const displayMessage = formatForDisplay(
+          formattedMessage,
+          emojiModeActive,
+        );
+        console.log(`  ${commitHash} ${displayMessage}`);
       } catch (error: unknown) {
         // Cleanup on failure
         await cleanup({
@@ -441,7 +447,12 @@ export async function commitAction(options: {
         );
 
         // Show preview and get user action
-        action = await displayPreview(formattedMessage, body, config);
+        action = await displayPreview(
+          formattedMessage,
+          body,
+          config,
+          emojiModeActive,
+        );
 
         // Handle edit actions
         if (action === "edit-type") {
@@ -508,7 +519,11 @@ export async function commitAction(options: {
         );
 
         console.log(`${success("✓")} Commit created successfully!`);
-        console.log(`  ${commitHash} ${formattedMessage}`);
+        const displayMessage = formatForDisplay(
+          formattedMessage,
+          emojiModeActive,
+        );
+        console.log(`  ${commitHash} ${displayMessage}`);
       } catch (error: unknown) {
         // Cleanup on failure
         await cleanup({