Skip to content

Commit 0529718

Browse files
octogonzoctogonz
committed
Merge remote-tracking branch 'remotes/origin/main' into octogonz/ae-undocumented
# Conflicts: # build-tests/install-test-workspace/workspace/common/pnpm-lock.yaml
2 parents 230c4bc + 9ce7570 commit 0529718

File tree

198 files changed

+3389
-579
lines changed

Some content is hidden

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

198 files changed

+3389
-579
lines changed

‎README.md

+2
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,8 @@ These GitHub repositories provide supplementary resources for Rush Stack:
137137
| [/build-tests/api-extractor-test-02](./build-tests/api-extractor-test-02/) | Building this project is a regression test for api-extractor |
138138
| [/build-tests/api-extractor-test-03](./build-tests/api-extractor-test-03/) | Building this project is a regression test for api-extractor |
139139
| [/build-tests/api-extractor-test-04](./build-tests/api-extractor-test-04/) | Building this project is a regression test for api-extractor |
140+
| [/build-tests/eslint-7-11-test](./build-tests/eslint-7-11-test/) | This project contains a build test to validate ESLint 7.11.0 compatibility with the latest version of @rushstack/eslint-config (and by extension, the ESLint plugin) |
141+
| [/build-tests/eslint-7-7-test](./build-tests/eslint-7-7-test/) | This project contains a build test to validate ESLint 7.7.0 compatibility with the latest version of @rushstack/eslint-config (and by extension, the ESLint plugin) |
140142
| [/build-tests/eslint-7-test](./build-tests/eslint-7-test/) | This project contains a build test to validate ESLint 7 compatibility with the latest version of @rushstack/eslint-config (and by extension, the ESLint plugin) |
141143
| [/build-tests/eslint-8-test](./build-tests/eslint-8-test/) | This project contains a build test to validate ESLint 8 compatibility with the latest version of @rushstack/eslint-config (and by extension, the ESLint plugin) |
142144
| [/build-tests/hashed-folder-copy-plugin-webpack4-test](./build-tests/hashed-folder-copy-plugin-webpack4-test/) | Building this project exercises @rushstack/hashed-folder-copy-plugin with Webpack 4. |

‎apps/api-documenter/CHANGELOG.json

+35
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,41 @@
11
{
22
"name": "@microsoft/api-documenter",
33
"entries": [
4+
{
5+
"version": "7.23.8",
6+
"tag": "@microsoft/api-documenter_v7.23.8",
7+
"date": "Sat, 30 Sep 2023 00:20:51 GMT",
8+
"comments": {
9+
"patch": [
10+
{
11+
"comment": "Add notes for @alpha items when encountered. Mimics the existing behavior for @beta items."
12+
}
13+
],
14+
"dependency": [
15+
{
16+
"comment": "Updating dependency \"@rushstack/heft\" to `0.62.2`"
17+
}
18+
]
19+
}
20+
},
21+
{
22+
"version": "7.23.7",
23+
"tag": "@microsoft/api-documenter_v7.23.7",
24+
"date": "Thu, 28 Sep 2023 20:53:17 GMT",
25+
"comments": {
26+
"dependency": [
27+
{
28+
"comment": "Updating dependency \"@microsoft/api-extractor-model\" to `7.28.2`"
29+
},
30+
{
31+
"comment": "Updating dependency \"@rushstack/node-core-library\" to `3.61.0`"
32+
},
33+
{
34+
"comment": "Updating dependency \"@rushstack/heft\" to `0.62.1`"
35+
}
36+
]
37+
}
38+
},
439
{
540
"version": "7.23.6",
641
"tag": "@microsoft/api-documenter_v7.23.6",

‎apps/api-documenter/CHANGELOG.md

+13-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,18 @@
11
# Change Log - @microsoft/api-documenter
22

3-
This log was last generated on Wed, 27 Sep 2023 00:21:38 GMT and should not be manually modified.
3+
This log was last generated on Sat, 30 Sep 2023 00:20:51 GMT and should not be manually modified.
4+
5+
## 7.23.8
6+
Sat, 30 Sep 2023 00:20:51 GMT
7+
8+
### Patches
9+
10+
- Add notes for @alpha items when encountered. Mimics the existing behavior for @beta items.
11+
12+
## 7.23.7
13+
Thu, 28 Sep 2023 20:53:17 GMT
14+
15+
_Version update only_
416

517
## 7.23.6
618
Wed, 27 Sep 2023 00:21:38 GMT

‎apps/api-documenter/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@microsoft/api-documenter",
3-
"version": "7.23.6",
3+
"version": "7.23.8",
44
"description": "Read JSON files from api-extractor, generate documentation pages",
55
"repository": {
66
"type": "git",

‎apps/api-documenter/src/documenters/MarkdownDocumenter.ts

+21-4
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,9 @@ export class MarkdownDocumenter {
173173
}
174174

175175
if (ApiReleaseTagMixin.isBaseClassOf(apiItem)) {
176-
if (apiItem.releaseTag === ReleaseTag.Beta) {
176+
if (apiItem.releaseTag === ReleaseTag.Alpha) {
177+
this._writeAlphaWarning(output);
178+
} else if (apiItem.releaseTag === ReleaseTag.Beta) {
177179
this._writeBetaWarning(output);
178180
}
179181
}
@@ -1000,10 +1002,13 @@ export class MarkdownDocumenter {
10001002
const section: DocSection = new DocSection({ configuration });
10011003

10021004
if (ApiReleaseTagMixin.isBaseClassOf(apiItem)) {
1003-
if (apiItem.releaseTag === ReleaseTag.Beta) {
1005+
if (apiItem.releaseTag === ReleaseTag.Alpha || apiItem.releaseTag === ReleaseTag.Beta) {
10041006
section.appendNodesInParagraph([
10051007
new DocEmphasisSpan({ configuration, bold: true, italic: true }, [
1006-
new DocPlainText({ configuration, text: '(BETA)' })
1008+
new DocPlainText({
1009+
configuration,
1010+
text: `(${apiItem.releaseTag === ReleaseTag.Alpha ? 'ALPHA' : 'BETA'})`
1011+
})
10071012
]),
10081013
new DocPlainText({ configuration, text: ' ' })
10091014
]);
@@ -1152,10 +1157,22 @@ export class MarkdownDocumenter {
11521157
}
11531158
}
11541159

1160+
private _writeAlphaWarning(output: DocSection): void {
1161+
const configuration: TSDocConfiguration = this._tsdocConfiguration;
1162+
const betaWarning: string =
1163+
'This API is provided as an alpha preview for developers and may change' +
1164+
' based on feedback that we receive. Do not use this API in a production environment.';
1165+
output.appendNode(
1166+
new DocNoteBox({ configuration }, [
1167+
new DocParagraph({ configuration }, [new DocPlainText({ configuration, text: betaWarning })])
1168+
])
1169+
);
1170+
}
1171+
11551172
private _writeBetaWarning(output: DocSection): void {
11561173
const configuration: TSDocConfiguration = this._tsdocConfiguration;
11571174
const betaWarning: string =
1158-
'This API is provided as a preview for developers and may change' +
1175+
'This API is provided as a beta preview for developers and may change' +
11591176
' based on feedback that we receive. Do not use this API in a production environment.';
11601177
output.appendNode(
11611178
new DocNoteBox({ configuration }, [

‎apps/api-documenter/src/documenters/YamlDocumenter.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -430,7 +430,7 @@ export class YamlDocumenter {
430430
}
431431

432432
if (ApiReleaseTagMixin.isBaseClassOf(apiItem)) {
433-
if (apiItem.releaseTag === ReleaseTag.Beta) {
433+
if (apiItem.releaseTag === ReleaseTag.Alpha || apiItem.releaseTag === ReleaseTag.Beta) {
434434
yamlItem.isPreview = true;
435435
}
436436
}

‎apps/api-extractor/CHANGELOG.json

+27
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,33 @@
11
{
22
"name": "@microsoft/api-extractor",
33
"entries": [
4+
{
5+
"version": "7.37.3",
6+
"tag": "@microsoft/api-extractor_v7.37.3",
7+
"date": "Sat, 30 Sep 2023 00:20:51 GMT",
8+
"comments": {
9+
"patch": [
10+
{
11+
"comment": "Don't strip out @alpha items when generating API reports."
12+
}
13+
]
14+
}
15+
},
16+
{
17+
"version": "7.37.2",
18+
"tag": "@microsoft/api-extractor_v7.37.2",
19+
"date": "Thu, 28 Sep 2023 20:53:16 GMT",
20+
"comments": {
21+
"dependency": [
22+
{
23+
"comment": "Updating dependency \"@microsoft/api-extractor-model\" to `7.28.2`"
24+
},
25+
{
26+
"comment": "Updating dependency \"@rushstack/node-core-library\" to `3.61.0`"
27+
}
28+
]
29+
}
30+
},
431
{
532
"version": "7.37.1",
633
"tag": "@microsoft/api-extractor_v7.37.1",

‎apps/api-extractor/CHANGELOG.md

+13-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,18 @@
11
# Change Log - @microsoft/api-extractor
22

3-
This log was last generated on Tue, 26 Sep 2023 09:30:33 GMT and should not be manually modified.
3+
This log was last generated on Sat, 30 Sep 2023 00:20:51 GMT and should not be manually modified.
4+
5+
## 7.37.3
6+
Sat, 30 Sep 2023 00:20:51 GMT
7+
8+
### Patches
9+
10+
- Don't strip out @alpha items when generating API reports.
11+
12+
## 7.37.2
13+
Thu, 28 Sep 2023 20:53:16 GMT
14+
15+
_Version update only_
416

517
## 7.37.1
618
Tue, 26 Sep 2023 09:30:33 GMT

‎apps/api-extractor/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@microsoft/api-extractor",
3-
"version": "7.37.1",
3+
"version": "7.37.3",
44
"description": "Analyze the exported API for a TypeScript library and generate reviews, documentation, and .d.ts rollups",
55
"keywords": [
66
"typescript",

‎apps/api-extractor/src/generators/ApiModelGenerator.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -176,8 +176,8 @@ export class ApiModelGenerator {
176176

177177
const apiItemMetadata: ApiItemMetadata = this._collector.fetchApiItemMetadata(astDeclaration);
178178
const releaseTag: ReleaseTag = apiItemMetadata.effectiveReleaseTag;
179-
if (releaseTag === ReleaseTag.Internal || releaseTag === ReleaseTag.Alpha) {
180-
return; // trim out items marked as "@internal" or "@alpha"
179+
if (releaseTag === ReleaseTag.Internal) {
180+
return; // trim out items marked as "@internal"
181181
}
182182

183183
switch (astDeclaration.declaration.kind) {

‎apps/heft/CHANGELOG.json

+33
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,39 @@
11
{
22
"name": "@rushstack/heft",
33
"entries": [
4+
{
5+
"version": "0.62.2",
6+
"tag": "@rushstack/heft_v0.62.2",
7+
"date": "Sat, 30 Sep 2023 00:20:51 GMT",
8+
"comments": {
9+
"dependency": [
10+
{
11+
"comment": "Updating dependency \"@microsoft/api-extractor\" to `7.37.3`"
12+
}
13+
]
14+
}
15+
},
16+
{
17+
"version": "0.62.1",
18+
"tag": "@rushstack/heft_v0.62.1",
19+
"date": "Thu, 28 Sep 2023 20:53:17 GMT",
20+
"comments": {
21+
"dependency": [
22+
{
23+
"comment": "Updating dependency \"@rushstack/heft-config-file\" to `0.14.2`"
24+
},
25+
{
26+
"comment": "Updating dependency \"@rushstack/node-core-library\" to `3.61.0`"
27+
},
28+
{
29+
"comment": "Updating dependency \"@rushstack/operation-graph\" to `0.2.0`"
30+
},
31+
{
32+
"comment": "Updating dependency \"@microsoft/api-extractor\" to `7.37.2`"
33+
}
34+
]
35+
}
36+
},
437
{
538
"version": "0.62.0",
639
"tag": "@rushstack/heft_v0.62.0",

‎apps/heft/CHANGELOG.md

+11-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,16 @@
11
# Change Log - @rushstack/heft
22

3-
This log was last generated on Wed, 27 Sep 2023 00:21:38 GMT and should not be manually modified.
3+
This log was last generated on Sat, 30 Sep 2023 00:20:51 GMT and should not be manually modified.
4+
5+
## 0.62.2
6+
Sat, 30 Sep 2023 00:20:51 GMT
7+
8+
_Version update only_
9+
10+
## 0.62.1
11+
Thu, 28 Sep 2023 20:53:17 GMT
12+
13+
_Version update only_
414

515
## 0.62.0
616
Wed, 27 Sep 2023 00:21:38 GMT

‎apps/heft/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@rushstack/heft",
3-
"version": "0.62.0",
3+
"version": "0.62.2",
44
"description": "Build all your JavaScript projects the same way: A way that works.",
55
"keywords": [
66
"toolchain",

‎apps/lockfile-explorer/CHANGELOG.json

+27
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,33 @@
11
{
22
"name": "@rushstack/lockfile-explorer",
33
"entries": [
4+
{
5+
"version": "1.2.8",
6+
"tag": "@rushstack/lockfile-explorer_v1.2.8",
7+
"date": "Sat, 30 Sep 2023 00:20:51 GMT",
8+
"comments": {
9+
"dependency": [
10+
{
11+
"comment": "Updating dependency \"@rushstack/heft\" to `0.62.2`"
12+
}
13+
]
14+
}
15+
},
16+
{
17+
"version": "1.2.7",
18+
"tag": "@rushstack/lockfile-explorer_v1.2.7",
19+
"date": "Thu, 28 Sep 2023 20:53:17 GMT",
20+
"comments": {
21+
"dependency": [
22+
{
23+
"comment": "Updating dependency \"@rushstack/node-core-library\" to `3.61.0`"
24+
},
25+
{
26+
"comment": "Updating dependency \"@rushstack/heft\" to `0.62.1`"
27+
}
28+
]
29+
}
30+
},
431
{
532
"version": "1.2.6",
633
"tag": "@rushstack/lockfile-explorer_v1.2.6",

‎apps/lockfile-explorer/CHANGELOG.md

+11-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,16 @@
11
# Change Log - @rushstack/lockfile-explorer
22

3-
This log was last generated on Wed, 27 Sep 2023 00:21:38 GMT and should not be manually modified.
3+
This log was last generated on Sat, 30 Sep 2023 00:20:51 GMT and should not be manually modified.
4+
5+
## 1.2.8
6+
Sat, 30 Sep 2023 00:20:51 GMT
7+
8+
_Version update only_
9+
10+
## 1.2.7
11+
Thu, 28 Sep 2023 20:53:17 GMT
12+
13+
_Version update only_
414

515
## 1.2.6
616
Wed, 27 Sep 2023 00:21:38 GMT

‎apps/lockfile-explorer/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@rushstack/lockfile-explorer",
3-
"version": "1.2.6",
3+
"version": "1.2.8",
44
"description": "Rush Lockfile Explorer: The UI for solving version conflicts quickly in a large monorepo",
55
"keywords": [
66
"conflict",

‎apps/rundown/CHANGELOG.json

+27
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,33 @@
11
{
22
"name": "@rushstack/rundown",
33
"entries": [
4+
{
5+
"version": "1.1.8",
6+
"tag": "@rushstack/rundown_v1.1.8",
7+
"date": "Sat, 30 Sep 2023 00:20:51 GMT",
8+
"comments": {
9+
"dependency": [
10+
{
11+
"comment": "Updating dependency \"@rushstack/heft\" to `0.62.2`"
12+
}
13+
]
14+
}
15+
},
16+
{
17+
"version": "1.1.7",
18+
"tag": "@rushstack/rundown_v1.1.7",
19+
"date": "Thu, 28 Sep 2023 20:53:17 GMT",
20+
"comments": {
21+
"dependency": [
22+
{
23+
"comment": "Updating dependency \"@rushstack/node-core-library\" to `3.61.0`"
24+
},
25+
{
26+
"comment": "Updating dependency \"@rushstack/heft\" to `0.62.1`"
27+
}
28+
]
29+
}
30+
},
431
{
532
"version": "1.1.6",
633
"tag": "@rushstack/rundown_v1.1.6",

‎apps/rundown/CHANGELOG.md

+11-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,16 @@
11
# Change Log - @rushstack/rundown
22

3-
This log was last generated on Wed, 27 Sep 2023 00:21:39 GMT and should not be manually modified.
3+
This log was last generated on Sat, 30 Sep 2023 00:20:51 GMT and should not be manually modified.
4+
5+
## 1.1.8
6+
Sat, 30 Sep 2023 00:20:51 GMT
7+
8+
_Version update only_
9+
10+
## 1.1.7
11+
Thu, 28 Sep 2023 20:53:17 GMT
12+
13+
_Version update only_
414

515
## 1.1.6
616
Wed, 27 Sep 2023 00:21:39 GMT

‎apps/rundown/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@rushstack/rundown",
3-
"version": "1.1.6",
3+
"version": "1.1.8",
44
"description": "Detect load time regressions by running an app, tracing require() calls, and generating a deterministic report",
55
"repository": {
66
"type": "git",

0 commit comments

Comments
 (0)