Allow new file extensions in pacakges mode

Also refactor more tests to use fixture builder

Resolves #1952.

Author: Gerrit0

CHANGELOG.md

@@ -73,6 +73,7 @@
 -   JS exports defined as `exports.foo = ...` will now be converted as variables rather than properties.
 -   The `excludeNotDocumented` option will no longer hide a module if it has a documentation comment, #1948.
 -   Prevent `--excludeNotDocumented` from hiding properties of type literals (`a` in `function fn(p: { a: string })`), #1752.
+-   Allow `cts` and `mts` extensions in packages resolution mode, #1952.
 -   Corrected schema generation for https://typedoc.org/schema.json
 
 ### Thanks!

src/lib/utils/package-manifest.ts

@@ -225,7 +225,10 @@ export function getTsEntryPointForPackage(
     // Pass an empty `paths` as node_modules locations do not need to be examined
     try {
         entryPointPath = require.resolve(entryPointPath, { paths: [] });
-        if (/\.tsx?$/.test(entryPointPath) && existsSync(entryPointPath)) {
+        if (
+            /\.([cm]ts|tsx?)$/.test(entryPointPath) &&
+            existsSync(entryPointPath)
+        ) {
             return entryPointPath;
         }
     } catch (e: any) {
@@ -237,7 +240,10 @@ export function getTsEntryPointForPackage(
                 "..",
                 packageTypes ?? packageMain
             );
-            if (/\.tsx?$/.test(entryPointPath) && existsSync(entryPointPath)) {
+            if (
+                /\.([cm][tj]s|tsx?)$/.test(entryPointPath) &&
+                existsSync(entryPointPath)
+            ) {
                 return entryPointPath;
             } else {
                 logger.warn(

src/test/packages.test.ts

@@ -7,18 +7,82 @@ import {
     getTsEntryPointForPackage,
 } from "../lib/utils/package-manifest";
 
+import { tempdirProject } from "@typestrong/fs-fixture-builder";
+import { TestLogger } from "./TestLogger";
+
 describe("Packages support", () => {
+    let project: ReturnType<typeof tempdirProject>;
+
+    beforeEach(() => {
+        project = tempdirProject();
+    });
+
+    afterEach(() => {
+        project.rm();
+    });
+
     it("handles monorepos", () => {
-        const base = join(__dirname, "packages", "multi-package");
-        const logger = new Logger();
-        const packages = expandPackages(logger, ".", [base]);
+        project.addJsonFile("tsconfig.json", {
+            compilerOptions: {
+                strict: true,
+                sourceMap: true,
+            },
+            exclude: ["node_modules", "dist"],
+        });
+        const childTsconfig = {
+            extends: "../../tsconfig.json",
+            compilerOptions: {
+                outDir: "dist",
+            },
+        };
+        project.addJsonFile("package.json", {
+            name: "typedoc-multi-package-example",
+            main: "dist/index.js",
+            workspaces: ["packages/*"],
+        });
+
+        // Bar, types entry point
+        project.addFile(
+            "packages/bar/index.d.ts",
+            "export function bar(): void;"
+        );
+        project.addJsonFile("packages/bar/package.json", {
+            name: "typedoc-multi-package-bar",
+            version: "1.0.0",
+            types: "index.d.ts",
+        });
+        project.addJsonFile("packages/bar/tsconfig.json", childTsconfig);
+
+        // Baz, TypeScript "main" entry point
+        project.addFile("packages/baz/index.ts", "export function baz(): {}");
+        project.addJsonFile("packages/baz/package.json", {
+            name: "typedoc-multi-package-baz",
+            version: "1.0.0",
+            main: "index.ts",
+        });
+        project.addJsonFile("packages/baz/tsconfig.json", childTsconfig);
+
+        // Foo, entry point with "typedocMain"
+        project.addFile("packages/foo/dist/index.js", "module.exports = 123");
+        project.addFile("packages/foo/index.ts", "export function foo() {}");
+        project.addJsonFile("packages/foo/package.json", {
+            name: "typedoc-multi-package-foo",
+            version: "1.0.0",
+            main: "dist/index",
+            typedocMain: "index.ts",
+        });
+        project.addJsonFile("packages/foo/tsconfig.json", childTsconfig);
+
+        project.write();
+        const logger = new TestLogger();
+        const packages = expandPackages(logger, project.cwd, [project.cwd]);
 
         equal(
             packages,
             [
-                join(base, "packages/bar"),
-                join(base, "packages/baz"),
-                join(base, "packages/foo"),
+                join(project.cwd, "packages/bar"),
+                join(project.cwd, "packages/baz"),
+                join(project.cwd, "packages/foo"),
             ].map(normalizePath)
         );
 
@@ -32,19 +96,82 @@ describe("Packages support", () => {
         });
 
         equal(entries, [
-            join(base, "packages/bar/index.d.ts"),
-            join(base, "packages/baz/index.ts"),
-            join(base, "packages/foo/index.ts"),
+            join(project.cwd, "packages/bar/index.d.ts"),
+            join(project.cwd, "packages/baz/index.ts"),
+            join(project.cwd, "packages/foo/index.ts"),
         ]);
 
-        ok(!logger.hasErrors() && !logger.hasWarnings());
+        logger.discardDebugMessages();
+        logger.expectNoOtherMessages();
     });
 
     it("handles single packages", () => {
-        const base = join(__dirname, "packages", "single-package");
-        const logger = new Logger();
-        const packages = expandPackages(logger, ".", [base]);
+        project.addJsonFile("tsconfig.json", {
+            compilerOptions: {
+                outDir: "dist",
+                sourceMap: true,
+                strict: true,
+            },
+            include: ["src"],
+        });
+        project.addJsonFile("package.json", {
+            name: "typedoc-single-package",
+            main: "dist/index.js",
+        });
+        project.addFile("dist/index.js", `//# sourceMappingURL=index.js.map`);
+        project.addJsonFile("dist/index.js.map", {
+            version: 3,
+            file: "index.js",
+            sourceRoot: "",
+            sources: ["../src/index.ts"],
+            names: [],
+            mappings: "",
+        });
+        project.addFile(
+            "src/index.ts",
+            `export function helloWorld() { return "Hello World!"; }`
+        );
+        project.write();
+
+        const logger = new TestLogger();
+        const packages = expandPackages(logger, project.cwd, [project.cwd]);
+
+        logger.expectNoOtherMessages();
+        equal(packages, [normalizePath(project.cwd)]);
+    });
+
+    it("Handles TS 4.7 extensions", () => {
+        project.addJsonFile("tsconfig.json", {
+            compilerOptions: {
+                outDir: "dist",
+                sourceMap: true,
+                strict: true,
+            },
+            include: ["src"],
+        });
+        project.addJsonFile("package.json", {
+            name: "typedoc-single-package",
+            main: "dist/index.cjs",
+        });
+        project.addFile("dist/index.cjs", `//# sourceMappingURL=index.cjs.map`);
+        project.addJsonFile("dist/index.cjs.map", {
+            version: 3,
+            file: "index.cjs",
+            sourceRoot: "",
+            sources: ["../src/index.cts"],
+            names: [],
+            mappings: "",
+        });
+        project.addFile(
+            "src/index.cts",
+            `export function helloWorld() { return "Hello World!"; }`
+        );
+        project.write();
+
+        const logger = new TestLogger();
+        const packages = expandPackages(logger, project.cwd, [project.cwd]);
 
-        equal(packages, [normalizePath(base)]);
+        logger.expectNoOtherMessages();
+        equal(packages, [normalizePath(project.cwd)]);
     });
 });