Add tsconfigFilePath to api-extractor-defaults.json and api-extractor.schema.json and IConfigFile

octogonz · octogonz · commit 9ba1d36085d7 · 2019-04-10T22:03:33.000-07:00
diff --git a/apps/api-extractor/src/api/IConfigFile.ts b/apps/api-extractor/src/api/IConfigFile.ts
@@ -12,6 +12,16 @@ import { ExtractorLogLevel } from './ExtractorLogLevel';
  * @public
  */
 export interface IConfigCompiler {
+  /**
+   * Specifies the path to the tsconfig.json file to be used by API Extractor when analyzing the project.
+   *
+   * @remarks
+   * The path is resolved relative to the folder of the config file that contains the setting; to change this,
+   * prepend a folder token such as `<projectFolder>`.
+   *
+   * Note: This setting will be ignored if `overrideTsconfig` is used.
+   */
+  tsconfigFilePath?: string;
 
   /**
    * Provides already parsed tsconfig.json contents.
diff --git a/apps/api-extractor/src/schemas/api-extractor-defaults.json b/apps/api-extractor/src/schemas/api-extractor-defaults.json
@@ -4,6 +4,7 @@
   "projectFolder": "<lookup>",
 
   "compiler": {
+    "tsconfigFilePath": "<projectFolder>/tsconfig.json",
     "skipLibCheck": false
   },
 
diff --git a/apps/api-extractor/src/schemas/api-extractor.schema.json b/apps/api-extractor/src/schemas/api-extractor.schema.json
@@ -27,6 +27,10 @@
       "description": "Determines how the TypeScript compiler engine will be invoked by API Extractor.",
       "type": "object",
       "properties": {
+        "tsconfigFilePath": {
+          "description": " Specifies the path to the tsconfig.json file to be used by API Extractor when analyzing the project.  The path is resolved relative to the folder of the config file that contains the setting; to change this, prepend a folder token such as \"<projectFolder>\".  Note: This setting will be ignored if \"overrideTsconfig\" is used.",
+          "type": "string"
+        },
         "overrideTsconfig": {
           "description": "Provides already parsed tsconfig.json contents conforming to the TypeScript tsconfig schema: http://json.schemastore.org/tsconfig If omitted, then the tsconfig.json file will be read from the \"projectFolder\".",
           "type": "object"
