ldx 1.0.1 → 1.0.2

package/README.md

@@ -1,4 +1,5 @@
 # LDX - Logging Developer Experience
+
 A lightweight tool to enhance your development workflow by processing command output with customizable transformations.
 
 ## Features
@@ -12,6 +13,7 @@ A lightweight tool to enhance your development workflow by processing command ou
 - **Developer-Friendly**: Improves readability and reduces noise in logs.
 
 ## Installation
+
 To install LDX globally, run:
 
 ```bash
@@ -27,7 +29,7 @@ pnpm install --save-dev ldx
 ## Usage
 
 ### 1. Create a Configuration File
-  
+
 Create a `ldx.config.js` file in your project's root directory. This file defines the patterns and transformations for your command output.
 
 Example:
@@ -36,7 +38,7 @@ Example:
 module.exports = {
   // Simple string replacement
   "Test match 1": "✅ Test match 1 processed",
-  
+
   // Function-based processing
   "Function match": (line) => `Processed: ${line}`,
 };
@@ -77,13 +79,62 @@ module.exports = {
 }
 ```
 
+## Requirements
+
+- Node.js >= 18.0.0
+
 ## Error Handling
 
-- Missing configuration files
+LDX provides clear error messages for common issues:
+
+### Missing Configuration File
+
+If `ldx.config.js` is not found in your project root:
+
+```text
+Oops, no ldx.config.js file found!
+```
+
+**Solution**: Create a `ldx.config.js` file in your project root. You can copy `ldx.config.example.js` as a starting point.
+
+### Invalid Configuration
+
+If your configuration has invalid values:
+
+```text
+LDX: Configuration error - Invalid value type for key "myKey". Expected string or function, got number.
+```
+
+**Solution**: Ensure all configuration values are either strings or functions.
+
+### Empty Configuration
+
+If your configuration object is empty:
+
+```text
+LDX: Configuration error - Configuration cannot be empty.
+```
+
+**Solution**: Add at least one pattern-transformation pair to your configuration.
+
+### Command Not Found
+
+If the command you're trying to run doesn't exist:
+
+```text
+Error executing command: Failed to start command: spawn xyz ENOENT
+```
+
+**Solution**: Verify the command exists and is in your PATH.
+
+### Function Processing Errors
 
-- Invalid configuration types
+If a transformer function throws an error, LDX will:
 
-- Function processing errors
+1. Log a warning: `LDX: provided function errored: <error message>`
+2. Output the original unprocessed line (to prevent data loss)
+
+**Solution**: Add try-catch blocks in your transformer functions for graceful error handling.
 
 ## Testing
 
@@ -92,6 +143,7 @@ Run tests with:
 ```bash
 pnpm test
 ```
+
 ## Usage examples
 
 ### Basic Usage
@@ -111,22 +163,67 @@ ldx pnpm run dev
 ```bash
 ldx docker-compose up
 ```
+
 ## Development
 
 1. Clone the repository
 
 2. Install dependencies:
-    ```bash
-      pnpm i
-    ```
+
+   ```bash
+   pnpm i
+   ```
 
 3. Make changes
 
 4. Run tests:
-    ```bash
-      pnpm test
-    ```
+
+   ```bash
+   pnpm test
+   ```
+
+## Releasing
+
+This project uses [standard-version](https://github.com/conventional-changelog/standard-version) for automated versioning and changelog generation based on [Conventional Commits](https://www.conventionalcommits.org/).
+
+### Commit Message Format
+
+```text
+<type>(<scope>): <description>
+
+[optional body]
+
+[optional footer(s)]
+```
+
+Types: `feat`, `fix`, `docs`, `style`, `refactor`, `perf`, `test`, `chore`, `ci`, `build`
+
+Examples:
+
+```bash
+git commit -m "feat: add support for regex patterns"
+git commit -m "fix: handle empty lines in output"
+git commit -m "docs: update configuration examples"
+```
+
+### Creating a Release
+
+```bash
+# Automatic version bump based on commits (recommended)
+pnpm release
+
+# Specific version bumps
+pnpm release:patch  # 1.0.2 -> 1.0.3
+pnpm release:minor  # 1.0.2 -> 1.1.0
+pnpm release:major  # 1.0.2 -> 2.0.0
+```
+
+After running the release command:
+
+```bash
+git push --follow-tags origin main && npm publish
+```
 
 ## Contributing
 
-Contributions are welcome! Please open issues or pull requests in this repo.
+Contributions are welcome! Please open issues or pull requests in this repo.

package/ldx.js

@@ -13,6 +13,35 @@ try {
   process.exit(1);
 }
 
+// Validate configuration
+function validateConfig(cfg) {
+  if (!cfg || typeof cfg !== "object" || Array.isArray(cfg)) {
+    return { valid: false, error: "Configuration must be a non-null object." };
+  }
+
+  const entries = Object.entries(cfg);
+  if (entries.length === 0) {
+    return { valid: false, error: "Configuration cannot be empty." };
+  }
+
+  for (const [key, value] of entries) {
+    if (typeof value !== "string" && typeof value !== "function") {
+      return {
+        valid: false,
+        error: `Invalid value type for key "${key}". Expected string or function, got ${typeof value}.`,
+      };
+    }
+  }
+
+  return { valid: true };
+}
+
+const validation = validateConfig(config);
+if (!validation.valid) {
+  console.error(`LDX: Configuration error - ${validation.error}`);
+  process.exit(1);
+}
+
 console.log(
   "Thank you for using LDX! Collaborate or report issues at https://github.com/leog/ldx \n"
 );
@@ -28,6 +57,11 @@ function executeAndProcessCommand() {
 
     const child = spawn(command[0], command.slice(1));
 
+    // Handle spawn errors (e.g., command not found)
+    child.on("error", (error) => {
+      reject(new Error(`Failed to start command: ${error.message}`));
+    });
+
     // Handle stdout
     if (child.stdout) {
       child.stdout.on("data", (data) => {
@@ -41,6 +75,21 @@ function executeAndProcessCommand() {
       });
     }
 
+    // Handle stderr
+    if (child.stderr) {
+      child.stderr.on("data", (data) => {
+        const lines = data.toString().split("\n");
+        lines.forEach((line) => {
+          const processedLine = processOutput(line);
+          if (processedLine) {
+            console.error(processedLine); // Output processed error line to stderr
+          } else if (line.trim()) {
+            console.error(line); // Pass through unmatched non-empty lines
+          }
+        });
+      });
+    }
+
     // Handle process exit
     child.on("close", (code) => {
       if (code !== 0) {
@@ -65,13 +114,13 @@ function processOutput(line) {
       return value;
     }
 
-    // Handle array values
+    // Handle function values
     if (typeof value === "function") {
       try {
         return value(line);
       } catch (e) {
         console.warn("LDX: provided function errored: ", e.message);
-        return undefined;
+        return line; // Return original line on error to prevent data loss
       }
     }
 
@@ -89,6 +138,7 @@ function processOutput(line) {
 module.exports = {
   processOutput,
   executeAndProcessCommand,
+  validateConfig,
 };
 
 // Execute the command if this script is run directly

package/package.json

@@ -1,7 +1,10 @@
 {
   "name": "ldx",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "main": "ldx.js",
+  "engines": {
+    "node": ">=18.0.0"
+  },
   "bin": {
     "ldx": "ldx.js"
   },
@@ -32,9 +35,15 @@
   "devDependencies": {
     "@vitest/coverage-v8": "3.0.9",
     "mock-require": "^3.0.3",
+    "standard-version": "^9.5.0",
     "vitest": "^3.0.9"
   },
   "scripts": {
-    "test": "vitest --coverage"
+    "test": "vitest --coverage",
+    "release": "standard-version",
+    "release:minor": "standard-version --release-as minor",
+    "release:major": "standard-version --release-as major",
+    "release:patch": "standard-version --release-as patch",
+    "release:first": "standard-version --first-release"
   }
-}
+}