Skip to content

Commit 6d6e1ce

Browse files
iclantoniclanton
committed
Updating documentation for the new skipLibCheck option.
1 parent b6ec0b7 commit 6d6e1ce

5 files changed

Lines changed: 20 additions & 21 deletions

File tree

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -68,10 +68,10 @@ export class RunAction extends CommandLineAction {
6868
this._skipLibCheck = this.defineFlagParameter({
6969
parameterLongName: '--skip-lib-check',
7070
description: 'This flag causes the typechecker to be invoked with the --skipLibCheck option. This option is not'
71-
+ ' recommended and may cause api-extractor to produce incomplete or incorrect declarations, but it '
72-
+ ' may be required when dependencies contain declarations that are incompatible with newer versions'
73-
+ ' of TypeScript. If this option is used, it is strongly recommended that broken dependencies be'
74-
+ ' fixed or upgraded.'
71+
+ ' recommended and may cause API Extractor to produce incomplete or incorrect declarations, but it '
72+
+ ' may be required when dependencies contain declarations that are incompatible with the TypeScript engine'
73+
+ ' that API Extractor uses for its analysis. If this option is used, it is strongly recommended that broken'
74+
+ ' dependencies be fixed or upgraded.'
7575
});
7676
}
7777

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

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -79,15 +79,13 @@ export interface IExtractorOptions {
7979

8080
/**
8181
* This option causes the typechecker to be invoked with the --skipLibCheck option. This option is not
82-
* recommended and may cause api-extractor to produce incomplete or incorrect declarations, but it
83-
* may be required when dependencies contain declarations that are incompatible with newer versions
84-
* of TypeScript. If this option is used, it is strongly recommended that broken dependencies be
85-
* fixed or upgraded.
82+
* recommended and may cause API Extractor to produce incomplete or incorrect declarations, but it
83+
* may be required when dependencies contain declarations that are incompatible with the TypeScript engine
84+
* that API Extractor uses for its analysis. If this option is used, it is strongly recommended that broken
85+
* dependencies be fixed or upgraded.
8686
*
8787
* @remarks
8888
* This option only applies when compiler.config.configType is set to "tsconfig"
89-
*
90-
* @beta
9189
*/
9290
skipLibCheck?: boolean;
9391
}

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,6 @@ interface IExtractorOptions {
214214
compilerProgram?: ts.Program;
215215
customLogger?: Partial<ILogger>;
216216
localBuild?: boolean;
217-
// @beta
218217
skipLibCheck?: boolean;
219218
// @beta
220219
typescriptCompilerFolder?: string;

‎core-build/gulp-core-build-typescript/src/ApiExtractorTask.ts‎

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -112,12 +112,10 @@ export interface IApiExtractorTaskConfig {
112112

113113
/**
114114
* This option causes the typechecker to be invoked with the --skipLibCheck option. This option is not
115-
* recommended and may cause api-extractor to produce incomplete or incorrect declarations, but it
116-
* may be required when dependencies contain declarations that are incompatible with newer versions
117-
* of TypeScript. If this option is used, it is strongly recommended that broken dependencies be
118-
* fixed or upgraded.
119-
*
120-
* @beta
115+
* recommended and may cause API Extractor to produce incomplete or incorrect declarations, but it
116+
* may be required when dependencies contain declarations that are incompatible with the TypeScript engine
117+
* that API Extractor uses for its analysis. If this option is used, it is strongly recommended that broken
118+
* dependencies be fixed or upgraded.
121119
*/
122120
skipLibCheck?: boolean;
123121
}
@@ -194,9 +192,8 @@ export class ApiExtractorTask extends GulpTask<IApiExtractorTaskConfig> {
194192
apiJsonFile: {
195193
enabled: true,
196194
outputFolder: this.taskConfig.apiJsonFolder
197-
},
198-
skipLibCheck: this.taskConfig.skipLibCheck
199-
} as IExtractorConfig;
195+
}
196+
};
200197

201198
if (this.taskConfig.generateDtsRollup) {
202199
extractorConfig.dtsRollup = {
@@ -216,7 +213,8 @@ export class ApiExtractorTask extends GulpTask<IApiExtractorTaskConfig> {
216213
logWarning: (message: string) => this.logWarning(message),
217214
logError: (message: string) => this.logError(message)
218215
},
219-
typescriptCompilerFolder: this.taskConfig.typescriptCompilerFolder
216+
typescriptCompilerFolder: this.taskConfig.typescriptCompilerFolder,
217+
skipLibCheck: this.taskConfig.skipLibCheck
220218
};
221219

222220
const extractor: Extractor = new Extractor(extractorConfig, extractorOptions);

‎core-build/gulp-core-build-typescript/src/schemas/api-extractor.schema.json‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,10 @@
4646
"publishFolderForPublic": {
4747
"description": "This setting is only used if \"dtsRollupTrimming\" is true. It indicates the folder where \"npm publish\" will be run for a public release. The default value is \"./dist/public\". A public release will contain all definitions that are reachable from the entry point, except definitions marked as @beta, @alpha, or @internal.",
4848
"type": "string"
49+
},
50+
"skipLibCheck": {
51+
"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.",
52+
"type": "boolean"
4953
}
5054
},
5155
"required": [ "enabled" ],

0 commit comments

Comments
 (0)