Rename ApiExtractor --> Extractor

Author: pgonzal

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

@@ -1,10 +1,3 @@
-// @public
-class ApiExtractor {
-  public constructor(config: IExtractorConfig, options?: IExtractorOptions);
-  public analyzeProject(options?: IAnalyzeProjectOptions): void;
-  public static jsonSchema: JsonSchema;
-}
-
 // @public
 class ApiJsonFile {
   public static jsonSchema: JsonSchema;
@@ -17,6 +10,13 @@ class ExternalApiHelper {
   public static generateApiJson(rootDir: string, libFolder: string, externalPackageFilePath: string): void;
 }
 
+// @public
+class Extractor {
+  public constructor(config: IExtractorConfig, options?: IExtractorOptions);
+  public analyzeProject(options?: IAnalyzeProjectOptions): void;
+  public static jsonSchema: JsonSchema;
+}
+
 // @public
 interface IAnalyzeProjectOptions {
   projectConfig?: IExtractorProjectConfig;

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

@@ -7,7 +7,7 @@ import * as path from 'path';
 import * as ts from 'typescript';
 import { GulpTask } from '@microsoft/gulp-core-build';
 import {
-  ApiExtractor,
+  Extractor,
   IExtractorOptions,
   IExtractorConfig
 } from '@microsoft/api-extractor';
@@ -145,7 +145,7 @@ export class ApiExtractorTask extends GulpTask<IApiExtractorTaskConfig>  {
         }
       };
 
-      const extractor: ApiExtractor = new ApiExtractor(extractorConfig, extractorOptions);
+      const extractor: Extractor = new Extractor(extractorConfig, extractorOptions);
       extractor.analyzeProject();
     } catch (e) {
       completeCallback(e.message);

libraries/api-extractor/src/DebugRun.ts

@@ -4,9 +4,9 @@
 // NOTE: THIS SOURCE FILE IS FOR DEBUGGING PURPOSES ONLY.
 //       IT IS INVOKED BY THE "Run.cmd" AND "Debug.cmd" BATCH FILES.
 
-import { ApiExtractor } from './extractor/ApiExtractor';
+import { Extractor } from './extractor/Extractor';
 
-const apiExtractor: ApiExtractor = new ApiExtractor(
+const extractor: Extractor = new Extractor(
   {
     compiler: {
       configType: 'tsconfig',
@@ -26,6 +26,6 @@ const apiExtractor: ApiExtractor = new ApiExtractor(
   }
 );
 
-apiExtractor.analyzeProject();
+extractor.analyzeProject();
 
 console.log('DebugRun completed.');

libraries/api-extractor/src/ExternalApiHelper.ts

@@ -3,7 +3,7 @@
 
 import * as path from 'path';
 import * as fs from 'fs';
-import { ApiExtractor } from './extractor/ApiExtractor';
+import { Extractor } from './extractor/Extractor';
 
 /**
  * ExternalApiHelper has the specific use case of generating an API json file from third-party definition files.
@@ -47,7 +47,7 @@ export default class ExternalApiHelper {
       fs.mkdirSync(outputPath);
     }
 
-    const apiExtractor: ApiExtractor = new ApiExtractor({
+    const extractor: Extractor = new Extractor({
       compiler: {
         configType: 'tsconfig',
         rootFolder: entryPointFolder,
@@ -69,6 +69,6 @@ export default class ExternalApiHelper {
       }
     });
 
-    apiExtractor.analyzeProject();
+    extractor.analyzeProject();
   }
 }

libraries/api-extractor/src/cli/RunAction.ts

@@ -12,7 +12,7 @@ import {
   CommandLineFlagParameter
 } from '@microsoft/ts-command-line';
 
-import { ApiExtractor } from '../extractor/ApiExtractor';
+import { Extractor } from '../extractor/Extractor';
 import { IExtractorConfig } from '../extractor/IExtractorConfig';
 
 import { ApiExtractorCommandLine } from './ApiExtractorCommandLine';
@@ -78,10 +78,10 @@ export class RunAction extends CommandLineAction {
       console.log(`Using configuration from ${configFilename}` + os.EOL + os.EOL);
     }
 
-    const config: IExtractorConfig = JsonFile.loadAndValidate(configFilename, ApiExtractor.jsonSchema);
-    const apiExtractor: ApiExtractor = new ApiExtractor(config, {
+    const config: IExtractorConfig = JsonFile.loadAndValidate(configFilename, Extractor.jsonSchema);
+    const extractor: Extractor = new Extractor(config, {
       localBuild: this._localParameter.value
     });
-    apiExtractor.analyzeProject();
+    extractor.analyzeProject();
   }
 }

libraries/api-extractor/src/extractor/Extractor.ts

@@ -19,7 +19,7 @@ import ApiJsonGenerator from '../generators/ApiJsonGenerator';
 import ApiFileGenerator from '../generators/ApiFileGenerator';
 
 /**
- * Options for {@link ApiExtractor.analyzeProject}.
+ * Options for {@link Extractor.analyzeProject}.
  * @public
  */
 export interface IAnalyzeProjectOptions {
@@ -30,7 +30,7 @@ export interface IAnalyzeProjectOptions {
 }
 
 /**
- * Runtime options for ApiExtractor.
+ * Runtime options for Extractor.
  *
  * @public
  */
@@ -62,7 +62,7 @@ export interface IExtractorOptions {
  * Used to invoke the API Extractor tool.
  * @public
  */
-export class ApiExtractor {
+export class Extractor {
   /**
    * The JSON Schema for API Extractor config file (api-extractor-config.schema.json).
    */
@@ -91,7 +91,7 @@ export class ApiExtractor {
       lodash.cloneDeep(ApiExtractor._defaultConfig), config);
 
     return normalized;
-  }
+    }
 
   public constructor (config: IExtractorConfig, options?: IExtractorOptions) {
     this._logger = lodash.merge(lodash.cloneDeep(ApiExtractor._defaultLogger),

libraries/api-extractor/src/index.ts

@@ -10,7 +10,7 @@ declare const packageDescription: void; // tslint:disable-line:no-unused-variabl
 
 export { default as ExternalApiHelper } from './ExternalApiHelper';
 
-export { ApiExtractor, IAnalyzeProjectOptions, IExtractorOptions } from './extractor/ApiExtractor';
+export { Extractor, IAnalyzeProjectOptions, IExtractorOptions } from './extractor/Extractor';
 export {
   IExtractorTsconfigCompilerConfig,
   IExtractorRuntimeCompilerConfig,