Skip to content

Commit 84eeaf2

Browse files
octogonzoctogonz
committed
Also update some comments and messages
1 parent 11da69f commit 84eeaf2

6 files changed

Lines changed: 15 additions & 15 deletions

File tree

‎apps/api-extractor/src/api/ConsoleMessageId.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ export const enum ConsoleMessageId {
4444
ApiReportUnchanged = 'console-api-report-unchanged',
4545

4646
/**
47-
* "The API review file has not been set up. Do this by copying ___ to ___ and committing it."
47+
* "The API report file has not been set up. Do this by copying ___ to ___ and committing it."
4848
*/
4949
ApiReportMissing = 'console-api-report-missing'
5050
}

‎apps/api-extractor/src/api/Extractor.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ export interface IExtractorInvokeOptions {
3636
/**
3737
* Indicates that API Extractor is running as part of a local build, e.g. on developer's
3838
* machine. This disables certain validation that would normally be performed
39-
* for a ship/production build. For example, the *.api.md review file is
39+
* for a ship/production build. For example, the *.api.md report file is
4040
* automatically updated in a local build.
4141
*
4242
* The default value is false.
@@ -256,8 +256,8 @@ export class Extractor {
256256
} else {
257257
// NOTE: This warning seems like a nuisance, but it has caught genuine mistakes.
258258
// For example, when projects were moved into category folders, the relative path for
259-
// the API review files ended up in the wrong place.
260-
messageRouter.logError(ConsoleMessageId.ApiReportMissing, `The API review file has not been set up.`
259+
// the API report files ended up in the wrong place.
260+
messageRouter.logError(ConsoleMessageId.ApiReportMissing, `The API report file has not been set up.`
261261
+ ` Do this by copying ${actualApiReportShortPath}`
262262
+ ` to ${expectedApiReportShortPath} and committing it.`);
263263
}

‎apps/api-extractor/src/api/IConfigFile.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ export interface IConfigCompiler {
5353
}
5454

5555
/**
56-
* Configures how the API review files (*.api.md) will be generated.
56+
* Configures how the API report files (*.api.md) will be generated.
5757
*
5858
* @remarks
5959
* This is part of the {@link IConfigFile} structure.
@@ -218,8 +218,8 @@ export interface IConfigMessageReportingRule {
218218
logLevel: ExtractorLogLevel;
219219

220220
/**
221-
* If API Extractor is configured to write an API review file (.api.md), then the message will be written
222-
* inside that file. If the API review file is NOT being written, then the message is instead logged according
221+
* If API Extractor is configured to write an API report file (.api.md), then the message will be written
222+
* inside that file. If the API report file is NOT being written, then the message is instead logged according
223223
* to the `logLevel` option.
224224
*/
225225
addToApiReportFile?: boolean;

‎apps/api-extractor/src/cli/RunAction.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ export class RunAction extends CommandLineAction {
5050
description: 'Indicates that API Extractor is running as part of a local build,'
5151
+ ' e.g. on a developer\'s machine. This disables certain validation that would'
5252
+ ' normally be performed for a ship/production build. For example, the *.api.md'
53-
+ ' review file is automatically copied in a local build.'
53+
+ ' report file is automatically copied in a local build.'
5454
});
5555

5656
this._verboseParameter = this.defineFlagParameter({

‎apps/api-extractor/src/collector/MessageRouter.ts‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -265,8 +265,8 @@ export class MessageRouter {
265265
}
266266

267267
/**
268-
* This is used when writing the API review file. It looks up any messages that were configured to get emitted
269-
* in the API review file and returns them. It also records that they were emitted, which suppresses them from
268+
* This is used when writing the API report file. It looks up any messages that were configured to get emitted
269+
* in the API report file and returns them. It also records that they were emitted, which suppresses them from
270270
* being shown on the console.
271271
*/
272272
public fetchAssociatedMessagesForReviewFile(astDeclaration: AstDeclaration): ExtractorMessage[] {
@@ -278,11 +278,11 @@ export class MessageRouter {
278278
// Make sure we didn't already report this message for some reason
279279
if (!associatedMessage.handled) {
280280

281-
// Is this message type configured to go in the API review file?
281+
// Is this message type configured to go in the API report file?
282282
const reportingRule: IReportingRule = this._getRuleForMessage(associatedMessage);
283283
if (reportingRule.addToApiReportFile) {
284284

285-
// Include it in the result, and record that it went to the API review file
285+
// Include it in the result, and record that it went to the API report file
286286
messagesForApiReportFile.push(associatedMessage);
287287
associatedMessage.handled = true;
288288
}
@@ -306,11 +306,11 @@ export class MessageRouter {
306306
// Make sure we didn't already report this message for some reason
307307
if (!unassociatedMessage.handled) {
308308

309-
// Is this message type configured to go in the API review file?
309+
// Is this message type configured to go in the API report file?
310310
const reportingRule: IReportingRule = this._getRuleForMessage(unassociatedMessage);
311311
if (reportingRule.addToApiReportFile) {
312312

313-
// Include it in the result, and record that it went to the API review file
313+
// Include it in the result, and record that it went to the API report file
314314
messagesForApiReportFile.push(unassociatedMessage);
315315
unassociatedMessage.handled = true;
316316
}

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ export class ReviewFileGenerator {
3737
const stringWriter: StringWriter = new StringWriter();
3838

3939
stringWriter.writeLine([
40-
`## API Review File for "${collector.workingPackage.name}"`,
40+
`## API Report File for "${collector.workingPackage.name}"`,
4141
``,
4242
`> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).`,
4343
``

0 commit comments

Comments
 (0)