typedoc 0.24.0 → 0.24.2

package/dist/lib/utils/fs.d.ts

@@ -1,16 +1,10 @@
 export declare function isFile(file: string): boolean;
 export declare function isDir(path: string): boolean;
+export declare function deriveRootDir(globPaths: string[]): string;
 /**
  * Get the longest directory path common to all files.
  */
 export declare function getCommonDirectory(files: readonly string[]): string;
-/**
- * Normalize the given path.
- *
- * @param path  The path that should be normalized.
- * @returns The normalized path.
- */
-export declare function normalizePath(path: string): string;
 /**
  * Load the given file and return its contents.
  *

package/dist/lib/utils/fs.js

@@ -23,12 +23,14 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.findPackageForPath = exports.discoverPackageJson = exports.discoverInParentDirExactMatch = exports.discoverInParentDir = exports.hasTsExtension = exports.glob = exports.copySync = exports.copy = exports.writeFile = exports.writeFileSync = exports.readFile = exports.normalizePath = exports.getCommonDirectory = exports.isDir = exports.isFile = void 0;
+exports.findPackageForPath = exports.discoverPackageJson = exports.discoverInParentDirExactMatch = exports.discoverInParentDir = exports.hasTsExtension = exports.glob = exports.copySync = exports.copy = exports.writeFile = exports.writeFileSync = exports.readFile = exports.getCommonDirectory = exports.deriveRootDir = exports.isDir = exports.isFile = void 0;
 const fs = __importStar(require("fs"));
 const fs_1 = require("fs");
 const minimatch_1 = require("minimatch");
 const path_1 = require("path");
 const validation_1 = require("./validation");
+const paths_1 = require("./paths");
+const array_1 = require("./array");
 function isFile(file) {
     try {
         return fs.statSync(file).isFile();
@@ -47,6 +49,16 @@ function isDir(path) {
     }
 }
 exports.isDir = isDir;
+function deriveRootDir(globPaths) {
+    const globs = (0, paths_1.createMinimatch)(globPaths);
+    const rootPaths = globs.flatMap((glob) => (0, array_1.filterMap)(glob.set, (set) => {
+        const stop = set.findIndex((part) => typeof part !== "string");
+        const path = stop === -1 ? set : set.slice(0, stop);
+        return `/${path.join("/").replace(/^\//, "")}`;
+    }));
+    return getCommonDirectory(rootPaths);
+}
+exports.deriveRootDir = deriveRootDir;
 /**
  * Get the longest directory path common to all files.
  */
@@ -65,16 +77,6 @@ function getCommonDirectory(files) {
     return roots[0].slice(0, i).join("/");
 }
 exports.getCommonDirectory = getCommonDirectory;
-/**
- * Normalize the given path.
- *
- * @param path  The path that should be normalized.
- * @returns The normalized path.
- */
-function normalizePath(path) {
-    return path.replace(/\\/g, "/");
-}
-exports.normalizePath = normalizePath;
 /**
  * Load the given file and return its contents.
  *
@@ -118,8 +120,8 @@ exports.readFile = readFile;
  * @param data  The contents of the file.
  */
 function writeFileSync(fileName, data) {
-    fs.mkdirSync((0, path_1.dirname)(normalizePath(fileName)), { recursive: true });
-    fs.writeFileSync(normalizePath(fileName), data);
+    fs.mkdirSync((0, path_1.dirname)((0, paths_1.normalizePath)(fileName)), { recursive: true });
+    fs.writeFileSync((0, paths_1.normalizePath)(fileName), data);
 }
 exports.writeFileSync = writeFileSync;
 /**
@@ -131,10 +133,10 @@ exports.writeFileSync = writeFileSync;
  * @param data  The contents of the file.
  */
 async function writeFile(fileName, data) {
-    await fs_1.promises.mkdir((0, path_1.dirname)(normalizePath(fileName)), {
+    await fs_1.promises.mkdir((0, path_1.dirname)((0, paths_1.normalizePath)(fileName)), {
         recursive: true,
     });
-    await fs_1.promises.writeFile(normalizePath(fileName), data);
+    await fs_1.promises.writeFile((0, paths_1.normalizePath)(fileName), data);
 }
 exports.writeFile = writeFile;
 /**
@@ -175,8 +177,8 @@ exports.copySync = copySync;
  */
 function glob(pattern, root, options = {}) {
     const result = [];
-    const mini = new minimatch_1.Minimatch(normalizePath(pattern));
-    const dirs = [normalizePath(root).split("/")];
+    const mini = new minimatch_1.Minimatch((0, paths_1.normalizePath)(pattern));
+    const dirs = [(0, paths_1.normalizePath)(root).split("/")];
     // cache of real paths to avoid infinite recursion
     const symlinkTargetsSeen = new Set();
     // cache of fs.realpathSync results to avoid extra I/O