doc-detective-common 3.6.1 → 4.0.0-beta.0

package/dist/files.js

@@ -0,0 +1,123 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.readFile = readFile;
+const fs = __importStar(require("fs"));
+const YAML = __importStar(require("yaml"));
+const axios_1 = __importDefault(require("axios"));
+const url_1 = require("url");
+/**
+ * Reads and parses content from a remote URL or local file path, supporting JSON and YAML formats.
+ *
+ * Attempts to parse the file content as JSON first, then YAML. If both parsing attempts fail, returns the raw content as a string. Returns `null` if the file cannot be read.
+ *
+ * @param options - Options object
+ * @param options.fileURLOrPath - The URL or local file path to read.
+ * @returns Parsed object for JSON or YAML files, raw string for other formats, or `null` if reading fails.
+ *
+ * @throws {Error} If {@link fileURLOrPath} is missing, not a string, or is an empty string.
+ */
+async function readFile({ fileURLOrPath }) {
+    if (!fileURLOrPath) {
+        throw new Error("fileURLOrPath is required");
+    }
+    if (typeof fileURLOrPath !== "string") {
+        throw new Error("fileURLOrPath must be a string");
+    }
+    if (fileURLOrPath.trim() === "") {
+        throw new Error("fileURLOrPath cannot be an empty string");
+    }
+    let content;
+    let isRemote = false;
+    try {
+        const parsedURL = new url_1.URL(fileURLOrPath);
+        isRemote =
+            parsedURL.protocol === "http:" || parsedURL.protocol === "https:";
+    }
+    catch (error) {
+        // Not a valid URL, assume local file path
+    }
+    if (isRemote) {
+        try {
+            const response = await axios_1.default.get(fileURLOrPath);
+            content = response.data;
+        }
+        catch (error) {
+            console.warn(`Error reading remote file from ${fileURLOrPath}: ${error.message}`);
+            return null;
+        }
+    }
+    else {
+        try {
+            content = await fs.promises.readFile(fileURLOrPath, "utf8");
+        }
+        catch (error) {
+            if (error.code === "ENOENT") {
+                console.warn(`File not found: ${fileURLOrPath}`);
+            }
+            else {
+                console.warn(`Error reading file: ${error.message}`);
+            }
+            return null;
+        }
+    }
+    // Parse based on file extension
+    const ext = fileURLOrPath.split('.').pop()?.toLowerCase();
+    if (ext === "json") {
+        try {
+            return JSON.parse(content);
+        }
+        catch (error) {
+            console.warn(`Failed to parse JSON: ${error.message}`);
+            return content;
+        }
+    }
+    else if (ext === "yaml" || ext === "yml") {
+        try {
+            return YAML.parse(content);
+        }
+        catch (error) {
+            console.warn(`Failed to parse YAML: ${error.message}`);
+            return content;
+        }
+    }
+    else {
+        return content;
+    }
+}
+//# sourceMappingURL=files.js.map

package/dist/files.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"files.js","sourceRoot":"","sources":["../src/files.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoBA,4BAiEC;AArFD,uCAAyB;AACzB,2CAA6B;AAC7B,kDAA0B;AAC1B,6BAA0B;AAM1B;;;;;;;;;;GAUG;AACI,KAAK,UAAU,QAAQ,CAAC,EAAE,aAAa,EAAmB;IAC/D,IAAI,CAAC,aAAa,EAAE,CAAC;QACnB,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;IAC/C,CAAC;IACD,IAAI,OAAO,aAAa,KAAK,QAAQ,EAAE,CAAC;QACtC,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;IACpD,CAAC;IACD,IAAI,aAAa,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;QAChC,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;IAC7D,CAAC;IAED,IAAI,OAAe,CAAC;IACpB,IAAI,QAAQ,GAAG,KAAK,CAAC;IAErB,IAAI,CAAC;QACH,MAAM,SAAS,GAAG,IAAI,SAAG,CAAC,aAAa,CAAC,CAAC;QACzC,QAAQ;YACN,SAAS,CAAC,QAAQ,KAAK,OAAO,IAAI,SAAS,CAAC,QAAQ,KAAK,QAAQ,CAAC;IACtE,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,0CAA0C;IAC5C,CAAC;IAED,IAAI,QAAQ,EAAE,CAAC;QACb,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,eAAK,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;YAChD,OAAO,GAAG,QAAQ,CAAC,IAAI,CAAC;QAC1B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,IAAI,CACV,kCAAkC,aAAa,KAAM,KAAe,CAAC,OAAO,EAAE,CAC/E,CAAC;YACF,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;SAAM,CAAC;QACN,IAAI,CAAC;YACH,OAAO,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC;QAC9D,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAK,KAA+B,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;gBACvD,OAAO,CAAC,IAAI,CAAC,mBAAmB,aAAa,EAAE,CAAC,CAAC;YACnD,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,IAAI,CAAC,uBAAwB,KAAe,CAAC,OAAO,EAAE,CAAC,CAAC;YAClE,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IAED,gCAAgC;IAChC,MAAM,GAAG,GAAG,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,WAAW,EAAE,CAAC;IAE1D,IAAI,GAAG,KAAK,MAAM,EAAE,CAAC;QACnB,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC7B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,IAAI,CAAC,yBAA0B,KAAe,CAAC,OAAO,EAAE,CAAC,CAAC;YAClE,OAAO,OAAO,CAAC;QACjB,CAAC;IACH,CAAC;SAAM,IAAI,GAAG,KAAK,MAAM,IAAI,GAAG,KAAK,KAAK,EAAE,CAAC;QAC3C,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC7B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,IAAI,CAAC,yBAA0B,KAAe,CAAC,OAAO,EAAE,CAAC,CAAC;YAClE,OAAO,OAAO,CAAC;QACjB,CAAC;IACH,CAAC;SAAM,CAAC;QACN,OAAO,OAAO,CAAC;IACjB,CAAC;AACH,CAAC"}