Skip to content

Commit d9b53e6

Browse files
JosmithrJosmithr
authored
build: Disable ae-undocumented rule until api-extractor bug is fixed (#18843)
API-Extractor bug: microsoft/rushstack#3462
1 parent b38436d commit d9b53e6

File tree

91 files changed

+90
-786
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

91 files changed

+90
-786
lines changed

‎azure/packages/azure-client/api-extractor.json

+1-9
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,4 @@
11
{
22
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3-
"extends": "../../../common/build/build-common/api-extractor-base.json",
4-
"messages": {
5-
"extractorMessageReporting": {
6-
// TODO: Add missing documentation and remove this rule override
7-
"ae-undocumented": {
8-
"logLevel": "none"
9-
}
10-
}
11-
}
3+
"extends": "../../../common/build/build-common/api-extractor-base.json"
124
}

‎build-tools/api-extractor-base.json

-4
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,6 @@
88
// TODO: Consider enabling this in the future.
99
"ae-missing-release-tag": {
1010
"logLevel": "none"
11-
},
12-
// TODO: Add missing documentation and remove this rule override
13-
"ae-undocumented": {
14-
"logLevel": "none"
1511
}
1612
}
1713
}

‎common/build/build-common/api-extractor-base.json

+3-2
Original file line numberDiff line numberDiff line change
@@ -158,8 +158,9 @@
158158

159159
// Require documentation on all package-exported API items.
160160
"ae-undocumented": {
161-
"logLevel": "error",
162-
"addToApiReportFile": false
161+
// TODO: re-enable once the following API-Extractor bug has been fixed:
162+
// https://github.com/microsoft/rushstack/issues/3462
163+
"logLevel": "none"
163164
},
164165

165166
// The @inheritDoc tag needs a TSDoc declaration reference.

‎common/lib/common-definitions/api-extractor.json

+1-9
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,4 @@
11
{
22
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3-
"extends": "../../build/build-common/api-extractor-base.json",
4-
"messages": {
5-
"extractorMessageReporting": {
6-
// TODO: Add missing documentation and remove this rule override
7-
"ae-undocumented": {
8-
"logLevel": "none"
9-
}
10-
}
11-
}
3+
"extends": "../../build/build-common/api-extractor-base.json"
124
}

‎common/lib/common-utils/api-extractor.json

+1-9
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,4 @@
11
{
22
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3-
"extends": "../../build/build-common/api-extractor-base.json",
4-
"messages": {
5-
"extractorMessageReporting": {
6-
// TODO: Add missing documentation and remove this rule override
7-
"ae-undocumented": {
8-
"logLevel": "none"
9-
}
10-
}
11-
}
3+
"extends": "../../build/build-common/api-extractor-base.json"
124
}

‎common/lib/protocol-definitions/api-extractor.json

+1-9
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,4 @@
11
{
22
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3-
"extends": "../../build/build-common/api-extractor-base.json",
4-
"messages": {
5-
"extractorMessageReporting": {
6-
// TODO: Add missing documentation and remove this rule override
7-
"ae-undocumented": {
8-
"logLevel": "none"
9-
}
10-
}
11-
}
3+
"extends": "../../build/build-common/api-extractor-base.json"
124
}

‎examples/utils/example-utils/api-extractor.json

+1-9
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,4 @@
11
{
22
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3-
"extends": "../../../common/build/build-common/api-extractor-base.json",
4-
"messages": {
5-
"extractorMessageReporting": {
6-
// TODO: Add missing documentation and remove this rule override
7-
"ae-undocumented": {
8-
"logLevel": "none"
9-
}
10-
}
11-
}
3+
"extends": "../../../common/build/build-common/api-extractor-base.json"
124
}

‎experimental/PropertyDDS/packages/property-dds/api-extractor.json

+1-10
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,4 @@
11
{
22
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3-
"extends": "../../../../common/build/build-common/api-extractor-base.json",
4-
5-
// TODO: Fix violations and remove these rule overrides
6-
"messages": {
7-
"extractorMessageReporting": {
8-
"ae-undocumented": {
9-
"logLevel": "none"
10-
}
11-
}
12-
}
3+
"extends": "../../../../common/build/build-common/api-extractor-base.json"
134
}

‎experimental/dds/attributable-map/api-extractor.json

+1-9
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,4 @@
11
{
22
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3-
"extends": "../../../common/build/build-common/api-extractor-base.json",
4-
// TODO: Fix violations and remove these rule overrides
5-
"messages": {
6-
"extractorMessageReporting": {
7-
"ae-undocumented": {
8-
"logLevel": "none"
9-
}
10-
}
11-
}
3+
"extends": "../../../common/build/build-common/api-extractor-base.json"
124
}

‎experimental/dds/ot/ot/api-extractor.json

+1-9
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,4 @@
11
{
22
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3-
"extends": "../../../../common/build/build-common/api-extractor-base.json",
4-
// TODO: Fix violations and remove these rule overrides
5-
"messages": {
6-
"extractorMessageReporting": {
7-
"ae-undocumented": {
8-
"logLevel": "none"
9-
}
10-
}
11-
}
3+
"extends": "../../../../common/build/build-common/api-extractor-base.json"
124
}

‎experimental/dds/ot/sharejs/json1/api-extractor.json

+1-9
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,4 @@
11
{
22
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3-
"extends": "../../../../../common/build/build-common/api-extractor-base.json",
4-
// TODO: Fix violations and remove these rule overrides
5-
"messages": {
6-
"extractorMessageReporting": {
7-
"ae-undocumented": {
8-
"logLevel": "none"
9-
}
10-
}
11-
}
3+
"extends": "../../../../../common/build/build-common/api-extractor-base.json"
124
}

‎experimental/dds/sequence-deprecated/api-extractor.json

+1-9
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,4 @@
11
{
22
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3-
"extends": "../../../common/build/build-common/api-extractor-base.json",
4-
// This package is deprecated, so there is no real need to fix these.
5-
"messages": {
6-
"extractorMessageReporting": {
7-
"ae-undocumented": {
8-
"logLevel": "none"
9-
}
10-
}
11-
}
3+
"extends": "../../../common/build/build-common/api-extractor-base.json"
124
}

‎experimental/dds/tree/api-extractor.json

-9
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,5 @@
55
"enabled": true,
66
// Note: `tree.api.md` is the file used for the upcoming tree DDS's API report.
77
"reportFileName": "experimental-<unscopedPackageName>.api.md"
8-
},
9-
10-
// This package is effectively deprecated. No need to fix these.
11-
"messages": {
12-
"extractorMessageReporting": {
13-
"ae-undocumented": {
14-
"logLevel": "none"
15-
}
16-
}
178
}
189
}

‎experimental/dds/tree2/api-extractor.json

+1-9
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,4 @@
11
{
22
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3-
"extends": "../../../common/build/build-common/api-extractor-base.json",
4-
"messages": {
5-
"extractorMessageReporting": {
6-
// TODO: Add missing documentation and remove this rule override
7-
"ae-undocumented": {
8-
"logLevel": "none"
9-
}
10-
}
11-
}
3+
"extends": "../../../common/build/build-common/api-extractor-base.json"
124
}

‎experimental/framework/last-edited/api-extractor.json

+1-9
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,4 @@
11
{
22
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3-
"extends": "../../../common/build/build-common/api-extractor-base.json",
4-
"messages": {
5-
"extractorMessageReporting": {
6-
// TODO: Add missing documentation and remove this rule override
7-
"ae-undocumented": {
8-
"logLevel": "none"
9-
}
10-
}
11-
}
3+
"extends": "../../../common/build/build-common/api-extractor-base.json"
124
}

‎experimental/framework/react-inputs/api-extractor.json

+1-9
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,4 @@
11
{
22
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3-
"extends": "../../../common/build/build-common/api-extractor-base.json",
4-
"messages": {
5-
"extractorMessageReporting": {
6-
// TODO: Add missing documentation and remove this rule override
7-
"ae-undocumented": {
8-
"logLevel": "none"
9-
}
10-
}
11-
}
3+
"extends": "../../../common/build/build-common/api-extractor-base.json"
124
}

‎packages/common/client-utils/api-extractor.json

+1-9
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,4 @@
11
{
22
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3-
"extends": "../../../common/build/build-common/api-extractor-base.json",
4-
"messages": {
5-
"extractorMessageReporting": {
6-
// TODO: Add missing documentation and remove this rule override
7-
"ae-undocumented": {
8-
"logLevel": "none"
9-
}
10-
}
11-
}
3+
"extends": "../../../common/build/build-common/api-extractor-base.json"
124
}

‎packages/common/container-definitions/api-extractor.json

+1-9
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,4 @@
11
{
22
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3-
"extends": "../../../common/build/build-common/api-extractor-base.json",
4-
"messages": {
5-
"extractorMessageReporting": {
6-
// TODO: Add missing documentation and remove this rule override
7-
"ae-undocumented": {
8-
"logLevel": "none"
9-
}
10-
}
11-
}
3+
"extends": "../../../common/build/build-common/api-extractor-base.json"
124
}

‎packages/common/core-interfaces/api-extractor.json

+1-9
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,4 @@
11
{
22
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3-
"extends": "../../../common/build/build-common/api-extractor-base.json",
4-
"messages": {
5-
"extractorMessageReporting": {
6-
// TODO: Add missing documentation and remove this rule override
7-
"ae-undocumented": {
8-
"logLevel": "none"
9-
}
10-
}
11-
}
3+
"extends": "../../../common/build/build-common/api-extractor-base.json"
124
}

‎packages/common/core-utils/api-extractor.json

+1-9
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,4 @@
11
{
22
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3-
"extends": "../../../common/build/build-common/api-extractor-base.json",
4-
"messages": {
5-
"extractorMessageReporting": {
6-
// TODO: Add missing documentation and remove this rule override
7-
"ae-undocumented": {
8-
"logLevel": "none"
9-
}
10-
}
11-
}
3+
"extends": "../../../common/build/build-common/api-extractor-base.json"
124
}

‎packages/common/driver-definitions/api-extractor.json

+1-9
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,4 @@
11
{
22
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3-
"extends": "../../../common/build/build-common/api-extractor-base.json",
4-
"messages": {
5-
"extractorMessageReporting": {
6-
// TODO: Add missing documentation and remove this rule override
7-
"ae-undocumented": {
8-
"logLevel": "none"
9-
}
10-
}
11-
}
3+
"extends": "../../../common/build/build-common/api-extractor-base.json"
124
}

‎packages/dds/cell/api-extractor.json

+1-9
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,4 @@
11
{
22
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3-
"extends": "../../../common/build/build-common/api-extractor-base.json",
4-
"messages": {
5-
"extractorMessageReporting": {
6-
// TODO: Add missing documentation and remove this rule override
7-
"ae-undocumented": {
8-
"logLevel": "none"
9-
}
10-
}
11-
}
3+
"extends": "../../../common/build/build-common/api-extractor-base.json"
124
}

‎packages/dds/counter/api-extractor.json

+1-9
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,4 @@
11
{
22
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3-
"extends": "../../../common/build/build-common/api-extractor-base.json",
4-
"messages": {
5-
"extractorMessageReporting": {
6-
// TODO: Add missing documentation and remove this rule override
7-
"ae-undocumented": {
8-
"logLevel": "none"
9-
}
10-
}
11-
}
3+
"extends": "../../../common/build/build-common/api-extractor-base.json"
124
}

‎packages/dds/ink/api-extractor.json

+1-9
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,4 @@
11
{
22
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3-
"extends": "../../../common/build/build-common/api-extractor-base.json",
4-
"messages": {
5-
"extractorMessageReporting": {
6-
// TODO: Add missing documentation and remove this rule override
7-
"ae-undocumented": {
8-
"logLevel": "none"
9-
}
10-
}
11-
}
3+
"extends": "../../../common/build/build-common/api-extractor-base.json"
124
}

‎packages/dds/map/api-extractor.json

+1-9
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,4 @@
11
{
22
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3-
"extends": "../../../common/build/build-common/api-extractor-base.json",
4-
"messages": {
5-
"extractorMessageReporting": {
6-
// TODO: Add missing documentation and remove this rule override
7-
"ae-undocumented": {
8-
"logLevel": "none"
9-
}
10-
}
11-
}
3+
"extends": "../../../common/build/build-common/api-extractor-base.json"
124
}

‎packages/dds/matrix/api-extractor.json

+1-9
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,4 @@
11
{
22
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3-
"extends": "../../../common/build/build-common/api-extractor-base.json",
4-
"messages": {
5-
"extractorMessageReporting": {
6-
// TODO: Add missing documentation and remove this rule override
7-
"ae-undocumented": {
8-
"logLevel": "none"
9-
}
10-
}
11-
}
3+
"extends": "../../../common/build/build-common/api-extractor-base.json"
124
}

‎packages/dds/merge-tree/api-extractor.json

-4
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,6 @@
66
// TODO: Fix violations and remove this rule override
77
"ae-forgotten-export": {
88
"logLevel": "none"
9-
},
10-
// TODO: Add missing documentation and remove this rule override
11-
"ae-undocumented": {
12-
"logLevel": "none"
139
}
1410
}
1511
}

‎packages/dds/ordered-collection/api-extractor.json

+1-9
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,4 @@
11
{
22
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3-
"extends": "../../../common/build/build-common/api-extractor-base.json",
4-
"messages": {
5-
"extractorMessageReporting": {
6-
// TODO: Add missing documentation and remove this rule override
7-
"ae-undocumented": {
8-
"logLevel": "none"
9-
}
10-
}
11-
}
3+
"extends": "../../../common/build/build-common/api-extractor-base.json"
124
}

‎packages/dds/pact-map/api-extractor.json

+1-9
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,4 @@
11
{
22
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3-
"extends": "../../../common/build/build-common/api-extractor-base.json",
4-
"messages": {
5-
"extractorMessageReporting": {
6-
// TODO: Add missing documentation and remove this rule override
7-
"ae-undocumented": {
8-
"logLevel": "none"
9-
}
10-
}
11-
}
3+
"extends": "../../../common/build/build-common/api-extractor-base.json"
124
}

0 commit comments

Comments
 (0)