Skip to content

Commit e147a02

Browse files
authored
Remove all errors when generating reference doc using api-extractor (#1095)
As is, generating reference doc for v2 sdk produces tons of errors. Most common errors are: 1) Exported type definition depending on unexported type definition 2) Using `@hidden` tag which is unsupported in api-extractor I solve both of these issues here. I selected to use `@alpha` tag for params related types - that would prevent it from showing up in reference docs.
1 parent e463f85 commit e147a02

File tree

12 files changed

+370
-221
lines changed

12 files changed

+370
-221
lines changed

docgen/api-extractor.v2.json

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,25 @@
1010
"enabled": true,
1111
"reportTempFolder": "<projectFolder>/docgen/v2/temp",
1212
"reportFolder": "<projectFolder>/docgen/v2"
13+
},
14+
"messages": {
15+
"compilerMessageReporting": {
16+
"default": {
17+
"logLevel": "warning"
18+
}
19+
},
20+
"extractorMessageReporting": {
21+
"default": {
22+
"logLevel": "warning"
23+
},
24+
"ae-missing-release-tag": {
25+
"logLevel": "none"
26+
}
27+
},
28+
"tsdocMessageReporting": {
29+
"default": {
30+
"logLevel": "error"
31+
}
32+
}
1333
}
1434
}

0 commit comments

Comments
 (0)