interface member @link bug

.editorconfig

@@ -0,0 +1,14 @@
+# https://editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 4
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[package.json]
+indent_size = 2

.github/workflows/main.yaml

@@ -12,18 +12,18 @@ jobs:
         runs-on: ubuntu-latest
         steps:
             - name: Checkout
-              uses: actions/checkout@v2.0.0
+              uses: actions/checkout@v4
 
             - name: Setup Node
-              uses: actions/setup-node@v3
+              uses: actions/setup-node@v4
               with:
-                  node-version: 16
+                  node-version: 20
 
             - name: Run
               run: chmod +x run.sh && ./run.sh
 
             - name: Upload Results
-              uses: actions/upload-artifact@v3
+              uses: actions/upload-artifact@v4
               with:
                   name: typedoc-output
                   path: docs

.gitignore

@@ -1,4 +1,5 @@
 node_modules
-docs
-build
 dist
+docs
+*.tsbuildinfo
+docs-json

README.md

@@ -1,15 +1,36 @@
-# TypeDoc reproductions
+# TypeDoc Packages Example
 
-If you find a bug in TypeDoc and file an issue, it's helpful -- even necessary -- to create a minimal reproduction of the bug.
+This monorepo provides an example of how TypeDoc's packages mode can be used to generate documentation
+for multiple projects and combine it into a single site which contains all documented projects.
 
-This link explains why we ask for a minimal reproduction. Thank you in advance!
-https://gist.github.com/Rich-Harris/88c5fc2ac6dc941b22e7996af05d70ff
+You can see the result of building this at <https://gerritbirkeland.com/typedoc-packages-example/index.html>
 
-One way to do that is opening a pull-request on this repository with your reproduction. Github Actions will execute `./run.sh`.
+## Building
 
-You can put anything you want here: add/remove dependencies in `package.json`, change the commands in `run.sh`, change the code in `./src/index.ts`,
-or add a hundred more `.ts` files.
+```bash
+git clone [email protected]:Gerrit0/typedoc-packages-example.git
+npm install
 
-Once your pull request is submitted here, link to it in your TypeDoc bug report.
+# We need to build before building the docs so that `foo` can reference types from `bar`
+# TypeDoc can't use TypeScript's build mode to do this for us because build mode may skip
+# a project that needs documenting, or include packages that shouldn't be included in the docs
+npm run build
 
-Forked from the [ts-node-repros](https://github.com/TypeStrong/ts-node-repros) for TypeDoc.
+# Now, we can run TypeDoc with packages mode to generate a single docs folder
+npm run docs
+```
+
+## Building - Advanced
+
+If your build system requires running with multiple versions of TypeDoc, you can instead manually
+generate JSON files for each package, and then run TypeDoc on the generated JSON files.
+
+```bash
+# Cross-package links will be invalid during initial conversion, they will be validated when merging
+for package in packages/*; do
+    npx typedoc --json docs-json/$(basename $package).json --options $package/typedoc.json --validation.invalidLink false
+done
+
+# Merge previously generated documentation together into a site
+npx typedoc --entryPointStrategy merge "docs-json/*.json"
+```

package.json

@@ -1,7 +1,17 @@
 {
-  "name": "typedoc-repros",
+  "name": "typedoc-packages-example",
+  "version": "1.0.0",
+  "private": true,
+  "workspaces": [
+    "packages/*"
+  ],
+  "scripts": {
+    "build": "tsc --build",
+    "docs": "typedoc",
+    "docs-all": "npm run docs --workspaces --if-present"
+  },
   "dependencies": {
-    "typedoc": "latest",
-    "typescript": "latest"
+    "typedoc": "^0.26.3",
+    "typescript": "^5.5.2"
   }
 }

packages/lib/README.md

@@ -0,0 +1,3 @@
+# lib
+
+Simple package which is depended upon by the `wrapping-lib` package.

packages/lib/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "@typedoc/lib",
+  "version": "0.0.1",
+  "exports": "./dist/index.js",
+  "scripts": {
+    "docs": "typedoc --out docs"
+  }
+}

packages/lib/src/func.ts

@@ -0,0 +1,6 @@
+import type { LibInt } from "./intf";
+
+export function libFunc(): LibInt {
+    console.log("Bar");
+    return { bar: true };
+}

packages/lib/src/index.ts

@@ -0,0 +1,2 @@
+export * from "./func";
+export type * from "./intf";

packages/lib/src/intf.ts

@@ -0,0 +1,4 @@
+export interface LibInt {
+    /** Assigned by {@link libFunc}. */
+    bar: true;
+}

packages/lib/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "rootDir": "src",
+    "outDir": "dist"
+  },
+  "include": ["src"]
+}

packages/lib/typedoc.json

@@ -0,0 +1,4 @@
+{
+    "extends": ["../../typedoc.base.jsonc"],
+    "entryPoints": ["src/index.ts"]
+}

packages/shared-assets/README.md

@@ -0,0 +1,7 @@
+# README only package
+
+This package only contains a readme file, without any entry points. This is intended to support
+packages which don't export any JS, only shared assets. See [#2264](https://github.com/TypeStrong/typedoc/issues/2264).
+
+This package also does not contain a `docs` script in its `package.json`, so `npm run docs-all` will not run TypeDoc
+within it, and therefore not generate a docs folder here.

packages/shared-assets/package.json

@@ -0,0 +1,4 @@
+{
+  "name": "@typedoc/shared-assets",
+  "version": "0.0.1"
+}

packages/shared-assets/typedoc.json

@@ -0,0 +1,5 @@
+{
+    "extends": ["../../typedoc.base.jsonc"],
+    // If not set, will result in a warning being printed since it's likely a misconfiguration
+    "entryPoints": []
+}