Skip to content

Commit 5e62c38

Browse files
iclantoniclanton
committed
Move skipLibCheck from options to config.
1 parent 702c86f commit 5e62c38

4 files changed

Lines changed: 19 additions & 25 deletions

File tree

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

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -82,18 +82,6 @@ export interface IExtractorOptions {
8282
* @beta
8383
*/
8484
typescriptCompilerFolder?: string;
85-
86-
/**
87-
* This option causes the typechecker to be invoked with the --skipLibCheck option. This option is not
88-
* recommended and may cause API Extractor to produce incomplete or incorrect declarations, but it
89-
* may be required when dependencies contain declarations that are incompatible with the TypeScript engine
90-
* that API Extractor uses for its analysis. If this option is used, it is strongly recommended that broken
91-
* dependencies be fixed or upgraded.
92-
*
93-
* @remarks
94-
* This option only applies when compiler.config.configType is set to "tsconfig"
95-
*/
96-
skipLibCheck?: boolean;
9785
}
9886

9987
/**
@@ -290,7 +278,7 @@ export class Extractor {
290278
this._absoluteRootFolder
291279
);
292280

293-
if (!commandLine.options.skipLibCheck && options.skipLibCheck) {
281+
if (!commandLine.options.skipLibCheck && config.skipLibCheck) {
294282
commandLine.options.skipLibCheck = true;
295283
console.log(colors.cyan(
296284
'API Extractor was invoked with skipLibCheck. This is not recommended and may cause ' +

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

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -297,4 +297,16 @@ export interface IExtractorConfig {
297297
* @beta
298298
*/
299299
dtsRollup?: IExtractorDtsRollupConfig;
300+
301+
/**
302+
* This option causes the typechecker to be invoked with the --skipLibCheck option. This option is not
303+
* recommended and may cause API Extractor to produce incomplete or incorrect declarations, but it
304+
* may be required when dependencies contain declarations that are incompatible with the TypeScript engine
305+
* that API Extractor uses for its analysis. If this option is used, it is strongly recommended that broken
306+
* dependencies be fixed or upgraded.
307+
*
308+
* @remarks
309+
* This option only applies when compiler.config.configType is set to "tsconfig"
310+
*/
311+
skipLibCheck?: boolean;
300312
}

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

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@ export class RunAction extends CommandLineAction {
2727
private _configFileParameter: CommandLineStringParameter;
2828
private _localParameter: CommandLineFlagParameter;
2929
private _typescriptCompilerFolder: CommandLineStringParameter;
30-
private _skipLibCheck: CommandLineFlagParameter;
3130

3231
constructor(parser: ApiExtractorCommandLine) {
3332
super({
@@ -61,15 +60,6 @@ export class RunAction extends CommandLineAction {
6160
+ ' This can often cause compiler errors due to incompatibilities between different TS versions.'
6261
+ ' Use "--typescript-compiler-folder" to specify the folder path for your compiler version.'
6362
});
64-
65-
this._skipLibCheck = this.defineFlagParameter({
66-
parameterLongName: '--skip-lib-check',
67-
description: 'This flag causes the typechecker to be invoked with the --skipLibCheck option. This option is not'
68-
+ ' recommended and may cause API Extractor to produce incomplete or incorrect declarations, but it '
69-
+ ' may be required when dependencies contain declarations that are incompatible with the TypeScript engine'
70-
+ ' that API Extractor uses for its analysis. If this option is used, it is strongly recommended that broken'
71-
+ ' dependencies be fixed or upgraded.'
72-
});
7363
}
7464

7565
protected onExecute(): Promise<void> { // override
@@ -138,8 +128,7 @@ export class RunAction extends CommandLineAction {
138128
config,
139129
{
140130
localBuild: this._localParameter.value,
141-
typescriptCompilerFolder: typescriptCompilerFolder,
142-
skipLibCheck: this._skipLibCheck.value
131+
typescriptCompilerFolder: typescriptCompilerFolder
143132
}
144133
);
145134

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,11 @@
164164
},
165165
"required": [ "enabled" ],
166166
"additionalProperties": false
167+
},
168+
169+
"skipLibCheck": {
170+
"description": "This option causes the typechecker to be invoked with the --skipLibCheck option. This option is not recommended and may cause API Extractor to produce incomplete or incorrect declarations, but it may be required when dependencies contain declarations that are incompatible with the TypeScript engine that API Extractor uses for its analysis. If this option is used, it is strongly recommended that broken dependencies be fixed or upgraded.",
171+
"type": "boolean"
167172
}
168173
},
169174
"required": [ "compiler", "project" ],

0 commit comments

Comments
 (0)