From 1c1de991c75eb0b66d91acb405307b27d2e9718f Mon Sep 17 00:00:00 2001 From: Pete Gonzalez <4673363+octogonz@users.noreply.github.com> Date: Mon, 8 Apr 2019 23:41:00 -0700 Subject: [PATCH 1/3] Rename ReviewFileGenerator.ts --> ApiReportGenerator.ts --- .../generators/{ReviewFileGenerator.ts => ApiReportGenerator.ts} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename apps/api-extractor/src/generators/{ReviewFileGenerator.ts => ApiReportGenerator.ts} (100%) diff --git a/apps/api-extractor/src/generators/ReviewFileGenerator.ts b/apps/api-extractor/src/generators/ApiReportGenerator.ts similarity index 100% rename from apps/api-extractor/src/generators/ReviewFileGenerator.ts rename to apps/api-extractor/src/generators/ApiReportGenerator.ts From 5840d33b73b2081072fe2b4dbc7d06cc8736b9b3 Mon Sep 17 00:00:00 2001 From: Pete Gonzalez <4673363+octogonz@users.noreply.github.com> Date: Mon, 8 Apr 2019 23:41:49 -0700 Subject: [PATCH 2/3] Rename ReviewFileGenerator.ts --> ApiReportGenerator.ts --- apps/api-extractor/src/api/Extractor.ts | 6 ++-- apps/api-extractor/src/collector/Collector.ts | 2 +- .../src/generators/ApiReportGenerator.ts | 30 +++++++++---------- .../src/generators/DtsEmitHelpers.ts | 2 +- 4 files changed, 20 insertions(+), 20 deletions(-) diff --git a/apps/api-extractor/src/api/Extractor.ts b/apps/api-extractor/src/api/Extractor.ts index 7fdbe3057ff..973fb39e5ce 100644 --- a/apps/api-extractor/src/api/Extractor.ts +++ b/apps/api-extractor/src/api/Extractor.ts @@ -14,7 +14,7 @@ import { Collector } from '../collector/Collector'; import { DtsRollupGenerator, DtsRollupKind } from '../generators/DtsRollupGenerator'; import { ApiModelGenerator } from '../generators/ApiModelGenerator'; import { ApiPackage } from '@microsoft/api-extractor-model'; -import { ReviewFileGenerator } from '../generators/ReviewFileGenerator'; +import { ApiReportGenerator } from '../generators/ApiReportGenerator'; import { PackageMetadataManager } from '../analyzer/PackageMetadataManager'; import { ValidationEnhancer } from '../enhancers/ValidationEnhancer'; import { DocCommentEnhancer } from '../enhancers/DocCommentEnhancer'; @@ -216,7 +216,7 @@ export class Extractor { const expectedApiReportPath: string = extractorConfig.reportFilePath; const expectedApiReportShortPath: string = extractorConfig._getShortFilePath(extractorConfig.reportFilePath); - const actualApiReportContent: string = ReviewFileGenerator.generateReviewFileContent(collector); + const actualApiReportContent: string = ApiReportGenerator.generateReviewFileContent(collector); // Write the actual file FileSystem.writeFile(actualApiReportPath, actualApiReportContent, { @@ -228,7 +228,7 @@ export class Extractor { if (FileSystem.exists(expectedApiReportPath)) { const expectedApiReportContent: string = FileSystem.readFile(expectedApiReportPath); - if (!ReviewFileGenerator.areEquivalentApiFileContents(actualApiReportContent, expectedApiReportContent)) { + if (!ApiReportGenerator.areEquivalentApiFileContents(actualApiReportContent, expectedApiReportContent)) { apiReportChanged = true; if (!localBuild) { diff --git a/apps/api-extractor/src/collector/Collector.ts b/apps/api-extractor/src/collector/Collector.ts index 60e3de13c18..3cad405f15c 100644 --- a/apps/api-extractor/src/collector/Collector.ts +++ b/apps/api-extractor/src/collector/Collector.ts @@ -52,7 +52,7 @@ export interface ICollectorOptions { /** * The `Collector` manages the overall data set that is used by `ApiModelGenerator`, - * `DtsRollupGenerator`, and `ReviewFileGenerator`. Starting from the working package's entry point, + * `DtsRollupGenerator`, and `ApiReportGenerator`. Starting from the working package's entry point, * the `Collector` collects all exported symbols, determines how to import any symbols they reference, * assigns unique names, and sorts everything into a normalized alphabetical ordering. */ diff --git a/apps/api-extractor/src/generators/ApiReportGenerator.ts b/apps/api-extractor/src/generators/ApiReportGenerator.ts index 79c6798737c..fc68ec3b970 100644 --- a/apps/api-extractor/src/generators/ApiReportGenerator.ts +++ b/apps/api-extractor/src/generators/ApiReportGenerator.ts @@ -18,7 +18,7 @@ import { ExtractorMessage } from '../api/ExtractorMessage'; import { StringWriter } from './StringWriter'; import { DtsEmitHelpers } from './DtsEmitHelpers'; -export class ReviewFileGenerator { +export class ApiReportGenerator { /** * Compares the contents of two API files that were created using ApiFileGenerator, * and returns true if they are equivalent. Note that these files are not normally edited @@ -101,15 +101,15 @@ export class ReviewFileGenerator { messagesToReport.push(message); } - stringWriter.write(ReviewFileGenerator._getAedocSynopsis(collector, astDeclaration, messagesToReport)); + stringWriter.write(ApiReportGenerator._getAedocSynopsis(collector, astDeclaration, messagesToReport)); const span: Span = new Span(astDeclaration.declaration); const declarationMetadata: DeclarationMetadata = collector.fetchMetadata(astDeclaration); if (declarationMetadata.isPreapproved) { - ReviewFileGenerator._modifySpanForPreapproved(span); + ApiReportGenerator._modifySpanForPreapproved(span); } else { - ReviewFileGenerator._modifySpan(collector, span, entity, astDeclaration, false); + ApiReportGenerator._modifySpan(collector, span, entity, astDeclaration, false); } span.writeModifiedText(stringWriter.stringBuilder); @@ -121,7 +121,7 @@ export class ReviewFileGenerator { for (const exportToEmit of exportsToEmit.values()) { // Write any associated messages for (const message of exportToEmit.associatedMessages) { - ReviewFileGenerator._writeLineAsComments(stringWriter, + ApiReportGenerator._writeLineAsComments(stringWriter, 'Warning: ' + message.formatMessageWithoutLocation()); } @@ -138,10 +138,10 @@ export class ReviewFileGenerator { .fetchUnassociatedMessagesForReviewFile(); if (unassociatedMessages.length > 0) { stringWriter.writeLine(); - ReviewFileGenerator._writeLineAsComments(stringWriter, 'Warnings were encountered during analysis:'); - ReviewFileGenerator._writeLineAsComments(stringWriter, ''); + ApiReportGenerator._writeLineAsComments(stringWriter, 'Warnings were encountered during analysis:'); + ApiReportGenerator._writeLineAsComments(stringWriter, ''); for (const unassociatedMessage of unassociatedMessages) { - ReviewFileGenerator._writeLineAsComments(stringWriter, unassociatedMessage.formatMessageWithLocation( + ApiReportGenerator._writeLineAsComments(stringWriter, unassociatedMessage.formatMessageWithLocation( collector.workingPackage.packageFolder )); } @@ -149,7 +149,7 @@ export class ReviewFileGenerator { if (collector.workingPackage.tsdocComment === undefined) { stringWriter.writeLine(); - ReviewFileGenerator._writeLineAsComments(stringWriter, '(No @packageDocumentation comment for this package)'); + ApiReportGenerator._writeLineAsComments(stringWriter, '(No @packageDocumentation comment for this package)'); } // Write the closing delimiter for the Markdown code fence @@ -294,16 +294,16 @@ export class ReviewFileGenerator { if (!insideTypeLiteral) { const messagesToReport: ExtractorMessage[] = collector.messageRouter .fetchAssociatedMessagesForReviewFile(childAstDeclaration); - const aedocSynopsis: string = ReviewFileGenerator._getAedocSynopsis(collector, childAstDeclaration, + const aedocSynopsis: string = ApiReportGenerator._getAedocSynopsis(collector, childAstDeclaration, messagesToReport); - const indentedAedocSynopsis: string = ReviewFileGenerator._addIndentAfterNewlines(aedocSynopsis, + const indentedAedocSynopsis: string = ApiReportGenerator._addIndentAfterNewlines(aedocSynopsis, child.getIndent()); child.modification.prefix = indentedAedocSynopsis + child.modification.prefix; } } - ReviewFileGenerator._modifySpan(collector, child, entity, childAstDeclaration, insideTypeLiteral); + ApiReportGenerator._modifySpan(collector, child, entity, childAstDeclaration, insideTypeLiteral); } } } @@ -369,7 +369,7 @@ export class ReviewFileGenerator { const stringWriter: StringWriter = new StringWriter(); for (const message of messagesToReport) { - ReviewFileGenerator._writeLineAsComments(stringWriter, 'Warning: ' + message.formatMessageWithoutLocation()); + ApiReportGenerator._writeLineAsComments(stringWriter, 'Warning: ' + message.formatMessageWithoutLocation()); } const declarationMetadata: DeclarationMetadata = collector.fetchMetadata(astDeclaration); @@ -411,10 +411,10 @@ export class ReviewFileGenerator { if (footerParts.length > 0) { if (messagesToReport.length > 0) { - ReviewFileGenerator._writeLineAsComments(stringWriter, ''); // skip a line after the warnings + ApiReportGenerator._writeLineAsComments(stringWriter, ''); // skip a line after the warnings } - ReviewFileGenerator._writeLineAsComments(stringWriter, footerParts.join(' ')); + ApiReportGenerator._writeLineAsComments(stringWriter, footerParts.join(' ')); } return stringWriter.toString(); diff --git a/apps/api-extractor/src/generators/DtsEmitHelpers.ts b/apps/api-extractor/src/generators/DtsEmitHelpers.ts index 2ab58900820..69f8fb0edff 100644 --- a/apps/api-extractor/src/generators/DtsEmitHelpers.ts +++ b/apps/api-extractor/src/generators/DtsEmitHelpers.ts @@ -10,7 +10,7 @@ import { StringWriter } from './StringWriter'; import { Collector } from '../collector/Collector'; /** - * Some common code shared between DtsRollupGenerator and ReviewFileGenerator. + * Some common code shared between DtsRollupGenerator and ApiReportGenerator. */ export class DtsEmitHelpers { public static emitImport(stringWriter: StringWriter, collectorEntity: CollectorEntity, astImport: AstImport): void { From 8bcfb9e4606abd7707d02275f8b224cfa2cb4190 Mon Sep 17 00:00:00 2001 From: Pete Gonzalez <4673363+octogonz@users.noreply.github.com> Date: Mon, 8 Apr 2019 23:42:16 -0700 Subject: [PATCH 3/3] rush change --- .../octogonz-ae-rename-file_2019-04-09-06-42.json | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 common/changes/@microsoft/api-extractor/octogonz-ae-rename-file_2019-04-09-06-42.json diff --git a/common/changes/@microsoft/api-extractor/octogonz-ae-rename-file_2019-04-09-06-42.json b/common/changes/@microsoft/api-extractor/octogonz-ae-rename-file_2019-04-09-06-42.json new file mode 100644 index 00000000000..8352e1ff65d --- /dev/null +++ b/common/changes/@microsoft/api-extractor/octogonz-ae-rename-file_2019-04-09-06-42.json @@ -0,0 +1,11 @@ +{ + "changes": [ + { + "comment": "", + "packageName": "@microsoft/api-extractor", + "type": "none" + } + ], + "packageName": "@microsoft/api-extractor", + "email": "4673363+octogonz@users.noreply.github.com" +} \ No newline at end of file