Fix expansion of globs with a single entry point

Resolves #2235

CHANGELOG.md

@@ -20,6 +20,7 @@
 -   Updated highlight colors for semantic links to meet WCAG AA contrast requirements, #2228.
 -   Type parameters are now highlighted consistently, #2230.
 -   Fixed semantic coloring in type and function signatures, #2227.
+-   Fix expansion of globs if a single entry point is provided, #2235.
 -   Fixed broken theme toggle if the page contained a member named "theme".
 
 ### Thanks!

src/index.ts

@@ -2,7 +2,6 @@ export { Application } from "./lib/application";
 
 export { EventDispatcher, Event } from "./lib/utils/events";
 export { resetReflectionID } from "./lib/models/reflections/abstract";
-export { normalizePath } from "./lib/utils/fs";
 /**
  * All symbols documented under the Models namespace are also available in the root import.
  */
@@ -50,6 +49,7 @@ export {
     EntryPointStrategy,
     EventHooks,
     MinimalSourceFile,
+    normalizePath,
 } from "./lib/utils";
 
 export type {

src/lib/application.ts

@@ -30,7 +30,7 @@ import { validateDocumentation } from "./validation/documentation";
 import { validateLinks } from "./validation/links";
 import { ApplicationEvents } from "./application-events";
 import { findTsConfigFile } from "./utils/tsconfig";
-import { getCommonDirectory, glob, readFile } from "./utils/fs";
+import { deriveRootDir, glob, readFile } from "./utils/fs";
 import { resetReflectionID } from "./models/reflections/abstract";
 
 // eslint-disable-next-line @typescript-eslint/no-var-requires
@@ -584,7 +584,7 @@ export class Application extends ChildableComponent<
     private _merge(): ProjectReflection | undefined {
         const start = Date.now();
 
-        const rootDir = getCommonDirectory(this.entryPoints);
+        const rootDir = deriveRootDir(this.entryPoints);
         const entryPoints = this.entryPoints.flatMap((entry) =>
             glob(entry, rootDir)
         );

src/lib/converter/plugins/PackagePlugin.ts

@@ -5,9 +5,9 @@ import { Converter } from "../converter";
 import type { Context } from "../context";
 import { BindOption, EntryPointStrategy, readFile } from "../../utils";
 import {
+    deriveRootDir,
     discoverInParentDir,
     discoverPackageJson,
-    getCommonDirectory,
 } from "../../utils/fs";
 import { nicePath } from "../../utils/paths";
 import { MinimalSourceFile } from "../../utils/minimalSourceFile";
@@ -81,7 +81,7 @@ export class PackagePlugin extends ConverterComponent {
                 ? this.entryPoints.map((d) => join(d, "package.json"))
                 : this.entryPoints;
 
-        const dirName = Path.resolve(getCommonDirectory(entryFiles));
+        const dirName = Path.resolve(deriveRootDir(entryFiles));
 
         this.application.logger.verbose(
             `Begin readme.md/package.json search at ${nicePath(dirName)}`

src/lib/converter/plugins/SourcePlugin.ts

@@ -7,9 +7,8 @@ import {
 import { Component, ConverterComponent } from "../components";
 import { Converter } from "../converter";
 import type { Context } from "../context";
-import { BindOption } from "../../utils";
+import { BindOption, normalizePath, getCommonDirectory } from "../../utils";
 import { isNamedNode } from "../utils/nodes";
-import { getCommonDirectory, normalizePath } from "../../utils/fs";
 import { dirname, relative } from "path";
 import { SourceReference } from "../../models";
 import { gitIsInstalled, Repository } from "../utils/repository";

src/lib/utils/entry-point.ts

@@ -9,11 +9,10 @@ import {
     ignorePackage,
     loadPackageManifest,
 } from "./package-manifest";
-import { createMinimatch, matchesAny, nicePath } from "./paths";
+import { createMinimatch, matchesAny, nicePath, normalizePath } from "./paths";
 import type { Logger } from "./loggers";
 import type { Options } from "./options";
-import { getCommonDirectory, glob, normalizePath } from "./fs";
-import { filterMap } from "./array";
+import { deriveRootDir, glob } from "./fs";
 import { assertNever } from "./general";
 
 /**
@@ -180,8 +179,7 @@ function getEntryPointsForPaths(
     options: Options,
     programs = getEntryPrograms(logger, options)
 ): DocumentationEntryPoint[] | undefined {
-    const baseDir =
-        options.getValue("basePath") || getCommonDirectory(inputFiles);
+    const baseDir = options.getValue("basePath") || deriveRootDir(inputFiles);
     const entryPoints: DocumentationEntryPoint[] = [];
 
     entryLoop: for (const fileOrDir of inputFiles.map(normalizePath)) {
@@ -237,7 +235,7 @@ export function getExpandedEntryPointsForPaths(
 }
 
 function expandGlobs(inputFiles: string[]) {
-    const base = getCommonDirectory(inputFiles);
+    const base = deriveRootDir(inputFiles);
     const result = inputFiles.flatMap((entry) =>
         glob(entry, base, { includeDirectories: true, followSymlinks: true })
     );
@@ -341,18 +339,6 @@ function expandInputFiles(
     return files;
 }
 
-function deriveRootDir(packageGlobPaths: string[]): string {
-    const globs = createMinimatch(packageGlobPaths);
-    const rootPaths = globs.flatMap((glob) =>
-        filterMap(glob.set, (set) => {
-            const stop = set.findIndex((part) => typeof part !== "string");
-            const path = stop === -1 ? set : set.slice(0, stop);
-            return `/${path.join("/")}`;
-        })
-    );
-    return getCommonDirectory(rootPaths);
-}
-
 /**
  * Expand the provided packages configuration paths, determining the entry points
  * and creating the ts.Programs for any which are found.

src/lib/utils/fs.ts

@@ -3,6 +3,8 @@ import { promises as fsp } from "fs";
 import { Minimatch } from "minimatch";
 import { dirname, join, relative, resolve } from "path";
 import { optional, validate } from "./validation";
+import { createMinimatch, normalizePath } from "./paths";
+import { filterMap } from "./array";
 
 export function isFile(file: string) {
     try {
@@ -20,6 +22,18 @@ export function isDir(path: string) {
     }
 }
 
+export function deriveRootDir(globPaths: string[]): string {
+    const globs = createMinimatch(globPaths);
+    const rootPaths = globs.flatMap((glob) =>
+        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);
+}
+
 /**
  * Get the longest directory path common to all files.
  */
@@ -42,16 +56,6 @@ export function getCommonDirectory(files: readonly string[]): string {
     return roots[0].slice(0, i).join("/");
 }
 
-/**
- * Normalize the given path.
- *
- * @param path  The path that should be normalized.
- * @returns The normalized path.
- */
-export function normalizePath(path: string) {
-    return path.replace(/\\/g, "/");
-}
-
 /**
  * Load the given file and return its contents.
  *

src/lib/utils/index.ts

@@ -14,13 +14,13 @@ export {
     copy,
     copySync,
     getCommonDirectory,
-    normalizePath,
     readFile,
     writeFile,
     writeFileSync,
     discoverInParentDir,
     discoverPackageJson,
 } from "./fs";
+export { normalizePath } from "./paths";
 export type { IfInternal, NeverIfInternal, Chars } from "./general";
 export { assertNever } from "./general";
 export { ConsoleLogger, Logger, LogLevel } from "./loggers";

src/lib/utils/options/readers/tsconfig.ts

@@ -4,7 +4,7 @@ import ts from "typescript";
 
 import type { Options, OptionsReader } from "../options";
 import type { Logger } from "../../loggers";
-import { normalizePath, isFile } from "../../fs";
+import { isFile } from "../../fs";
 import { ok } from "assert";
 import {
     additionalProperties,
@@ -13,7 +13,7 @@ import {
     optional,
     validate,
 } from "../../validation";
-import { nicePath } from "../../paths";
+import { nicePath, normalizePath } from "../../paths";
 import { createRequire } from "module";
 import {
     tsdocBlockTags,

src/lib/utils/options/readers/typedoc.ts

@@ -6,8 +6,8 @@ import type { OptionsReader } from "..";
 import type { Logger } from "../../loggers";
 import type { Options } from "../options";
 import { ok } from "assert";
-import { nicePath } from "../../paths";
-import { isFile, normalizePath } from "../../fs";
+import { nicePath, normalizePath } from "../../paths";
+import { isFile } from "../../fs";
 import { createRequire } from "module";
 
 /**

src/lib/utils/paths.ts

@@ -1,6 +1,5 @@
 import { Minimatch } from "minimatch";
 import { isAbsolute, relative } from "path";
-import { normalizePath } from "./fs";
 
 /**
  * Convert array of glob patterns to array of minimatch instances.
@@ -30,3 +29,13 @@ export function nicePath(absPath: string) {
     }
     return `./${normalizePath(relativePath)}`;
 }
+
+/**
+ * Normalize the given path.
+ *
+ * @param path  The path that should be normalized.
+ * @returns The normalized path.
+ */
+export function normalizePath(path: string) {
+    return path.replace(/\\/g, "/");
+}