1 | {
|
2 | "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
|
3 | "extends": "./api-extractor-common-report.json",
|
4 | /**
|
5 | * Configures how API Extractor reports error and warning messages produced during analysis.
|
6 | *
|
7 | * There are three sources of messages: compiler messages, API Extractor messages, and TSDoc messages.
|
8 | *
|
9 | * By setting the 'addToApiReportFile' property to false, API Extractor will report console errors instead of
|
10 | * silently writing errors into the report file. This in turn will cause build failures.
|
11 | */
|
12 | "messages": {
|
13 | "extractorMessageReporting": {
|
14 | "default": {
|
15 | "logLevel": "error",
|
16 | "addToApiReportFile": false
|
17 | },
|
18 | // A documentation comment should contain at most one release tag.
|
19 | "ae-extra-release-tag": {
|
20 | "logLevel": "error",
|
21 | "addToApiReportFile": false
|
22 | },
|
23 | // Reported when an exported API refers to another declaration that is not exported.
|
24 | "ae-forgotten-export": {
|
25 | "logLevel": "error",
|
26 | "addToApiReportFile": false
|
27 | },
|
28 | // A type signature should not reference another types whose release tag is less visible.
|
29 | "ae-incompatible-release-tags": {
|
30 | "logLevel": "error",
|
31 | "addToApiReportFile": true
|
32 | },
|
33 | // Disabled. We don't require that internal members be prefixed with an underscore.
|
34 | "ae-internal-missing-underscore": {
|
35 | "logLevel": "none",
|
36 | "addToApiReportFile": false
|
37 | },
|
38 | // Multiple function overloads should not have @internal tags with other tags.
|
39 | "ae-internal-mixed-release-tag": {
|
40 | "logLevel": "error",
|
41 | "addToApiReportFile": false
|
42 | },
|
43 | // Disabled. We don't require that all exported members have an explicit release tag. While being explicit
|
44 | // is preferred and is a best practice, enabling this requires that we have explicit release tags all the
|
45 | // way down, which makes it very tough to adopt this config for most of our packages.
|
46 | "ae-missing-release-tag": {
|
47 | "logLevel": "none",
|
48 | "addToApiReportFile": false
|
49 | },
|
50 | // The @inheritDoc tag needs a TSDoc declaration reference.
|
51 | "ae-unresolved-inheritdoc-base": {
|
52 | "logLevel": "error",
|
53 | "addToApiReportFile": false
|
54 | },
|
55 | "ae-unresolved-inheritdoc-reference": {
|
56 | "logLevel": "error",
|
57 | "addToApiReportFile": false
|
58 | }
|
59 | }
|
60 | }
|
61 | }
|