Adding an API that exposes the raw tool packages in RSC.

iclanton · iclanton · commit fc36dec94a4f · 2018-11-30T02:09:52.000-08:00
diff --git a/build-tests/api-extractor-test-05/etc/api-extractor-test-05.api.json b/build-tests/api-extractor-test-05/etc/api-extractor-test-05.api.json
@@ -1,7 +1,7 @@
 {
   "metadata": {
     "toolPackage": "@microsoft/api-extractor",
-    "toolVersion": "6.3.0",
+    "toolVersion": "7.0.0",
     "schemaVersion": 1000
   },
   "kind": "Package",
diff --git a/common/reviews/api/rush-stack-compiler-2.4.api.ts b/common/reviews/api/rush-stack-compiler-2.4.api.ts
@@ -26,6 +26,16 @@ class RushStackCompilerBase<TOptions = {}> {
   protected _terminal: Terminal;
 }
 
+// @alpha
+class ToolPackages {
+  // (undocumented)
+  static apiExtractor: typeof apiExtractor;
+  // (undocumented)
+  static tslint: typeof tslint;
+  // (undocumented)
+  static typescript: typeof typescript;
+}
+
 // @beta (undocumented)
 class ToolPaths {
   // (undocumented)
@@ -50,8 +60,6 @@ class TypescriptCompiler extends RushStackCompilerBase {
   constructor(rootPath: string, terminalProvider: ITerminalProvider);
   // (undocumented)
   invoke(): Promise<void>;
-  // (undocumented)
-  typescript: typeof typescript;
 }
 
 // WARNING: Unsupported export: WriteFileIssueFunction
diff --git a/common/reviews/api/rush-stack-compiler-2.7.api.ts b/common/reviews/api/rush-stack-compiler-2.7.api.ts
@@ -26,6 +26,16 @@ class RushStackCompilerBase<TOptions = {}> {
   protected _terminal: Terminal;
 }
 
+// @alpha
+class ToolPackages {
+  // (undocumented)
+  static apiExtractor: typeof apiExtractor;
+  // (undocumented)
+  static tslint: typeof tslint;
+  // (undocumented)
+  static typescript: typeof typescript;
+}
+
 // @beta (undocumented)
 class ToolPaths {
   // (undocumented)
@@ -50,8 +60,6 @@ class TypescriptCompiler extends RushStackCompilerBase {
   constructor(rootPath: string, terminalProvider: ITerminalProvider);
   // (undocumented)
   invoke(): Promise<void>;
-  // (undocumented)
-  typescript: typeof typescript;
 }
 
 // WARNING: Unsupported export: WriteFileIssueFunction
diff --git a/common/reviews/api/rush-stack-compiler-2.9.api.ts b/common/reviews/api/rush-stack-compiler-2.9.api.ts
@@ -26,6 +26,16 @@ class RushStackCompilerBase<TOptions = {}> {
   protected _terminal: Terminal;
 }
 
+// @alpha
+class ToolPackages {
+  // (undocumented)
+  static apiExtractor: typeof apiExtractor;
+  // (undocumented)
+  static tslint: typeof tslint;
+  // (undocumented)
+  static typescript: typeof typescript;
+}
+
 // @beta (undocumented)
 class ToolPaths {
   // (undocumented)
@@ -50,8 +60,6 @@ class TypescriptCompiler extends RushStackCompilerBase {
   constructor(rootPath: string, terminalProvider: ITerminalProvider);
   // (undocumented)
   invoke(): Promise<void>;
-  // (undocumented)
-  typescript: typeof typescript;
 }
 
 // WARNING: Unsupported export: WriteFileIssueFunction
diff --git a/common/reviews/api/rush-stack-compiler-3.0.api.ts b/common/reviews/api/rush-stack-compiler-3.0.api.ts
@@ -26,6 +26,16 @@ class RushStackCompilerBase<TOptions = {}> {
   protected _terminal: Terminal;
 }
 
+// @alpha
+class ToolPackages {
+  // (undocumented)
+  static apiExtractor: typeof apiExtractor;
+  // (undocumented)
+  static tslint: typeof tslint;
+  // (undocumented)
+  static typescript: typeof typescript;
+}
+
 // @beta (undocumented)
 class ToolPaths {
   // (undocumented)
@@ -50,8 +60,6 @@ class TypescriptCompiler extends RushStackCompilerBase {
   constructor(rootPath: string, terminalProvider: ITerminalProvider);
   // (undocumented)
   invoke(): Promise<void>;
-  // (undocumented)
-  typescript: typeof typescript;
 }
 
 // WARNING: Unsupported export: WriteFileIssueFunction
diff --git a/common/reviews/api/rush-stack-compiler-3.1.api.ts b/common/reviews/api/rush-stack-compiler-3.1.api.ts
@@ -26,6 +26,16 @@ class RushStackCompilerBase<TOptions = {}> {
   protected _terminal: Terminal;
 }
 
+// @alpha
+class ToolPackages {
+  // (undocumented)
+  static apiExtractor: typeof apiExtractor;
+  // (undocumented)
+  static tslint: typeof tslint;
+  // (undocumented)
+  static typescript: typeof typescript;
+}
+
 // @beta (undocumented)
 class ToolPaths {
   // (undocumented)
@@ -50,8 +60,6 @@ class TypescriptCompiler extends RushStackCompilerBase {
   constructor(rootPath: string, terminalProvider: ITerminalProvider);
   // (undocumented)
   invoke(): Promise<void>;
-  // (undocumented)
-  typescript: typeof typescript;
 }
 
 // WARNING: Unsupported export: WriteFileIssueFunction
diff --git a/common/reviews/api/rush-stack-compiler-3.2.api.ts b/common/reviews/api/rush-stack-compiler-3.2.api.ts
@@ -0,0 +1,65 @@
+// @beta
+class ApiExtractorRunner extends RushStackCompilerBase {
+  constructor(extractorConfig: IExtractorConfig, extractorOptions: IExtractorOptions, rootPath: string, terminalProvider: ITerminalProvider);
+  // (undocumented)
+  invoke(): Promise<void>;
+}
+
+// @public (undocumented)
+interface ITslintRunnerConfig {
+  displayAsError?: boolean;
+  // (undocumented)
+  fileError: WriteFileIssueFunction;
+  // (undocumented)
+  fileWarning: WriteFileIssueFunction;
+}
+
+// @beta (undocumented)
+class RushStackCompilerBase<TOptions = {}> {
+  constructor(taskOptions: TOptions, rootPath: string, terminalProvider: ITerminalProvider);
+  // WARNING: The type "StandardBuildFolders" needs to be exported by the package (e.g. added to index.ts)
+  // (undocumented)
+  protected _standardBuildFolders: StandardBuildFolders;
+  // (undocumented)
+  protected _taskOptions: TOptions;
+  // (undocumented)
+  protected _terminal: Terminal;
+}
+
+// @alpha
+class ToolPackages {
+  // (undocumented)
+  static apiExtractor: typeof apiExtractor;
+  // (undocumented)
+  static tslint: typeof tslint;
+  // (undocumented)
+  static typescript: typeof typescript;
+}
+
+// @beta (undocumented)
+class ToolPaths {
+  // (undocumented)
+  static readonly tslintPackageJson: IPackageJson;
+  // (undocumented)
+  static readonly tslintPackagePath: string;
+  // (undocumented)
+  static readonly typescriptPackageJson: IPackageJson;
+  // (undocumented)
+  static readonly typescriptPackagePath: string;
+}
+
+// @beta (undocumented)
+class TslintRunner extends RushStackCompilerBase<ITslintRunnerConfig> {
+  constructor(taskOptions: ITslintRunnerConfig, rootPath: string, terminalProvider: ITerminalProvider);
+  // (undocumented)
+  invoke(): Promise<void>;
+}
+
+// @beta (undocumented)
+class TypescriptCompiler extends RushStackCompilerBase {
+  constructor(rootPath: string, terminalProvider: ITerminalProvider);
+  // (undocumented)
+  invoke(): Promise<void>;
+}
+
+// WARNING: Unsupported export: WriteFileIssueFunction
diff --git a/core-build/gulp-core-build-typescript/src/TscCmdTask.ts b/core-build/gulp-core-build-typescript/src/TscCmdTask.ts
@@ -105,7 +105,7 @@ export class TscCmdTask extends RSCTask<ITscCmdTaskConfig> {
 
     if (this.taskConfig.removeCommentsFromJavaScript === true) {
       buildPromise = buildPromise.then(
-        () => this._removeComments(typescriptCompiler.typescript)
+        () => this._removeComments(this._rushStackCompiler.ToolPackages.typescript)
       );
     }
 
diff --git a/stack/rush-stack-compiler-shared/src/shared/ToolPackages.ts b/stack/rush-stack-compiler-shared/src/shared/ToolPackages.ts
@@ -0,0 +1,17 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+
+import * as typescript from 'typescript';
+import * as tslint from 'tslint';
+import * as apiExtractor from '@microsoft/api-extractor';
+
+/**
+ * Provides access to the raw tool APIs.
+ *
+ * @alpha
+ */
+export class ToolPackages {
+  public static typescript: typeof typescript = typescript;
+  public static tslint: typeof tslint = tslint;
+  public static apiExtractor: typeof apiExtractor = apiExtractor;
+}
diff --git a/stack/rush-stack-compiler-shared/src/shared/TypescriptCompiler.ts b/stack/rush-stack-compiler-shared/src/shared/TypescriptCompiler.ts
@@ -2,7 +2,6 @@
 // See LICENSE in the project root for license information.
 
 import * as path from 'path';
-import * as typescript from 'typescript';
 import { ITerminalProvider } from '@microsoft/node-core-library';
 
 import { CmdRunner } from './CmdRunner';
@@ -13,7 +12,6 @@ import { RushStackCompilerBase } from './RushStackCompilerBase';
  * @beta
  */
 export class TypescriptCompiler extends RushStackCompilerBase {
-  public typescript: typeof typescript = typescript;
   private _cmdRunner: CmdRunner;
 
   constructor(rootPath: string, terminalProvider: ITerminalProvider) {
diff --git a/stack/rush-stack-compiler-shared/src/shared/index.ts b/stack/rush-stack-compiler-shared/src/shared/index.ts
@@ -14,8 +14,13 @@
  * @packagedocumentation
  */
 
-export * from './RushStackCompilerBase';
-export * from './ApiExtractorRunner';
-export * from './TypescriptCompiler';
-export * from './TslintRunner';
-export * from './ToolPaths';
+export { RushStackCompilerBase }  from './RushStackCompilerBase';
+export { ApiExtractorRunner } from './ApiExtractorRunner';
+export { TypescriptCompiler } from './TypescriptCompiler';
+export {
+  WriteFileIssueFunction,
+  ITslintRunnerConfig,
+  TslintRunner
+} from './TslintRunner';
+export { ToolPaths } from './ToolPaths';
+export { ToolPackages } from './ToolPackages';

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"metadata": {`
`3`	`3`	`"toolPackage": "@microsoft/api-extractor",`
`4`		`- "toolVersion": "6.3.0",`
	`4`	`+ "toolVersion": "7.0.0",`
`5`	`5`	`"schemaVersion": 1000`
`6`	`6`	`},`
`7`	`7`	`"kind": "Package",`
Original file line number	Diff line number	Diff line change
`@@ -105,7 +105,7 @@ export class TscCmdTask extends RSCTask<ITscCmdTaskConfig> {`
`105`	`105`
`106`	`106`	`if (this.taskConfig.removeCommentsFromJavaScript === true) {`
`107`	`107`	`buildPromise = buildPromise.then(`
`108`		`- () => this._removeComments(typescriptCompiler.typescript)`
	`108`	`+ () => this._removeComments(this._rushStackCompiler.ToolPackages.typescript)`
`109`	`109`	`);`
`110`	`110`	`}`
`111`	`111`