api-extractor.json

{
  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",

  // "extends": "./shared/api-extractor-base.json"
  // "extends": "my-package/include/api-extractor-base.json"

  // "projectFolder": "..",

  "mainEntryPointFilePath": "<projectFolder>/lib/cjs-modern/index.d.ts",

  "bundledPackages": [],

  "compiler": {
    "tsconfigFilePath": "<projectFolder>/tsconfig.json"

    // "overrideTsconfig": {
    //   . . .
    // }

    // "skipLibCheck": true,
  },

  "apiReport": {
    "enabled": false

    // "reportFileName": "<unscopedPackageName>.api.md",

    // "reportFolder": "<projectFolder>/etc/",

    // "reportTempFolder": "<projectFolder>/api/temp/"
  },

  "docModel": {
    "enabled": true

    // "apiJsonFilePath": "<projectFolder>/temp/<unscopedPackageName>.api.json"
  },

  "dtsRollup": {
    "enabled": true,

    "untrimmedFilePath": "",

    // "betaTrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>-beta.d.ts",

    "publicTrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>.d.ts"

    // "omitTrimmingComments": true
  },

  "tsdocMetadata": {
    "enabled": true,

    "tsdocMetadataFilePath": "<projectFolder>/dist/tsdoc-metadata.json"
  },

  // "newlineKind": "crlf",

  "messages": {
    /**
     * Configures handling of diagnostic messages reported by the TypeScript compiler engine while analyzing
     * the input .d.ts files.
     *
     * TypeScript message identifiers start with "TS" followed by an integer.  For example: "TS2551"
     *
     * DEFAULT VALUE:  A single "default" entry with logLevel=warning.
     */
    "compilerMessageReporting": {
      "default": {
        "logLevel": "warning"

        // "addToApiReportFile": false
      }

      // "TS2551": {
      //   "logLevel": "warning",
      //   "addToApiReportFile": true
      // },
      //
      // . . .
    },

    "extractorMessageReporting": {
      "default": {
        "logLevel": "warning"
        // "addToApiReportFile": false
      }

      // "ae-extra-release-tag": {
      //   "logLevel": "warning",
      //   "addToApiReportFile": true
      // },
      //
      // . . .
    },

    "tsdocMessageReporting": {
      "default": {
        "logLevel": "warning"
        // "addToApiReportFile": false
      }

      // "tsdoc-link-tag-unescaped-text": {
      //   "logLevel": "warning",
      //   "addToApiReportFile": true
      // },
      //
      // . . .
    }
  }
}