Skip to content

Commit 2809dd1

Browse files
JosmithrJosmithr
committed
Merge branch 'main' into dont-mark-external-items-as-undocumented
2 parents 87a8c40 + a6b1ff4 commit 2809dd1

File tree

338 files changed

+10717
-5783
lines changed

Some content is hidden

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

338 files changed

+10717
-5783
lines changed

‎.vscode/launch.json

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,17 @@
1616
"--nolazy",
1717
"--inspect-brk"
1818
],
19+
"skipFiles": ["<node_internals>/**"],
20+
// Don't scan the file system on startup
21+
"outFiles": [],
22+
// Evaluate source maps for all workspace-local files
23+
"resolveSourceMapLocations": ["${workspaceFolder}/**", "!**/node_modules/**"],
1924
"env": {
2025
"NODE_ENV": "development"
2126
},
22-
"sourceMaps": true
27+
"sourceMaps": true,
28+
"console": "integratedTerminal",
29+
"internalConsoleOptions": "neverOpen"
2330
},
2431
{
2532
"type": "node",

‎apps/api-documenter/CHANGELOG.json

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,77 @@
11
{
22
"name": "@microsoft/api-documenter",
33
"entries": [
4+
{
5+
"version": "7.23.31",
6+
"tag": "@microsoft/api-documenter_v7.23.31",
7+
"date": "Sat, 24 Feb 2024 23:02:51 GMT",
8+
"comments": {
9+
"dependency": [
10+
{
11+
"comment": "Updating dependency \"@rushstack/terminal\" to `0.10.0`"
12+
},
13+
{
14+
"comment": "Updating dependency \"@rushstack/ts-command-line\" to `4.17.4`"
15+
},
16+
{
17+
"comment": "Updating dependency \"@rushstack/heft\" to `0.65.5`"
18+
}
19+
]
20+
}
21+
},
22+
{
23+
"version": "7.23.30",
24+
"tag": "@microsoft/api-documenter_v7.23.30",
25+
"date": "Thu, 22 Feb 2024 01:36:09 GMT",
26+
"comments": {
27+
"dependency": [
28+
{
29+
"comment": "Updating dependency \"@rushstack/heft\" to `0.65.4`"
30+
}
31+
]
32+
}
33+
},
34+
{
35+
"version": "7.23.29",
36+
"tag": "@microsoft/api-documenter_v7.23.29",
37+
"date": "Wed, 21 Feb 2024 21:45:28 GMT",
38+
"comments": {
39+
"patch": [
40+
{
41+
"comment": "Replace the dependency on the `colors` package with `Colorize` from `@rushstack/terminal`."
42+
}
43+
],
44+
"dependency": [
45+
{
46+
"comment": "Updating dependency \"@microsoft/api-extractor-model\" to `7.28.13`"
47+
},
48+
{
49+
"comment": "Updating dependency \"@rushstack/node-core-library\" to `4.0.2`"
50+
},
51+
{
52+
"comment": "Updating dependency \"@rushstack/terminal\" to `0.9.0`"
53+
},
54+
{
55+
"comment": "Updating dependency \"@rushstack/ts-command-line\" to `4.17.3`"
56+
},
57+
{
58+
"comment": "Updating dependency \"@rushstack/heft\" to `0.65.3`"
59+
}
60+
]
61+
}
62+
},
63+
{
64+
"version": "7.23.28",
65+
"tag": "@microsoft/api-documenter_v7.23.28",
66+
"date": "Wed, 21 Feb 2024 08:55:47 GMT",
67+
"comments": {
68+
"dependency": [
69+
{
70+
"comment": "Updating dependency \"@rushstack/heft\" to `0.65.2`"
71+
}
72+
]
73+
}
74+
},
475
{
576
"version": "7.23.27",
677
"tag": "@microsoft/api-documenter_v7.23.27",

‎apps/api-documenter/CHANGELOG.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,28 @@
11
# Change Log - @microsoft/api-documenter
22

3-
This log was last generated on Tue, 20 Feb 2024 21:45:10 GMT and should not be manually modified.
3+
This log was last generated on Sat, 24 Feb 2024 23:02:51 GMT and should not be manually modified.
4+
5+
## 7.23.31
6+
Sat, 24 Feb 2024 23:02:51 GMT
7+
8+
_Version update only_
9+
10+
## 7.23.30
11+
Thu, 22 Feb 2024 01:36:09 GMT
12+
13+
_Version update only_
14+
15+
## 7.23.29
16+
Wed, 21 Feb 2024 21:45:28 GMT
17+
18+
### Patches
19+
20+
- Replace the dependency on the `colors` package with `Colorize` from `@rushstack/terminal`.
21+
22+
## 7.23.28
23+
Wed, 21 Feb 2024 08:55:47 GMT
24+
25+
_Version update only_
426

527
## 7.23.27
628
Tue, 20 Feb 2024 21:45:10 GMT

‎apps/api-documenter/package.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@microsoft/api-documenter",
3-
"version": "7.23.27",
3+
"version": "7.23.31",
44
"description": "Read JSON files from api-extractor, generate documentation pages",
55
"repository": {
66
"type": "git",
@@ -23,15 +23,15 @@
2323
"@microsoft/api-extractor-model": "workspace:*",
2424
"@microsoft/tsdoc": "0.14.2",
2525
"@rushstack/node-core-library": "workspace:*",
26+
"@rushstack/terminal": "workspace:*",
2627
"@rushstack/ts-command-line": "workspace:*",
27-
"colors": "~1.2.1",
2828
"js-yaml": "~3.13.1",
2929
"resolve": "~1.22.1"
3030
},
3131
"devDependencies": {
3232
"@rushstack/heft": "workspace:*",
33-
"local-node-rig": "workspace:*",
3433
"@types/js-yaml": "3.12.1",
35-
"@types/resolve": "1.20.2"
34+
"@types/resolve": "1.20.2",
35+
"local-node-rig": "workspace:*"
3636
}
3737
}

‎apps/api-documenter/src/cli/BaseAction.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33

44
import * as path from 'path';
55
import type * as tsdoc from '@microsoft/tsdoc';
6-
import colors from 'colors/safe';
76

87
import {
98
CommandLineAction,
@@ -18,6 +17,7 @@ import {
1817
ApiDocumentedItem,
1918
type IResolveDeclarationReferenceResult
2019
} from '@microsoft/api-extractor-model';
20+
import { Colorize } from '@rushstack/terminal';
2121

2222
export interface IBuildApiModelResult {
2323
apiModel: ApiModel;
@@ -94,7 +94,7 @@ export abstract class BaseAction extends CommandLineAction {
9494

9595
if (result.errorMessage) {
9696
console.log(
97-
colors.yellow(
97+
Colorize.yellow(
9898
`Warning: Unresolved @inheritDoc tag for ${apiItem.displayName}: ` + result.errorMessage
9999
)
100100
);

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
22
// See LICENSE in the project root for license information.
33

4-
import colors from 'colors';
54
import * as path from 'path';
65
import yaml = require('js-yaml');
76

87
import type { ApiModel } from '@microsoft/api-extractor-model';
98
import { FileSystem } from '@rushstack/node-core-library';
9+
import { Colorize } from '@rushstack/terminal';
1010

1111
import type { IYamlTocItem } from '../yaml/IYamlTocFile';
1212
import type { IYamlItem } from '../yaml/IYamlApiFile';
@@ -59,7 +59,7 @@ export class OfficeYamlDocumenter extends YamlDocumenter {
5959
// After we generate everything, check for any unused snippets
6060
console.log();
6161
for (const apiName of Object.keys(this._snippets)) {
62-
console.error(colors.yellow('Warning: Unused snippet ' + apiName));
62+
console.error(Colorize.yellow('Warning: Unused snippet ' + apiName));
6363
}
6464
}
6565

‎apps/api-documenter/src/markdown/CustomMarkdownEmitter.ts

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
22
// See LICENSE in the project root for license information.
33

4-
import colors from 'colors';
5-
64
import type { DocNode, DocLinkTag, StringBuilder } from '@microsoft/tsdoc';
75
import type { ApiModel, IResolveDeclarationReferenceResult, ApiItem } from '@microsoft/api-extractor-model';
6+
import { Colorize } from '@rushstack/terminal';
87

98
import { CustomDocNodeKind } from '../nodes/CustomDocNodeKind';
109
import type { DocHeading } from '../nodes/DocHeading';
@@ -183,12 +182,12 @@ export class CustomMarkdownEmitter extends MarkdownEmitter {
183182
context.writer.write(encodedLinkText);
184183
context.writer.write(`](${filename!})`);
185184
} else {
186-
console.log(colors.yellow('WARNING: Unable to determine link text'));
185+
console.log(Colorize.yellow('WARNING: Unable to determine link text'));
187186
}
188187
}
189188
} else if (result.errorMessage) {
190189
console.log(
191-
colors.yellow(
190+
Colorize.yellow(
192191
`WARNING: Unable to resolve reference "${docLinkTag.codeDestination!.emitAsTsdoc()}": ` +
193192
result.errorMessage
194193
)

‎apps/api-documenter/src/start.ts

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,19 @@
22
// See LICENSE in the project root for license information.
33

44
import * as os from 'os';
5-
import colors from 'colors';
65

76
import { PackageJsonLookup } from '@rushstack/node-core-library';
7+
import { Colorize } from '@rushstack/terminal';
88

99
import { ApiDocumenterCommandLine } from './cli/ApiDocumenterCommandLine';
1010

1111
const myPackageVersion: string = PackageJsonLookup.loadOwnPackageJson(__dirname).version;
1212

1313
console.log(
1414
os.EOL +
15-
colors.bold(`api-documenter ${myPackageVersion} ` + colors.cyan(' - https://api-extractor.com/') + os.EOL)
15+
Colorize.bold(
16+
`api-documenter ${myPackageVersion} ` + Colorize.cyan(' - https://api-extractor.com/') + os.EOL
17+
)
1618
);
1719

1820
const parser: ApiDocumenterCommandLine = new ApiDocumenterCommandLine();

‎apps/api-extractor/CHANGELOG.json

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,64 @@
11
{
22
"name": "@microsoft/api-extractor",
33
"entries": [
4+
{
5+
"version": "7.41.0",
6+
"tag": "@microsoft/api-extractor_v7.41.0",
7+
"date": "Sat, 24 Feb 2024 23:02:51 GMT",
8+
"comments": {
9+
"minor": [
10+
{
11+
"comment": "Replace const enums with conventional enums to allow for compatibility with JavaScript consumers."
12+
}
13+
],
14+
"dependency": [
15+
{
16+
"comment": "Updating dependency \"@rushstack/terminal\" to `0.10.0`"
17+
},
18+
{
19+
"comment": "Updating dependency \"@rushstack/ts-command-line\" to `4.17.4`"
20+
}
21+
]
22+
}
23+
},
24+
{
25+
"version": "7.40.6",
26+
"tag": "@microsoft/api-extractor_v7.40.6",
27+
"date": "Wed, 21 Feb 2024 21:45:28 GMT",
28+
"comments": {
29+
"patch": [
30+
{
31+
"comment": "Replace the dependency on the `colors` package with `Colorize` from `@rushstack/terminal`."
32+
}
33+
],
34+
"dependency": [
35+
{
36+
"comment": "Updating dependency \"@microsoft/api-extractor-model\" to `7.28.13`"
37+
},
38+
{
39+
"comment": "Updating dependency \"@rushstack/node-core-library\" to `4.0.2`"
40+
},
41+
{
42+
"comment": "Updating dependency \"@rushstack/terminal\" to `0.9.0`"
43+
},
44+
{
45+
"comment": "Updating dependency \"@rushstack/ts-command-line\" to `4.17.3`"
46+
}
47+
]
48+
}
49+
},
50+
{
51+
"version": "7.40.5",
52+
"tag": "@microsoft/api-extractor_v7.40.5",
53+
"date": "Wed, 21 Feb 2024 08:55:47 GMT",
54+
"comments": {
55+
"patch": [
56+
{
57+
"comment": "Fix an issue where imports were trimmed from external packages based when generating .d.ts rollups"
58+
}
59+
]
60+
}
61+
},
462
{
563
"version": "7.40.4",
664
"tag": "@microsoft/api-extractor_v7.40.4",

‎apps/api-extractor/CHANGELOG.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,27 @@
11
# Change Log - @microsoft/api-extractor
22

3-
This log was last generated on Tue, 20 Feb 2024 21:45:10 GMT and should not be manually modified.
3+
This log was last generated on Sat, 24 Feb 2024 23:02:51 GMT and should not be manually modified.
4+
5+
## 7.41.0
6+
Sat, 24 Feb 2024 23:02:51 GMT
7+
8+
### Minor changes
9+
10+
- Replace const enums with conventional enums to allow for compatibility with JavaScript consumers.
11+
12+
## 7.40.6
13+
Wed, 21 Feb 2024 21:45:28 GMT
14+
15+
### Patches
16+
17+
- Replace the dependency on the `colors` package with `Colorize` from `@rushstack/terminal`.
18+
19+
## 7.40.5
20+
Wed, 21 Feb 2024 08:55:47 GMT
21+
22+
### Patches
23+
24+
- Fix an issue where imports were trimmed from external packages based when generating .d.ts rollups
425

526
## 7.40.4
627
Tue, 20 Feb 2024 21:45:10 GMT

‎apps/api-extractor/package.json

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@microsoft/api-extractor",
3-
"version": "7.40.4",
3+
"version": "7.41.0",
44
"description": "Analyze the exported API for a TypeScript library and generate reviews, documentation, and .d.ts rollups",
55
"keywords": [
66
"typescript",
@@ -38,26 +38,26 @@
3838
},
3939
"dependencies": {
4040
"@microsoft/api-extractor-model": "workspace:*",
41-
"@microsoft/tsdoc": "0.14.2",
4241
"@microsoft/tsdoc-config": "~0.16.1",
42+
"@microsoft/tsdoc": "0.14.2",
4343
"@rushstack/node-core-library": "workspace:*",
4444
"@rushstack/rig-package": "workspace:*",
45+
"@rushstack/terminal": "workspace:*",
4546
"@rushstack/ts-command-line": "workspace:*",
46-
"colors": "~1.2.1",
4747
"lodash": "~4.17.15",
4848
"resolve": "~1.22.1",
4949
"semver": "~7.5.4",
5050
"source-map": "~0.6.1",
5151
"typescript": "5.3.3"
5252
},
5353
"devDependencies": {
54-
"local-eslint-config": "workspace:*",
55-
"@rushstack/heft": "0.64.0",
56-
"@rushstack/heft-node-rig": "2.4.0",
54+
"@rushstack/heft-node-rig": "2.4.16",
55+
"@rushstack/heft": "0.65.4",
5756
"@types/heft-jest": "1.0.1",
5857
"@types/lodash": "4.14.116",
5958
"@types/node": "18.17.15",
6059
"@types/resolve": "1.20.2",
61-
"@types/semver": "7.5.0"
60+
"@types/semver": "7.5.0",
61+
"local-eslint-config": "workspace:*"
6262
}
6363
}

0 commit comments

Comments
 (0)