-
Notifications
You must be signed in to change notification settings - Fork 311
Expand file tree
/
Copy pathapi-extractor.json
More file actions
40 lines (40 loc) · 1.34 KB
/
api-extractor.json
File metadata and controls
40 lines (40 loc) · 1.34 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
{
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
"projectFolder": ".",
// Must match "types" in package.json — this is what consumers resolve via TS.
"mainEntryPointFilePath": "lib/typescript/src/index.d.ts",
"compiler": {
"tsconfigFilePath": "<projectFolder>/tsconfig.json"
},
"apiReport": {
"enabled": true,
"reportFolder": "<projectFolder>/etc/",
"reportFileName": "<unscopedPackageName>.api.md"
},
// We use typedoc for docs, not api-extractor's doc pipeline.
"docModel": {
"enabled": false
},
"dtsRollup": {
"enabled": false
},
"tsdocMetadata": {
"enabled": false
},
"messages": {
"compilerMessageReporting": {
"default": { "logLevel": "warning" }
},
"extractorMessageReporting": {
"default": { "logLevel": "warning" },
// We don't use @public/@beta/@alpha release tags (not an RN ecosystem convention).
"ae-missing-release-tag": { "logLevel": "none" },
// We use @internal without underscore prefixes — these types will be renamed at GA.
"ae-internal-missing-underscore": { "logLevel": "none", "addToApiReportFile": false }
},
"tsdocMessageReporting": {
// Existing JSDoc uses non-tsdoc conventions (@ignore, JSDoc-style {type} params).
"default": { "logLevel": "none" }
}
}
}