Skip to content

Commit

Permalink
chore: move strip internal option from typedoc to tsconfig
Browse files Browse the repository at this point in the history
In the newest version, typedoc does no longer forward options to TypeScript. stripInternal is a TypeScript option, not a TypeDoc option. Adding it to the main file could be dangerous, though, as some types might be missing.
  • Loading branch information
dbartholomae committed Jan 16, 2021
1 parent 7a79660 commit 3dd039d
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 2 deletions.
6 changes: 6 additions & 0 deletions tsconfig.docs.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"extends": "./tsconfig.build.json",
"compilerOptions": {
"stripInternal": true
}
}
4 changes: 2 additions & 2 deletions typedoc.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"entryPoints": ["./src/index.ts"],
"namedParamName": "props",
"plugin": ["typedoc-plugin-param-names", "typedoc-plugin-sourcefile-url"],
"stripInternal": true,
"tsconfig": "./tsconfig.build.json",
"tsconfig": "./tsconfig.docs.json",
"sourcefile-url-prefix": "https://github.com/dbartholomae/jsx-readme/blob/main/src/"
}

0 comments on commit 3dd039d

Please sign in to comment.