Skip to content

Commit 37bc452

Browse files
octogonzoctogonz
committed
Rename "tempFolder" to "reportTempFolder" to clarify that it is not a general temporary folder
1 parent 4fe784e commit 37bc452

8 files changed

Lines changed: 21 additions & 23 deletions

File tree

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -201,8 +201,8 @@ export class Extractor {
201201
}
202202

203203
if (extractorConfig.apiReportEnabled) {
204-
const actualApiReportPath: string = extractorConfig.tempReportFilePath;
205-
const actualApiReviewShortPath: string = extractorConfig._getShortFilePath(extractorConfig.tempReportFilePath);
204+
const actualApiReportPath: string = extractorConfig.reportTempFilePath;
205+
const actualApiReviewShortPath: string = extractorConfig._getShortFilePath(extractorConfig.reportTempFilePath);
206206

207207
const expectedApiReviewPath: string = extractorConfig.reportFilePath;
208208
const expectedApiReviewShortPath: string = extractorConfig._getShortFilePath(extractorConfig.reportFilePath);

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

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ interface IExtractorConfigParameters {
9797
skipLibCheck: boolean;
9898
apiReportEnabled: boolean;
9999
reportFilePath: string;
100-
tempReportFilePath: string;
100+
reportTempFilePath: string;
101101
docModelEnabled: boolean;
102102
apiJsonFilePath: string;
103103
rollupEnabled: boolean;
@@ -160,8 +160,8 @@ export class ExtractorConfig {
160160

161161
/** The `reportFolder` path combined with the `reportFileName`. */
162162
public readonly reportFilePath: string;
163-
/** The `tempFolder` path combined with the `reportFileName`. */
164-
public readonly tempReportFilePath: string;
163+
/** The `reportTempFolder` path combined with the `reportFileName`. */
164+
public readonly reportTempFilePath: string;
165165

166166
/** {@inheritDoc IConfigDocModel.enabled} */
167167
public readonly docModelEnabled: boolean;
@@ -197,7 +197,7 @@ export class ExtractorConfig {
197197
this.skipLibCheck = parameters.skipLibCheck;
198198
this.apiReportEnabled = parameters.apiReportEnabled;
199199
this.reportFilePath = parameters.reportFilePath;
200-
this.tempReportFilePath = parameters.tempReportFilePath;
200+
this.reportTempFilePath = parameters.reportTempFilePath;
201201
this.docModelEnabled = parameters.docModelEnabled;
202202
this.apiJsonFilePath = parameters.apiJsonFilePath;
203203
this.rollupEnabled = parameters.rollupEnabled;
@@ -422,7 +422,7 @@ export class ExtractorConfig {
422422

423423
let apiReportEnabled: boolean = false;
424424
let reportFilePath: string = '';
425-
let tempReportFilePath: string = '';
425+
let reportTempFilePath: string = '';
426426
if (configObject.apiReport) {
427427
apiReportEnabled = !!configObject.apiReport.enabled;
428428

@@ -440,11 +440,11 @@ export class ExtractorConfig {
440440

441441
const reportFolder: string = ExtractorConfig._resolvePathWithTokens('reportFolder',
442442
configObject.apiReport.reportFolder, tokenContext);
443-
const tempFolder: string = ExtractorConfig._resolvePathWithTokens('tempFolder',
444-
configObject.apiReport.tempFolder, tokenContext);
443+
const reportTempFolder: string = ExtractorConfig._resolvePathWithTokens('reportTempFolder',
444+
configObject.apiReport.reportTempFolder, tokenContext);
445445

446446
reportFilePath = path.join(reportFolder, reportFilename);
447-
tempReportFilePath = path.join(tempFolder, reportFilename);
447+
reportTempFilePath = path.join(reportTempFolder, reportFilename);
448448
}
449449

450450
let docModelEnabled: boolean = false;
@@ -511,7 +511,7 @@ export class ExtractorConfig {
511511
skipLibCheck: !!configObject.compiler.skipLibCheck,
512512
apiReportEnabled,
513513
reportFilePath,
514-
tempReportFilePath,
514+
reportTempFilePath,
515515
docModelEnabled,
516516
apiJsonFilePath,
517517
rollupEnabled,

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ export interface IConfigApiReport {
6565
enabled: boolean;
6666

6767
/**
68-
* The filename for the API report files. It will be combined with `trackedFolder` or `tempFolder` to produce
68+
* The filename for the API report files. It will be combined with `reportFolder` or `reportTempFolder` to produce
6969
* a full output filename.
7070
*
7171
* @remarks
@@ -95,7 +95,7 @@ export interface IConfigApiReport {
9595
*
9696
* The path is resolved relative to the `rootFolder` location.
9797
*/
98-
tempFolder?: string;
98+
reportTempFolder?: string;
9999
}
100100

101101
/**

‎apps/api-extractor/src/schemas/api-extractor-defaults.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
// ("enabled" is required)
1111
"reportFileName": "<unscopedPackageName>.api.md",
1212
"reportFolder": "etc/",
13-
"tempFolder": "temp/"
13+
"reportTempFolder": "temp/"
1414
},
1515

1616
"docModel": {

‎apps/api-extractor/src/schemas/api-extractor-template.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@
8080
"enabled": true,
8181

8282
/**
83-
* The filename for the API report files. It will be combined with "trackedFolder" or "tempFolder" to produce
83+
* The filename for the API report files. It will be combined with "reportFolder" or "reportTempFolder" to produce
8484
* a full output filename.
8585
*
8686
* The file extension should be ".api.md", and the string should not contain a path separator such as "\" or "/".
@@ -113,7 +113,7 @@
113113
*
114114
* DEFAULT VALUE: "temp/"
115115
*/
116-
// "tempFolder": "temp/"
116+
// "reportTempFolder": "temp/"
117117
},
118118

119119
/**

‎apps/api-extractor/src/schemas/api-extractor.schema.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@
4848
},
4949

5050
"reportFileName": {
51-
"description": "The filename for the API report files. It will be combined with \"trackedFolder\" or \"tempFolder\" to produce a full output filename. The file extension should be \".api.md\", and the string should not contain a path separator such as \"\\\" or \"/\".",
51+
"description": "The filename for the API report files. It will be combined with \"reportFolder\" or \"reportTempFolder\" to produce a full output filename. The file extension should be \".api.md\", and the string should not contain a path separator such as \"\\\" or \"/\".",
5252
"type": "string"
5353
},
5454

@@ -57,7 +57,7 @@
5757
"type": "string"
5858
},
5959

60-
"tempFolder": {
60+
"reportTempFolder": {
6161
"description": "Specifies the folder where the temporary report file is written. The file name portion is determined by the \"reportFileName\" setting. fter the temporary file is written to disk, it is compared with the file in the \"reportFolder\". If they are different, a production build will fail. The path is resolved relative to the \"rootFolder\" location.",
6262
"type": "string"
6363
}

‎build-tests/api-extractor-scenarios/src/runScenarios.ts‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,11 @@ export function runScenarios(buildConfigPath: string): void {
2626

2727
'apiReport': {
2828
'enabled': true,
29-
'reportFolder': `./etc/test-outputs/${scenarioFolderName}`,
30-
'tempFolder': './temp'
29+
'reportFolder': `./etc/test-outputs/${scenarioFolderName}`
3130
},
3231

3332
'dtsRollup': {
3433
'enabled': true,
35-
3634
'untrimmedFilePath': `./etc/test-outputs/${scenarioFolderName}/rollup.d.ts`
3735
},
3836

‎common/reviews/api/api-extractor.api.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,10 +44,10 @@ export class ExtractorConfig {
4444
static prepare(options: IExtractorConfigPrepareOptions): ExtractorConfig;
4545
readonly publicTrimmedFilePath: string;
4646
readonly reportFilePath: string;
47+
readonly reportTempFilePath: string;
4748
readonly rollupEnabled: boolean;
4849
readonly rootFolder: string;
4950
readonly skipLibCheck: boolean;
50-
readonly tempReportFilePath: string;
5151
readonly testMode: boolean;
5252
readonly tsdocMetadataEnabled: boolean;
5353
readonly tsdocMetadataFilePath: string;
@@ -125,7 +125,7 @@ export interface IConfigApiReport {
125125
enabled: boolean;
126126
reportFileName?: string;
127127
reportFolder?: string;
128-
tempFolder?: string;
128+
reportTempFolder?: string;
129129
}
130130

131131
// @public

0 commit comments

Comments
 (0)