File tree Expand file tree Collapse file tree 4 files changed +24
-9
lines changed Expand file tree Collapse file tree 4 files changed +24
-9
lines changed Original file line number Diff line number Diff line change @@ -68,8 +68,7 @@ $ typedoc --html <path/to/documentation/>
68
68
```
69
69
70
70
Specifies the location the html documentation should be written to. The HTML
71
- output produced by running TypeDoc on itself can be seen at {@link "TypeDoc
72
- API"}
71
+ output produced by running TypeDoc on itself can be seen at {@link "TypeDoc API"}
73
72
74
73
This option is an output shortcut. If specified, the [ outputs] ( #outputs ) option
75
74
will be overwritten by this option and any other specified output shortcuts.
Original file line number Diff line number Diff line change 1
- import { type Project , tempdirProject } from "@typestrong/fs-fixture-builder" ;
1
+ import { tempdirProject } from "@typestrong/fs-fixture-builder" ;
2
2
import { deepStrictEqual as equal , ok } from "assert" ;
3
3
import { join } from "path" ;
4
4
import { Application , EntryPointStrategy } from "../../index.js" ;
5
5
6
6
describe ( "Entry Points" , ( ) => {
7
- let fixture : Project ;
8
- let tsconfig : string ;
7
+ using fixture = tempdirProject ( ) ;
8
+ const tsconfig = join ( fixture . cwd , "tsconfig.json" ) ;
9
9
10
10
beforeEach ( ( ) => {
11
- fixture = tempdirProject ( ) ;
12
- tsconfig = join ( fixture . cwd , "tsconfig.json" ) ;
13
-
11
+ fixture . files . length = 0 ;
14
12
fixture . addJsonFile ( "tsconfig.json" , {
15
13
include : [ "." ] ,
16
14
} ) ;
Original file line number Diff line number Diff line change @@ -176,7 +176,7 @@ describe("fs.ts", () => {
176
176
} ) ;
177
177
178
178
describe ( "inferPackageEntryPointPaths" , ( ) => {
179
- const fixture = tempdirProject ( ) ;
179
+ using fixture = tempdirProject ( ) ;
180
180
afterEach ( ( ) => fixture . rm ( ) ) ;
181
181
const packagePath = ( path : string ) =>
182
182
normalizePath ( join ( fixture . cwd , path ) ) ;
Original file line number Diff line number Diff line change @@ -3,6 +3,9 @@ import { join } from "path";
3
3
import ts from "typescript" ;
4
4
import * as defaults from "../../../lib/utils/options/tsdoc-defaults.js" ;
5
5
import { fileURLToPath } from "url" ;
6
+ import { unique } from "../../../lib/utils/array.js" ;
7
+ import { readdirSync } from "fs" ;
8
+ import { TYPEDOC_ROOT } from "../../../lib/utils/general.js" ;
6
9
7
10
describe ( "tsdoc-defaults.ts" , ( ) => {
8
11
const tsdoc = ts . readConfigFile (
@@ -59,4 +62,19 @@ describe("tsdoc-defaults.ts", () => {
59
62
60
63
equal ( tsdocTags , typedocTags ) ;
61
64
} ) ;
65
+
66
+ // GERRIT Failing currently, ~20 tags to document still
67
+ it . skip ( "Should only include tags which are documented on the website" , ( ) => {
68
+ const tags = unique ( [
69
+ ...defaults . blockTags ,
70
+ ...defaults . modifierTags ,
71
+ ...defaults . inlineTags ,
72
+ ] ) . sort ( ) ;
73
+
74
+ const documentedTags = readdirSync ( TYPEDOC_ROOT + "/site/tags" )
75
+ . map ( ( file ) => "@" + file . replace ( ".md" , "" ) )
76
+ . sort ( ) ;
77
+
78
+ equal ( tags , documentedTags ) ;
79
+ } ) ;
62
80
} ) ;
You can’t perform that action at this time.
0 commit comments