Add some tests for the --packages option

Author: efokschaner

package.json

@@ -67,7 +67,7 @@
   ],
   "scripts": {
     "pretest": "node scripts/copy_test_files.js",
-    "test": "nyc --reporter=html --reporter=text-summary mocha --timeout=10000 'dist/test/**/*.test.js'",
+    "test": "nyc --reporter=html --reporter=text-summary mocha --timeout=10000 'dist/test/**/*.test.js' --exclude 'dist/test/packages/**'",
     "prerebuild_specs": "npm run pretest",
     "rebuild_specs": "node scripts/rebuild_specs.js",
     "build": "tsc --project .",

scripts/copy_test_files.js

@@ -2,12 +2,128 @@
 
 const fs = require("fs-extra");
 const { join } = require("path");
+const { spawn } = require("child_process");
+
+function promiseFromChildProcess(childProcess) {
+    return new Promise(function (resolve, reject) {
+        childProcess.on("error", function (error) {
+            reject(
+                new Error(
+                    childProcess.spawnargs.join(" ") + " : " + error.message
+                )
+            );
+        });
+        childProcess.on("exit", function (code) {
+            if (code !== 0) {
+                reject(
+                    new Error(
+                        childProcess.spawnargs.join(" ") +
+                            " : exited with code " +
+                            code
+                    )
+                );
+            } else {
+                resolve();
+            }
+        });
+    });
+}
+
+const isWindows = process.platform === "win32";
+const npmCommand = isWindows ? "npm.cmd" : "npm";
+
+function ensureNpmVersion() {
+    return Promise.resolve().then(() => {
+        const npmProc = spawn(npmCommand, ["--version"], {
+            stdio: ["ignore", "pipe", "inherit"],
+        });
+        let npmVersion = "";
+        npmProc.stdout.on("data", (data) => {
+            npmVersion += data;
+        });
+        return promiseFromChildProcess(npmProc).then(() => {
+            npmVersion = npmVersion.trim();
+            let firstDot = npmVersion.indexOf(".");
+            const npmMajorVer = parseInt(
+                npmVersion.slice(0, npmVersion.indexOf("."))
+            );
+            if (npmMajorVer < 7) {
+                throw new Error(
+                    "npm version must be at least 7, version installed is " +
+                        npmVersion
+                );
+            }
+        });
+    });
+}
+
+function prepareMonorepoFolder() {
+    return Promise.resolve()
+        .then(() => {
+            return promiseFromChildProcess(
+                spawn(
+                    "git",
+                    ["clone", "https://github.com/efokschaner/ts-monorepo.git"],
+                    {
+                        cwd: join(__dirname, "../dist/test/packages"),
+                        stdio: "inherit",
+                    }
+                )
+            );
+        })
+        .then(() => {
+            return promiseFromChildProcess(
+                spawn(
+                    "git",
+                    ["checkout", "73bdd4c6458ad4cc3de35498e65d55a1a44a8499"],
+                    {
+                        cwd: join(
+                            __dirname,
+                            "../dist/test/packages/ts-monorepo"
+                        ),
+                        stdio: "inherit",
+                    }
+                )
+            );
+        })
+        .then(() => {
+            return promiseFromChildProcess(
+                spawn(npmCommand, ["install"], {
+                    cwd: join(__dirname, "../dist/test/packages/ts-monorepo"),
+                    stdio: "inherit",
+                })
+            );
+        })
+        .then(() => {
+            return promiseFromChildProcess(
+                spawn(npmCommand, ["run", "build"], {
+                    cwd: join(__dirname, "../dist/test/packages/ts-monorepo"),
+                    stdio: "inherit",
+                })
+            );
+        });
+}
+
+function prepareSinglePackageExample() {
+    return Promise.resolve().then(() => {
+        return promiseFromChildProcess(
+            spawn(npmCommand, ["run", "build"], {
+                cwd: join(
+                    __dirname,
+                    "../dist/test/packages/typedoc-single-package-example"
+                ),
+                stdio: "inherit",
+            })
+        );
+    });
+}
 
 const copy = [
     "test/converter",
     "test/converter2",
     "test/renderer",
     "test/module",
+    "test/packages",
     "test/utils/options/readers/data",
 ];
 
@@ -20,7 +136,12 @@ const copies = copy.map((dir) => {
         .then(() => fs.copy(source, target));
 });
 
-Promise.all(copies).catch((reason) => {
-    console.error(reason);
-    process.exit(1);
-});
+Promise.all(copies)
+    .then(ensureNpmVersion)
+    .then(() =>
+        Promise.all([prepareMonorepoFolder(), prepareSinglePackageExample()])
+    )
+    .catch((reason) => {
+        console.error(reason);
+        process.exit(1);
+    });

src/test/packages.test.ts

@@ -0,0 +1,62 @@
+import { ok, strictEqual } from "assert";
+import * as Path from "path";
+
+import * as td from "..";
+import { Logger } from "../lib/utils";
+import { expandPackages } from "../lib/utils/package-manifest";
+
+describe("Packages support", () => {
+    it("handles monorepos", () => {
+        const base = Path.join(__dirname, "packages", "ts-monorepo");
+        const app = new td.Application();
+        app.options.addReader(new td.TypeDocReader());
+        app.bootstrap({
+            options: Path.join(base, "typedoc.json"),
+        });
+        const project = app.convert();
+        ok(project, "Failed to convert");
+        const result = app.serializer.projectToObject(project);
+        ok(result.children !== undefined);
+        strictEqual(
+            result.children.length,
+            4,
+            "incorrect number of packages processed"
+        );
+    });
+
+    it("handles single packages", () => {
+        const base = Path.join(
+            __dirname,
+            "packages",
+            "typedoc-single-package-example"
+        );
+        const app = new td.Application();
+        app.options.addReader(new td.TypeDocReader());
+        app.bootstrap({
+            options: Path.join(base, "typedoc.json"),
+        });
+        const project = app.convert();
+        ok(project, "Failed to convert");
+        const result = app.serializer.projectToObject(project);
+        ok(result.children !== undefined);
+        strictEqual(
+            result.children.length,
+            1,
+            "incorrect number of packages processed"
+        );
+    });
+
+    describe("expandPackages", () => {
+        it("handles a glob", () => {
+            const base = Path.join(__dirname, "packages", "ts-monorepo");
+            const expandedPackages = expandPackages(new Logger(), base, [
+                "packages/*",
+            ]);
+            strictEqual(
+                expandedPackages.length,
+                3,
+                "Found an unexpected number of packages"
+            );
+        });
+    });
+});

src/test/packages/README.md

@@ -0,0 +1,5 @@
+# Example repos for "--packages" mode
+
+This folder contains examples for the testing of the "--packages" mode.
+
+The codebase https://github.com/efokschaner/ts-monorepo/tree/typedoc is also pulled dynamically in to the `dist` copy of this folder during tests.

src/test/packages/typedoc-single-package-example/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "typedoc-single-package-example",
+  "version": "1.0.0",
+  "description": "An example of using typedoc with a single package",
+  "private": true,
+  "main": "dist/index.js",
+  "scripts": {
+    "build": "tsc",
+    "test": "node ."
+  },
+  "devDependencies": {
+    "typescript": "^4.2.4"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/TypeStrong/TypeDoc.git"
+  },
+  "keywords": [
+    "typedoc",
+    "example"
+  ],
+  "author": "",
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/TypeStrong/TypeDoc/issues"
+  },
+  "homepage": "https://github.com/TypeStrong/TypeDoc#readme"
+}

src/test/packages/typedoc-single-package-example/src/index.ts

@@ -0,0 +1,7 @@
+export function helloWorld() {
+    return "Hello World!";
+}
+
+if (require.main === module) {
+    console.log(helloWorld());
+}

src/test/packages/typedoc-single-package-example/tsconfig.json

@@ -0,0 +1,19 @@
+{
+    "compilerOptions": {
+        "allowSyntheticDefaultImports": false,
+        "declaration": true,
+        "declarationMap": true,
+        "incremental": true,
+        "module": "commonjs",
+        "moduleResolution": "node",
+        "noUnusedLocals": true,
+        "noUnusedParameters": true,
+        "outDir": "dist",
+        "preserveConstEnums": true,
+        "removeComments": false,
+        "sourceMap": true,
+        "strict": true,
+        "target": "es2015"
+    },
+    "include": ["src/**/*"]
+}

src/test/packages/typedoc-single-package-example/typedoc.json

@@ -0,0 +1,7 @@
+{
+    "gitRevision": "master",
+    "name": "typedoc-single-package-example",
+    "out": "docs",
+    "packages": ["."],
+    "plugin": []
+}

tsconfig.json

@@ -33,6 +33,7 @@
         "src/test/converter2/**/*.ts",
         "src/test/renderer/specs",
         "src/test/.dot/**/*.ts",
-        "src/test/module/**/*.ts"
+        "src/test/module/**/*.ts",
+        "src/test/packages/**/*.ts"
     ]
 }