Skip to content

Commit

Permalink
Support TypeDoc 0.26
Browse files Browse the repository at this point in the history
  • Loading branch information
Gerrit0 committed Jun 22, 2024
1 parent 56b6b1a commit fe5fff1
Show file tree
Hide file tree
Showing 4 changed files with 181 additions and 143 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
### 3.0.0 (2024-06-22)

- Support TypeDoc 0.26
- BREAKING: Drop support for TypeDoc before 0.26.

### 2.3.0 (2024-06-12)

- Added `--collapseInternalModule` option.
Expand Down
7 changes: 6 additions & 1 deletion index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,12 @@ export function load(app: Application) {
app.converter.on(
Converter.EVENT_CREATE_DECLARATION,
(context: Context, refl: Reflection) => {
// TypeDoc 0.26 doesn't fire EVENT_CREATE_DECLARATION for project
// We need to ensure the project has a program attached to it, so
// do that when the first declaration is created.
if (knownPrograms.size === 0) {
knownPrograms.set(refl.project, context.program);
}
if (refl.kindOf(ModuleLike)) {
knownPrograms.set(refl, context.program);
}
Expand Down Expand Up @@ -195,7 +201,6 @@ export function load(app: Application) {
referencedSymbols.clear();
symbolToOwningModule.clear();
},
void 0,
1e9,
);

Expand Down
11 changes: 6 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "typedoc-plugin-missing-exports",
"version": "2.3.0",
"version": "3.0.0",
"description": "Include non-exported types in TypeDoc documentation",
"exports": "./index.js",
"type": "module",
Expand All @@ -10,8 +10,8 @@
"@types/node": "18",
"outdent": "^0.8.0",
"prettier": "3.3.2",
"typedoc": "^0.25.13",
"typescript": "^5.4.5",
"typedoc": "^0.26.0",
"typescript": "^5.5.2",
"vitest": "^1.6.0"
},
"repository": {
Expand All @@ -25,11 +25,12 @@
"typedoc-plugin"
],
"peerDependencies": {
"typedoc": "0.24.x || 0.25.x"
"typedoc": "0.26.x"
},
"scripts": {
"test": "vitest run test/packages.test.ts",
"test:doc": "typedoc --plugin ./index.js --tsconfig ./test/packages",
"build": "tsc"
"build": "tsc",
"lint": "prettier --check ."
}
}
Loading

0 comments on commit fe5fff1

Please sign in to comment.