tools/api-extractor-base.json at main · ai-plugin-marketplace/tools · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
{
  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",

  /**
   * Shared API Extractor base config. Each library package extends this with
   * `"extends": "../../api-extractor-base.json"` and overrides only
   * `mainEntryPointFilePath` (re-anchored to its own `<projectFolder>`) plus
   * `projectFolder: "."`.
   *
   * Per the architecture spec (docs/specs/architecture.md §8.1), only the
   * `@ai-plugin-marketplace/core` library package wires this up. The `cli`
   * package is an application with a `bin` and no public library API surface,
   * so it intentionally does NOT use API Extractor.
   */

  "mainEntryPointFilePath": "<projectFolder>/dist/index.d.ts",

  "apiReport": {
    "enabled": true,
    "reportFolder": "<projectFolder>/api-report/",
    "reportFileName": "<unscopedPackageName>.api.md"
  },

  "docModel": {
    "enabled": true,
    "apiJsonFilePath": "<projectFolder>/temp/<unscopedPackageName>.api.json"
  },

  "dtsRollup": {
    "enabled": true,
    "publicTrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>.d.ts"
  },

  "tsdocMetadata": {
    "enabled": false
  },

  "messages": {
    "compilerMessageReporting": {
      "default": {
        "logLevel": "warning"
      }
    },

    "extractorMessageReporting": {
      "default": {
        "logLevel": "warning"
      },
      "ae-missing-release-tag": {
        "logLevel": "error",
        "addToApiReportFile": true
      },
      "ae-unresolved-link": {
        "logLevel": "error",
        "addToApiReportFile": true
      },
      "ae-forgotten-export": {
        "logLevel": "error",
        "addToApiReportFile": true
      }
    },

    "tsdocMessageReporting": {
      "default": {
        "logLevel": "warning"
      }
    }
  }
}