typedoc 0.28.18 → 0.28.20

package/dist/lib/utils/declaration-maps.js

@@ -1,51 +0,0 @@
-import { existsSync } from "fs";
-import { readFile } from "./fs.js";
-import { Validation } from "#utils";
-import { join, relative, resolve } from "path";
-import { getCommonDirectory, normalizePath } from "./paths.js";
-const declarationMapCache = new Map();
-export function resolveDeclarationMaps(file) {
-    if (!/\.d\.[cm]?ts$/.test(file))
-        return file;
-    if (declarationMapCache.has(file))
-        return declarationMapCache.get(file);
-    const mapFile = file + ".map";
-    if (!existsSync(mapFile))
-        return file;
-    let sourceMap;
-    try {
-        sourceMap = JSON.parse(readFile(mapFile));
-    }
-    catch {
-        return file;
-    }
-    if (Validation.validate({
-        file: String,
-        sourceRoot: Validation.optional(String),
-        sources: [Array, String],
-    }, sourceMap)) {
-        // There's a pretty large assumption in here that we only have
-        // 1 source file per js file. This is a pretty standard typescript approach,
-        // but people might do interesting things with transpilation that could break this.
-        let source = sourceMap.sources[0];
-        // If we have a sourceRoot, trim any leading slash from the source, and join them
-        // Similar to how it's done at https://github.com/mozilla/source-map/blob/58819f09018d56ef84dc41ba9c93f554e0645169/lib/util.js#L412
-        if (sourceMap.sourceRoot !== undefined) {
-            source = source.replace(/^\//, "");
-            source = join(sourceMap.sourceRoot, source);
-        }
-        const result = resolve(mapFile, "..", source);
-        declarationMapCache.set(file, result);
-        return result;
-    }
-    return file;
-}
-// See also: inferEntryPoints in entry-point.ts
-export function addInferredDeclarationMapPaths(opts, files) {
-    const rootDir = opts.rootDir || getCommonDirectory(files);
-    const declDir = opts.declarationDir || opts.outDir || rootDir;
-    for (const file of files) {
-        const mapFile = normalizePath(resolve(declDir, relative(rootDir, file)).replace(/\.([cm]?[tj]s)x?$/, ".d.$1"));
-        declarationMapCache.set(mapFile, file);
-    }
-}

package/dist/lib/utils/entry-point.js

@@ -1,330 +0,0 @@
-import { join, relative, resolve } from "path";
-import ts from "typescript";
-import * as FS from "fs";
-import { expandPackages } from "./package-manifest.js";
-import { deriveRootDir, getCommonDirectory, MinimatchSet, nicePath, normalizePath } from "./paths.js";
-import { discoverPackageJson, glob, inferPackageEntryPointPaths, isDir } from "./fs.js";
-import { assertNever, i18n } from "#utils";
-import { addInferredDeclarationMapPaths, resolveDeclarationMaps } from "./declaration-maps.js";
-/**
- * Defines how entry points are interpreted.
- * @enum
- */
-export const EntryPointStrategy = {
-    /**
-     * The default behavior in v0.22+, expects all provided entry points as being part of a single program.
-     * Any directories included in the entry point list will result in `dir/index.([cm][tj]s|[tj]sx?)` being used.
-     */
-    Resolve: "resolve",
-    /**
-     * The default behavior in v0.21 and earlier. Behaves like the resolve behavior, but will recursively
-     * expand directories into an entry point for each file within the directory.
-     */
-    Expand: "expand",
-    /**
-     * Run TypeDoc in each directory passed as an entry point. Once all directories have been converted,
-     * use the merge option to produce final output.
-     */
-    Packages: "packages",
-    /**
-     * Merges multiple previously generated output from TypeDoc's --json output together into a single project.
-     */
-    Merge: "merge",
-};
-export function inferEntryPoints(logger, options, programs) {
-    const packageJson = discoverPackageJson(options.packageDir ?? process.cwd());
-    if (!packageJson) {
-        logger.warn(i18n.no_entry_points_provided());
-        return [];
-    }
-    const pathEntries = inferPackageEntryPointPaths(packageJson.file);
-    const entryPoints = [];
-    programs ||= getEntryPrograms(pathEntries.map((p) => p[1]), logger, options);
-    // See also: addInferredDeclarationMapPaths in symbol-id factory
-    const jsToTsSource = new Map();
-    for (const program of programs) {
-        const opts = program.getCompilerOptions();
-        const rootDir = opts.rootDir || getCommonDirectory(program.getRootFileNames());
-        const outDir = opts.outDir || rootDir;
-        for (const tsFile of program.getRootFileNames()) {
-            const jsFile = normalizePath(resolve(outDir, relative(rootDir, tsFile)).replace(/\.([cm]?)[tj]sx?$/, ".$1js"));
-            jsToTsSource.set(jsFile, tsFile);
-        }
-    }
-    for (const [name, path] of pathEntries) {
-        // Strip leading ./ from the display name
-        const displayName = name.replace(/^\.\/?/, "");
-        const targetPath = jsToTsSource.get(normalizePath(path)) || resolveDeclarationMaps(path) || path;
-        const program = programs.find((p) => p.getSourceFile(targetPath));
-        if (program) {
-            entryPoints.push({
-                displayName,
-                program,
-                sourceFile: program.getSourceFile(targetPath),
-            });
-        }
-        else if (/\.[cm]?js$/.test(path)) {
-            logger.warn(i18n.failed_to_resolve_0_to_ts_path(nicePath(path)));
-        }
-    }
-    if (entryPoints.length === 0) {
-        logger.warn(i18n.no_entry_points_provided());
-        return [];
-    }
-    logger.verbose(`Inferred entry points to be:\n\t${entryPoints.map(e => nicePath(e.sourceFile.fileName)).join("\n\t")}`);
-    return entryPoints;
-}
-export function getEntryPoints(logger, options) {
-    if (!options.isSet("entryPoints")) {
-        logger.warn(i18n.no_entry_points_provided());
-        return [];
-    }
-    const entryPoints = options.getValue("entryPoints");
-    const exclude = options.getValue("exclude");
-    // May be set explicitly to be an empty array to only include a readme for a package
-    // See #2264
-    if (entryPoints.length === 0) {
-        return [];
-    }
-    let result;
-    const strategy = options.getValue("entryPointStrategy");
-    switch (strategy) {
-        case EntryPointStrategy.Resolve:
-            result = getEntryPointsForPaths(logger, expandGlobs(entryPoints, exclude, logger), options);
-            break;
-        case EntryPointStrategy.Expand:
-            result = getExpandedEntryPointsForPaths(logger, expandGlobs(entryPoints, exclude, logger), options);
-            break;
-        case EntryPointStrategy.Merge:
-        case EntryPointStrategy.Packages:
-            // Doesn't really have entry points in the traditional way of how TypeDoc has dealt with them.
-            return [];
-        default:
-            assertNever(strategy);
-    }
-    if (result.length === 0) {
-        logger.error(i18n.unable_to_find_any_entry_points());
-        return;
-    }
-    return result;
-}
-/**
- * Document entry points are markdown documents that the user has requested we include in the project with
- * an option rather than a `@document` tag.
- *
- * @returns A list of `.md` files to include in the documentation as documents.
- */
-export function getDocumentEntryPoints(logger, options) {
-    const docGlobs = options.getValue("projectDocuments");
-    if (docGlobs.length === 0) {
-        return [];
-    }
-    const docPaths = expandGlobs(docGlobs, [], logger);
-    // We might want to expand this in the future, there are quite a lot of extensions
-    // that have at some point or another been used for markdown: https://superuser.com/a/285878
-    const supportedFileRegex = /\.(md|markdown)$/;
-    const expanded = expandInputFiles(logger, docPaths, options, supportedFileRegex);
-    const baseDir = options.getValue("displayBasePath") || options.getValue("basePath") || getCommonDirectory(expanded);
-    return expanded.map((path) => {
-        return {
-            displayName: relative(baseDir, path).replace(/\.[^.]+$/, ""),
-            path,
-        };
-    });
-}
-export function getWatchEntryPoints(logger, options, program) {
-    let result;
-    const entryPoints = options.getValue("entryPoints");
-    const exclude = options.getValue("exclude");
-    const strategy = options.getValue("entryPointStrategy");
-    switch (strategy) {
-        case EntryPointStrategy.Resolve:
-            if (options.isSet("entryPoints")) {
-                result = getEntryPointsForPaths(logger, expandGlobs(entryPoints, exclude, logger), options, [program]);
-            }
-            else {
-                result = inferEntryPoints(logger, options, [program]);
-            }
-            break;
-        case EntryPointStrategy.Expand:
-            if (options.isSet("entryPoints")) {
-                result = getExpandedEntryPointsForPaths(logger, expandGlobs(entryPoints, exclude, logger), options, [program]);
-            }
-            else {
-                result = inferEntryPoints(logger, options, [program]);
-            }
-            break;
-        case EntryPointStrategy.Packages:
-            logger.error(i18n.watch_does_not_support_packages_mode());
-            break;
-        case EntryPointStrategy.Merge:
-            logger.error(i18n.watch_does_not_support_merge_mode());
-            break;
-        default:
-            assertNever(strategy);
-    }
-    if (result && result.length === 0) {
-        logger.error(i18n.unable_to_find_any_entry_points());
-        return;
-    }
-    return result;
-}
-export function getPackageDirectories(logger, options, packageGlobPaths) {
-    const exclude = new MinimatchSet(options.getValue("exclude"));
-    const rootDir = deriveRootDir(packageGlobPaths);
-    // packages arguments are workspace tree roots, or glob patterns
-    // This expands them to leave only leaf packages
-    return expandPackages(logger, rootDir, packageGlobPaths, exclude);
-}
-function getModuleName(fileName, baseDir) {
-    return normalizePath(relative(baseDir, fileName)).replace(/(\/index)?(\.d)?\.([cm][tj]s|[tj]sx?)$/, "");
-}
-/**
- * Converts a list of file-oriented paths in to DocumentationEntryPoints for conversion.
- * This is in contrast with the package-oriented `getEntryPointsForPackages`
- */
-function getEntryPointsForPaths(logger, inputFiles, options, programs = getEntryPrograms(inputFiles, logger, options)) {
-    const baseDir = options.getValue("displayBasePath") || options.getValue("basePath") ||
-        getCommonDirectory(inputFiles);
-    const entryPoints = [];
-    let expandSuggestion = true;
-    entryLoop: for (const fileOrDir of inputFiles.map(normalizePath)) {
-        const toCheck = [fileOrDir];
-        if (!/\.([cm][tj]s|[tj]sx?)$/.test(fileOrDir)) {
-            toCheck.push(`${fileOrDir}/index.ts`, `${fileOrDir}/index.cts`, `${fileOrDir}/index.mts`, `${fileOrDir}/index.tsx`, `${fileOrDir}/index.js`, `${fileOrDir}/index.cjs`, `${fileOrDir}/index.mjs`, `${fileOrDir}/index.jsx`);
-        }
-        for (const program of programs) {
-            for (const check of toCheck) {
-                const sourceFile = program.getSourceFile(check);
-                if (sourceFile) {
-                    entryPoints.push({
-                        displayName: getModuleName(resolve(check), baseDir),
-                        sourceFile,
-                        program,
-                    });
-                    continue entryLoop;
-                }
-            }
-        }
-        logger.warn(i18n.entry_point_0_not_in_program(nicePath(fileOrDir)));
-        if (expandSuggestion && isDir(fileOrDir)) {
-            expandSuggestion = false;
-            logger.info(i18n.use_expand_or_glob_for_files_in_dir());
-        }
-    }
-    return entryPoints;
-}
-export function getExpandedEntryPointsForPaths(logger, inputFiles, options, programs = getEntryPrograms(inputFiles, logger, options)) {
-    const compilerOptions = options.getCompilerOptions(logger);
-    const supportedFileRegex = compilerOptions.allowJs || compilerOptions.checkJs
-        ? /\.([cm][tj]s|[tj]sx?)$/
-        : /\.([cm]ts|tsx?)$/;
-    return getEntryPointsForPaths(logger, expandInputFiles(logger, inputFiles, options, supportedFileRegex), options, programs);
-}
-function expandGlobs(globs, exclude, logger) {
-    const excludePatterns = new MinimatchSet(exclude);
-    const base = deriveRootDir(globs);
-    const result = globs.flatMap((entry) => {
-        const result = glob(entry, base, {
-            includeDirectories: true,
-            followSymlinks: true,
-        });
-        const filtered = result.filter((file) => file === entry || !excludePatterns.matchesAny(file));
-        if (result.length === 0) {
-            // #2918 - do not pass entry through nicePath here in case it contains
-            // windows path separators which should cause additional warnings.
-            logger.warn(i18n.glob_0_did_not_match_any_files(entry));
-        }
-        else if (filtered.length === 0) {
-            logger.warn(i18n.entry_point_0_did_not_match_any_files_after_exclude(entry));
-        }
-        else if (filtered.length !== 1) {
-            logger.verbose(`Expanded ${entry} to:\n\t${filtered
-                .map(nicePath)
-                .join("\n\t")}`);
-        }
-        return filtered;
-    });
-    return result;
-}
-function getEntryPrograms(inputFiles, logger, options) {
-    const noTsConfigFound = options.getFileNames().length === 0 &&
-        options.getProjectReferences().length === 0;
-    const rootProgram = noTsConfigFound
-        ? ts.createProgram({
-            rootNames: inputFiles,
-            options: options.getCompilerOptions(logger),
-        })
-        : ts.createProgram({
-            rootNames: options.getFileNames(),
-            options: options.getCompilerOptions(logger),
-            projectReferences: options.getProjectReferences(),
-        });
-    addInferredDeclarationMapPaths(options.getCompilerOptions(logger), options.getFileNames());
-    const programs = [rootProgram];
-    // This might be a solution style tsconfig, in which case we need to add a program for each
-    // reference so that the converter can look through each of these.
-    if (rootProgram.getRootFileNames().length === 0) {
-        logger.verbose("tsconfig appears to be a solution style tsconfig - creating programs for references");
-        const resolvedReferences = rootProgram.getResolvedProjectReferences();
-        for (const ref of resolvedReferences ?? []) {
-            if (!ref)
-                continue; // This indicates bad configuration... will be reported later.
-            programs.push(ts.createProgram({
-                options: options.fixCompilerOptions(ref.commandLine.options, logger),
-                rootNames: ref.commandLine.fileNames,
-                projectReferences: ref.commandLine.projectReferences,
-            }));
-            addInferredDeclarationMapPaths(ref.commandLine.options, ref.commandLine.fileNames);
-        }
-    }
-    return programs;
-}
-/**
- * Expand a list of input files.
- *
- * Searches for directories in the input files list and replaces them with a
- * listing of all TypeScript files within them. One may use the ```--exclude``` option
- * to filter out files with a pattern.
- *
- * @param inputFiles  The list of files that should be expanded.
- * @returns  The list of input files with expanded directories.
- */
-function expandInputFiles(logger, entryPoints, options, supportedFile) {
-    const files = [];
-    const exclude = new MinimatchSet(options.getValue("exclude"));
-    function add(file, entryPoint) {
-        let stats;
-        try {
-            stats = FS.statSync(file);
-        }
-        catch {
-            // No permission or a symbolic link, do not resolve.
-            return;
-        }
-        const fileIsDir = stats.isDirectory();
-        if (fileIsDir && !file.endsWith("/")) {
-            file = `${file}/`;
-        }
-        if (fileIsDir) {
-            FS.readdirSync(file).forEach((next) => {
-                add(join(file, next), false);
-            });
-        }
-        else if (supportedFile.test(file)) {
-            if (!entryPoint && exclude.matchesAny(file)) {
-                return;
-            }
-            files.push(normalizePath(file));
-        }
-    }
-    entryPoints.forEach((file) => {
-        const resolved = resolve(file);
-        if (!FS.existsSync(resolved)) {
-            logger.warn(i18n.entry_point_0_did_not_exist(file));
-            return;
-        }
-        add(resolved, true);
-    });
-    return files;
-}