locadot 1.2.2 → 1.2.4

package/README.md

@@ -1,20 +1,76 @@
-# 🔐 locadot
-
-Secure your local development environment with **HTTPS** and **custom domains** like `https://dev.localhost`, powered by `mkcert`.
-
----
+# locadot 🔐
 
 ## ✨ Features
 
-- ✅ Automatically generates **trusted local SSL certificates**
-- 🔁 Reverse proxies `https://your.custom.domain` → `app.localhost`
-- 🖥️ Works on **Windows**, **macOS**, and **Linux**
+- ✅ Automatically generates trusted local SSL certificates
+- 🔁 Reverse proxies `https://your.custom.domain` → `localhost:your-port`
+- 🖥️ Works on Windows, macOS, and Linux
 - 🛠️ OS-specific guidance for host setup
 - ⚠️ Warns and exits if domain isn’t correctly mapped to a local IP
+- ❌ Only supports proxying to localhost ports – external IPs are not allowed for security
 
 ---
 
 ## 🚀 Usage
 
 ```bash
-npx locadot --host dev.localhost --port 3350
+npx locadot --host dev.localhost --port 3350
+```
+
+---
+
+## 📦 Commands
+
+##### ▶️ Default (Run Proxy)
+###### Starts a reverse proxy to the specified localhost port.
+
+```bash
+npx locadot --host <custom.localhost> --port <localhost-port>
+```
+
+##### 🧾 View Registered Hosts
+###### Displays all domains currently registered with locadot.
+
+
+```bash
+npx locadot host
+```
+##### 📺 Watch Logs
+###### Continuously watches and outputs proxy logs in real time.
+
+
+```bash
+npx locadot log
+```
+
+##### 🧹 Clear Logs
+###### Clears all saved logs.
+
+
+```bash
+npx locadot clear logs
+```
+
+##### 🔄 Restart Proxy
+###### Restarts the proxy server and reloads configuration.
+
+```bash
+npx locadot restart
+```
+
+##### 🛑 Stop All
+###### Stops all running locadot hosts and shuts down the proxy server.
+
+
+```bash
+npx locadot stop
+```
+---
+
+
+### 🙌 Contributing:
+
+Pull requests are welcome! Feel free to open issues for bugs or feature requests. Contributions help improve locadot for everyone, so don't hesitate to get involved.
+
+---
+##### Made with ❤️ to make secure local development simple.

package/dist/index.js

@@ -10,24 +10,8 @@ const commands_1 = __importDefault(require("./lib/commands"));
 const constants_1 = require("./utils/constants");
 async function run() {
     await (0, yargs_1.default)((0, helpers_1.hideBin)(process.argv))
+        .scriptName("locadot")
         .usage("Usage: npx locadot --host local.dev --port 3350")
-        .command("stop", "Stop all kill all locadot hosts", () => { }, async (argv) => {
-        await commands_1.default.stop();
-        console.log(constants_1.errorConstants.proxyClose);
-        process.exit(0);
-    })
-        .command("logs", "Watch logs", () => { }, async (argv) => {
-        commands_1.default.watchLogs();
-    })
-        .command("clear logs", "Clear logs", () => { }, async (argv) => {
-        commands_1.default.clearLogs();
-    })
-        .command("restart", "Restart locadot", () => { }, async (argv) => {
-        commands_1.default.restart();
-    })
-        .command("hosts", "Show all hosts.", () => {
-        commands_1.default.getRegistry();
-    })
         .command("$0", "Run the proxy with a domain and port", (yargs) => {
         return yargs
             .option("host", {
@@ -41,10 +25,26 @@ async function run() {
             describe: "Local port to forward to",
             demandOption: true,
             type: "number",
-        })
-            .usage("Usage: npx locadot --host local.dev --port 3350");
+        });
     }, async (argv) => {
         await commands_1.default.start(argv);
+    })
+        .command("host", "Show all hosts.", () => {
+        commands_1.default.getRegistry();
+    })
+        .command("log", "Watch logs", () => { }, async (argv) => {
+        commands_1.default.watchLogs();
+    })
+        .command("clear logs", "Clear logs", () => { }, async (argv) => {
+        commands_1.default.clearLogs();
+    })
+        .command("restart", "Restart locadot", () => { }, async (argv) => {
+        commands_1.default.restart();
+    })
+        .command("stop", "Stop all kill all locadot hosts", () => { }, async (argv) => {
+        await commands_1.default.stop();
+        console.log(constants_1.errorConstants.proxyClose);
+        process.exit(0);
     })
         .help().argv;
 }

package/dist/lib/locadot-file.js

@@ -51,7 +51,7 @@ class locadotFile {
     static async watchRegistry() {
         return fs_1.default.watch(constants_1.locadotPath.REGISTRY_FILE, async (eventType) => {
             if (eventType === "change") {
-                console.log("🔄 Updated domain mappings:", await locadotFile.getRegistry());
+                this.updateLogs("🔄 Updated domain mappings.");
             }
         });
     }
@@ -85,15 +85,18 @@ class locadotFile {
         let length = logs.logs?.length || 0;
         logs.logs?.forEach((log) => this.printLogs(log));
         fs_1.default.watch(constants_1.locadotPath.LOGS, async (eventType) => {
-            if (eventType === "change") {
-                const newLog = await locadotFile.getLogs();
-                newLog.logs?.forEach((log, i) => {
-                    if (i > length - 2) {
-                        this.printLogs(log);
-                    }
-                });
-                length = newLog.logs?.length || 0;
+            try {
+                if (eventType === "change") {
+                    const newLog = await locadotFile.getLogs();
+                    newLog.logs?.forEach((log, i) => {
+                        if (i > length - 1) {
+                            this.printLogs(log);
+                        }
+                    });
+                    length = newLog.logs?.length || 0;
+                }
             }
+            catch (error) { }
         });
     }
     static async destroy(watcher) {

package/dist/server.js

@@ -30,7 +30,6 @@ class ProxyHandler {
                 locadot_file_1.default.updateLogs(host || "", "warn", "Proxy not exist.");
             }
             proxy.web(req, res, { target: `http://localhost:${targetPort}` }, (err) => {
-                console.error("Proxy error:", err);
                 locadot_file_1.default.updateLogs(host || "", "warn", "Host not found.");
                 res.writeHead(502);
                 res.end("Connection failed. Host not found.");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "locadot",
-  "version": "1.2.2",
+  "version": "1.2.4",
   "description": "Secure your local development environment with HTTPS and custom domains like dev.localhost.",
   "homepage": "https://www.npmjs.com/package/locadot",
   "main": "dist/index.js",