ldx 1.0.0 → 1.0.1

package/README.md

@@ -1,3 +1,132 @@
-# ldx - logging developer experience
-transform command outputs to custom logs
+# LDX - Logging Developer Experience
+A lightweight tool to enhance your development workflow by processing command output with customizable transformations.
 
+## Features
+
+- **Custom static transformations**: Define string patterns in your command output and replace them with custom messages.
+
+- **Custom dynamic transformations**: Supports function-based transformations
+
+- **Easy Integration**: Works seamlessly with any command-line tool or script.
+
+- **Developer-Friendly**: Improves readability and reduces noise in logs.
+
+## Installation
+To install LDX globally, run:
+
+```bash
+pnpm install -g ldx
+```
+
+Alternatively, you can install it locally in your project:
+
+```bash
+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:
+
+```js
+module.exports = {
+  // Simple string replacement
+  "Test match 1": "✅ Test match 1 processed",
+  
+  // Function-based processing
+  "Function match": (line) => `Processed: ${line}`,
+};
+```
+
+### 2. Run Commands with LDX
+
+Use LDX to run your commands and transform their output:
+
+```bash
+ldx <your-command>
+```
+
+For example:
+
+```bash
+ldx pnpm run dev
+```
+
+## Configuration Options
+
+### String Matching
+
+```js
+module.exports = {
+  "String contained in output line": "Replacement text for the entire line"
+}
+```
+
+### Function Processing
+
+```js
+module.exports = {
+  "String contained in output line": (line) => {
+    // Custom processing logic
+    return `Formatted: ${line}`;
+  }
+}
+```
+
+## Error Handling
+
+- Missing configuration files
+
+- Invalid configuration types
+
+- Function processing errors
+
+## Testing
+
+Run tests with:
+
+```bash
+pnpm test
+```
+## Usage examples
+
+### Basic Usage
+
+```bash
+ldx echo "Testing LDX tool"
+```
+
+### With package manager scripts
+
+```bash
+ldx pnpm run dev
+```
+
+### With complex commands
+
+```bash
+ldx docker-compose up
+```
+## Development
+
+1. Clone the repository
+
+2. Install dependencies:
+    ```bash
+      pnpm i
+    ```
+
+3. Make changes
+
+4. Run tests:
+    ```bash
+      pnpm test
+    ```
+
+## Contributing
+
+Contributions are welcome! Please open issues or pull requests in this repo.

package/ldx.js

@@ -0,0 +1,102 @@
+#!/usr/bin/env node
+
+const { resolve } = require("node:path");
+const { spawn } = require("child_process");
+
+// Load configuration
+const project = resolve(process.cwd(), "ldx.config.js");
+let config;
+try {
+  config = require(project);
+} catch (e) {
+  console.error("Oops, no ldx.config.js file found!");
+  process.exit(1);
+}
+
+console.log(
+  "Thank you for using LDX! Collaborate or report issues at https://github.com/leog/ldx \n"
+);
+
+// Function to execute the command and process output
+function executeAndProcessCommand() {
+  return new Promise((resolve, reject) => {
+    const command = process.argv.slice(2);
+    if (command.length === 0) {
+      reject(new Error("No command provided."));
+      return;
+    }
+
+    const child = spawn(command[0], command.slice(1));
+
+    // Handle stdout
+    if (child.stdout) {
+      child.stdout.on("data", (data) => {
+        const lines = data.toString().split("\n");
+        lines.forEach((line) => {
+          const processedLine = processOutput(line);
+          if (processedLine) {
+            console.log(processedLine); // Output the processed line
+          }
+        });
+      });
+    }
+
+    // Handle process exit
+    child.on("close", (code) => {
+      if (code !== 0) {
+        reject(new Error(`Command failed with exit code ${code}`));
+      } else {
+        resolve();
+      }
+    });
+  });
+}
+
+// Function to process each line of output
+function processOutput(line) {
+  // Check static matches first (O(n) lookup, but optimized for small n)
+  const match = Object.entries(config).find(([key]) => line.includes(key));
+
+  if (match) {
+    const [key, value] = match;
+
+    // Handle string values
+    if (typeof value === "string") {
+      return value;
+    }
+
+    // Handle array values
+    if (typeof value === "function") {
+      try {
+        return value(line);
+      } catch (e) {
+        console.warn("LDX: provided function errored: ", e.message);
+        return undefined;
+      }
+    }
+
+    // Handle invalid configurations
+    console.warn(
+      `Invalid configuration for key: ${key}. Expected string or function.`
+    );
+  }
+
+  // No match found
+  return undefined;
+}
+
+// Export functions for testing
+module.exports = {
+  processOutput,
+  executeAndProcessCommand,
+};
+
+// Execute the command if this script is run directly
+/* v8 ignore start */
+if (require.main === module) {
+  // Main execution
+  executeAndProcessCommand()
+    .then(() => console.log("Command executed successfully."))
+    .catch((error) => console.error("Error executing command:", error));
+}
+/* v8 ignore end */

package/package.json

@@ -1,12 +1,40 @@
 {
   "name": "ldx",
-  "version": "1.0.0",
-  "main": "index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+  "version": "1.0.1",
+  "main": "ldx.js",
+  "bin": {
+    "ldx": "ldx.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/leog/ldx.git"
+  },
+  "keywords": [
+    "transform",
+    "output",
+    "logging",
+    "developer",
+    "experience",
+    "dx"
+  ],
+  "files": [
+    "package.json",
+    "ldx.js",
+    "README.md"
+  ],
+  "author": {
+    "name": "Leo Giovanetti",
+    "email": "hello@leog.me",
+    "url": "https://x.com/leog"
   },
-  "keywords": [],
-  "author": "",
-  "license": "ISC",
-  "description": ""
-}
+  "license": "Apache-2.0",
+  "description": "Enhancing logging developer experience",
+  "devDependencies": {
+    "@vitest/coverage-v8": "3.0.9",
+    "mock-require": "^3.0.3",
+    "vitest": "^3.0.9"
+  },
+  "scripts": {
+    "test": "vitest --coverage"
+  }
+}