@savvy-web/rslib-builder 0.5.0 → 0.7.0

package/README.md

@@ -27,7 +27,8 @@ focus on your code.
 - **Package.json Transform** - Converts `.ts` exports to `.js`, generates files
   array, removes dev-only fields
 - **TSDoc Validation** - Pre-build TSDoc validation with automatic public API discovery
-- **API Model Generation** - Optional API model output for documentation tooling
+- **API Model Generation** - Optional API model and resolved tsconfig output for
+  documentation tooling
 - **Extensible** - Add custom RSlib/Rsbuild plugins for advanced use cases
 
 ## Prerequisites

package/index.d.ts

@@ -119,6 +119,18 @@ export declare interface ApiModelOptions {
      * @defaultValue true (enabled when apiModel is enabled)
      */
     tsdocMetadata?: TsDocMetadataOptions | boolean;
+    /**
+     * Controls handling of API Extractor's "forgotten export" messages.
+     * A forgotten export occurs when a public API references a declaration
+     * that isn't exported from the entry point.
+     *
+     * - `"include"` (default): Log a warning, include in the API model
+     * - `"error"`: Fail the build with details about the forgotten exports
+     * - `"ignore"`: Turn off detection — suppress all messages
+     *
+     * @defaultValue "include"
+     */
+    forgottenExports?: "include" | "error" | "ignore";
 }
 
 /**
@@ -934,7 +946,7 @@ export declare type JsonValue = JsonPrimitive | JsonObject | JsonArray;
  *
  * @public
  */
-declare type LiteralUnion<LiteralType, BaseType extends Primitive> = LiteralType | (BaseType & Record<never, never>);
+export declare type LiteralUnion<LiteralType, BaseType extends Primitive> = LiteralType | (BaseType & Record<never, never>);
 
 /**
  * Builder for Node.js ESM libraries using RSlib.
@@ -1797,13 +1809,13 @@ export declare interface PackageJsonTransformPluginOptions {
  *
  * @public
  */
-declare type Primitive = null | undefined | string | number | boolean | symbol | bigint;
+export declare type Primitive = null | undefined | string | number | boolean | symbol | bigint;
 
 /**
  * Async RSLib configuration function type.
  * @public
  */
-declare type RslibConfigAsyncFn = (env: ConfigParams) => Promise<RslibConfig>;
+export declare type RslibConfigAsyncFn = (env: ConfigParams) => Promise<RslibConfig>;
 
 /**
  * Function to transform package.json during the build process.

package/index.js

@@ -10,7 +10,7 @@ import { getWorkspaceRoot } from "workspace-tools";
 import { spawn } from "node:child_process";
 import { StandardTags, Standardization, TSDocTagSyntaxKind } from "@microsoft/tsdoc";
 import deep_equal from "deep-equal";
-import typescript, { createCompilerHost, findConfigFile, formatDiagnostic, parseJsonConfigFileContent, readConfigFile, sys } from "typescript";
+import typescript, { ImportsNotUsedAsValues, JsxEmit, ModuleDetectionKind, ModuleKind, ModuleResolutionKind, NewLineKind, ScriptTarget, createCompilerHost, findConfigFile, formatDiagnostic, parseJsonConfigFileContent, readConfigFile, sys } from "typescript";
 import { createRequire } from "node:module";
 import { inspect } from "node:util";
 import sort_package_json from "sort-package-json";
@@ -369,6 +369,331 @@ const TSConfigs = {
         }
     }
 };
+const TSCONFIG_SCHEMA_URL = "https://json.schemastore.org/tsconfig";
+const PRESERVED_BOOLEAN_OPTIONS = [
+    "strict",
+    "strictNullChecks",
+    "strictFunctionTypes",
+    "strictBindCallApply",
+    "strictPropertyInitialization",
+    "noImplicitAny",
+    "noImplicitThis",
+    "alwaysStrict",
+    "noUnusedLocals",
+    "noUnusedParameters",
+    "exactOptionalPropertyTypes",
+    "noImplicitReturns",
+    "noFallthroughCasesInSwitch",
+    "noUncheckedIndexedAccess",
+    "noImplicitOverride",
+    "noPropertyAccessFromIndexSignature",
+    "allowUnusedLabels",
+    "allowUnreachableCode",
+    "esModuleInterop",
+    "allowSyntheticDefaultImports",
+    "forceConsistentCasingInFileNames",
+    "resolveJsonModule",
+    "isolatedModules",
+    "verbatimModuleSyntax",
+    "skipLibCheck",
+    "skipDefaultLibCheck",
+    "downlevelIteration",
+    "importHelpers",
+    "preserveConstEnums",
+    "isolatedDeclarations",
+    "allowImportingTsExtensions",
+    "rewriteRelativeImportExtensions",
+    "allowArbitraryExtensions",
+    "useDefineForClassFields",
+    "noLib",
+    "preserveSymlinks"
+];
+const PRESERVED_STRING_OPTIONS = [
+    "jsxFactory",
+    "jsxFragmentFactory",
+    "jsxImportSource",
+    "reactNamespace",
+    "declarationMapBuildInfo"
+];
+class TsconfigResolver {
+    static SCRIPT_TARGET_MAP = new Map([
+        [
+            ScriptTarget.ES3,
+            "es3"
+        ],
+        [
+            ScriptTarget.ES5,
+            "es5"
+        ],
+        [
+            ScriptTarget.ES2015,
+            "es2015"
+        ],
+        [
+            ScriptTarget.ES2016,
+            "es2016"
+        ],
+        [
+            ScriptTarget.ES2017,
+            "es2017"
+        ],
+        [
+            ScriptTarget.ES2018,
+            "es2018"
+        ],
+        [
+            ScriptTarget.ES2019,
+            "es2019"
+        ],
+        [
+            ScriptTarget.ES2020,
+            "es2020"
+        ],
+        [
+            ScriptTarget.ES2021,
+            "es2021"
+        ],
+        [
+            ScriptTarget.ES2022,
+            "es2022"
+        ],
+        [
+            ScriptTarget.ES2023,
+            "es2023"
+        ],
+        [
+            ScriptTarget.ES2024,
+            "es2024"
+        ],
+        [
+            ScriptTarget.ESNext,
+            "esnext"
+        ],
+        [
+            ScriptTarget.JSON,
+            "json"
+        ]
+    ]);
+    static MODULE_KIND_MAP = new Map([
+        [
+            ModuleKind.None,
+            "none"
+        ],
+        [
+            ModuleKind.CommonJS,
+            "commonjs"
+        ],
+        [
+            ModuleKind.AMD,
+            "amd"
+        ],
+        [
+            ModuleKind.UMD,
+            "umd"
+        ],
+        [
+            ModuleKind.System,
+            "system"
+        ],
+        [
+            ModuleKind.ES2015,
+            "es2015"
+        ],
+        [
+            ModuleKind.ES2020,
+            "es2020"
+        ],
+        [
+            ModuleKind.ES2022,
+            "es2022"
+        ],
+        [
+            ModuleKind.ESNext,
+            "esnext"
+        ],
+        [
+            ModuleKind.Node16,
+            "node16"
+        ],
+        [
+            101,
+            "node18"
+        ],
+        [
+            102,
+            "node20"
+        ],
+        [
+            ModuleKind.NodeNext,
+            "nodenext"
+        ],
+        [
+            ModuleKind.Preserve,
+            "preserve"
+        ]
+    ]);
+    static MODULE_RESOLUTION_MAP = new Map([
+        [
+            ModuleResolutionKind.Classic,
+            "classic"
+        ],
+        [
+            ModuleResolutionKind.Node10,
+            "node10"
+        ],
+        [
+            ModuleResolutionKind.Node16,
+            "node16"
+        ],
+        [
+            ModuleResolutionKind.NodeNext,
+            "nodenext"
+        ],
+        [
+            ModuleResolutionKind.Bundler,
+            "bundler"
+        ]
+    ]);
+    static JSX_EMIT_MAP = new Map([
+        [
+            JsxEmit.None,
+            "none"
+        ],
+        [
+            JsxEmit.Preserve,
+            "preserve"
+        ],
+        [
+            JsxEmit.React,
+            "react"
+        ],
+        [
+            JsxEmit.ReactNative,
+            "react-native"
+        ],
+        [
+            JsxEmit.ReactJSX,
+            "react-jsx"
+        ],
+        [
+            JsxEmit.ReactJSXDev,
+            "react-jsxdev"
+        ]
+    ]);
+    static MODULE_DETECTION_MAP = new Map([
+        [
+            ModuleDetectionKind.Legacy,
+            "legacy"
+        ],
+        [
+            ModuleDetectionKind.Auto,
+            "auto"
+        ],
+        [
+            ModuleDetectionKind.Force,
+            "force"
+        ]
+    ]);
+    static NEW_LINE_MAP = new Map([
+        [
+            NewLineKind.CarriageReturnLineFeed,
+            "crlf"
+        ],
+        [
+            NewLineKind.LineFeed,
+            "lf"
+        ]
+    ]);
+    static IMPORTS_NOT_USED_MAP = new Map([
+        [
+            ImportsNotUsedAsValues.Remove,
+            "remove"
+        ],
+        [
+            ImportsNotUsedAsValues.Preserve,
+            "preserve"
+        ],
+        [
+            ImportsNotUsedAsValues.Error,
+            "error"
+        ]
+    ]);
+    static convertScriptTarget(target) {
+        if (void 0 === target) return;
+        const mapped = TsconfigResolver.SCRIPT_TARGET_MAP.get(target);
+        if (void 0 !== mapped) return mapped;
+        return `es${target}`;
+    }
+    static convertModuleKind(module) {
+        if (void 0 === module) return;
+        const mapped = TsconfigResolver.MODULE_KIND_MAP.get(module);
+        if (void 0 !== mapped) return mapped;
+        return String(module);
+    }
+    static convertModuleResolution(resolution) {
+        if (void 0 === resolution) return;
+        const mapped = TsconfigResolver.MODULE_RESOLUTION_MAP.get(resolution);
+        if (void 0 !== mapped) return mapped;
+        return String(resolution);
+    }
+    static convertJsxEmit(jsx) {
+        if (void 0 === jsx) return;
+        const mapped = TsconfigResolver.JSX_EMIT_MAP.get(jsx);
+        if (void 0 !== mapped) return mapped;
+        return String(jsx);
+    }
+    static convertModuleDetection(detection) {
+        if (void 0 === detection) return;
+        const mapped = TsconfigResolver.MODULE_DETECTION_MAP.get(detection);
+        if (void 0 !== mapped) return mapped;
+        return String(detection);
+    }
+    static convertNewLine(newLine) {
+        if (void 0 === newLine) return;
+        const mapped = TsconfigResolver.NEW_LINE_MAP.get(newLine);
+        if (void 0 !== mapped) return mapped;
+        return String(newLine);
+    }
+    static convertImportsNotUsedAsValues(importsNotUsedAsValues) {
+        if (void 0 === importsNotUsedAsValues) return;
+        const mapped = TsconfigResolver.IMPORTS_NOT_USED_MAP.get(importsNotUsedAsValues);
+        if (void 0 !== mapped) return mapped;
+        return String(importsNotUsedAsValues);
+    }
+    static convertLibReference(lib) {
+        const filename = lib.includes("/") || lib.includes("\\") ? lib.split(/[\\/]/).pop() ?? lib : lib;
+        return filename.replace(/^lib\./, "").replace(/\.d\.ts$/, "");
+    }
+    resolve(parsed, rootDir) {
+        const opts = parsed.options;
+        const compilerOptions = {};
+        this.addEnumOptions(compilerOptions, opts);
+        if (opts.lib && opts.lib.length > 0) compilerOptions.lib = opts.lib.map(TsconfigResolver.convertLibReference);
+        compilerOptions.composite = false;
+        compilerOptions.noEmit = true;
+        this.addPreservedBooleanOptions(compilerOptions, opts);
+        this.addPreservedStringOptions(compilerOptions, opts);
+        return {
+            $schema: TSCONFIG_SCHEMA_URL,
+            compilerOptions
+        };
+    }
+    addEnumOptions(compilerOptions, opts) {
+        if (void 0 !== opts.target) compilerOptions.target = TsconfigResolver.convertScriptTarget(opts.target);
+        if (void 0 !== opts.module) compilerOptions.module = TsconfigResolver.convertModuleKind(opts.module);
+        if (void 0 !== opts.moduleResolution) compilerOptions.moduleResolution = TsconfigResolver.convertModuleResolution(opts.moduleResolution);
+        if (void 0 !== opts.moduleDetection) compilerOptions.moduleDetection = TsconfigResolver.convertModuleDetection(opts.moduleDetection);
+        if (void 0 !== opts.jsx) compilerOptions.jsx = TsconfigResolver.convertJsxEmit(opts.jsx);
+        if (void 0 !== opts.newLine) compilerOptions.newLine = TsconfigResolver.convertNewLine(opts.newLine);
+        if (void 0 !== opts.importsNotUsedAsValues) compilerOptions.importsNotUsedAsValues = TsconfigResolver.convertImportsNotUsedAsValues(opts.importsNotUsedAsValues);
+    }
+    addPreservedBooleanOptions(compilerOptions, opts) {
+        for (const opt of PRESERVED_BOOLEAN_OPTIONS)if (void 0 !== opts[opt]) compilerOptions[opt] = opts[opt];
+    }
+    addPreservedStringOptions(compilerOptions, opts) {
+        for (const opt of PRESERVED_STRING_OPTIONS)if (void 0 !== opts[opt]) compilerOptions[opt] = opts[opt];
+    }
+}
 class TsDocConfigBuilder {
     static ALL_GROUPS = [
         "core",
@@ -528,6 +853,7 @@ async function bundleDtsFiles(options) {
     const tsdocOptions = "object" == typeof apiModel ? apiModel.tsdoc : void 0;
     const tsdocMetadataOption = "object" == typeof apiModel ? apiModel.tsdocMetadata : void 0;
     const tsdocWarnings = tsdocOptions?.warnings ?? (TsDocConfigBuilder.isCI() ? "fail" : "log");
+    const forgottenExports = ("object" == typeof apiModel ? apiModel.forgottenExports : void 0) ?? "include";
     const tsdocMetadataEnabled = apiModelEnabled && (void 0 === tsdocMetadataOption || true === tsdocMetadataOption || "object" == typeof tsdocMetadataOption && false !== tsdocMetadataOption.enabled);
     const tsdocMetadataFilename = "object" == typeof tsdocMetadataOption && tsdocMetadataOption.filename ? tsdocMetadataOption.filename : "tsdoc-metadata.json";
     getApiExtractorPath();
@@ -568,6 +894,7 @@ async function bundleDtsFiles(options) {
             configObject: {
                 projectFolder: cwd,
                 mainEntryPointFilePath: tempDtsPath,
+                enumMemberOrder: "preserve",
                 compiler: {
                     tsconfigFilePath: tsconfigPath
                 },
@@ -590,6 +917,7 @@ async function bundleDtsFiles(options) {
             tsdocConfigFile: tsdocConfigFile
         });
         const collectedTsdocWarnings = [];
+        const collectedForgottenExports = [];
         const extractorResult = Extractor.invoke(extractorConfig, {
             localBuild: true,
             showVerboseMessages: false,
@@ -613,17 +941,27 @@ async function bundleDtsFiles(options) {
                     });
                     message.logLevel = "none";
                 }
+                if ("ae-forgotten-export" === message.messageId && message.text) if ("ignore" === forgottenExports) message.logLevel = "none";
+                else {
+                    collectedForgottenExports.push({
+                        text: message.text,
+                        sourceFilePath: message.sourceFilePath,
+                        sourceFileLine: message.sourceFileLine,
+                        sourceFileColumn: message.sourceFileColumn
+                    });
+                    message.logLevel = "none";
+                }
             }
         });
         if (!extractorResult.succeeded) throw new Error(`API Extractor failed for entry "${entryName}"`);
+        const formatWarning = (warning)=>{
+            const location = warning.sourceFilePath ? `${picocolors.cyan((0, external_node_path_.relative)(cwd, warning.sourceFilePath))}${warning.sourceFileLine ? `:${warning.sourceFileLine}` : ""}${warning.sourceFileColumn ? `:${warning.sourceFileColumn}` : ""}` : null;
+            return location ? `${location}: ${picocolors.yellow(warning.text)}` : picocolors.yellow(warning.text);
+        };
         if (collectedTsdocWarnings.length > 0) {
             const isThirdParty = (warning)=>warning.sourceFilePath?.includes("node_modules/") ?? false;
             const firstPartyWarnings = collectedTsdocWarnings.filter((w)=>!isThirdParty(w));
             const thirdPartyWarnings = collectedTsdocWarnings.filter(isThirdParty);
-            const formatWarning = (warning)=>{
-                const location = warning.sourceFilePath ? `${picocolors.cyan((0, external_node_path_.relative)(cwd, warning.sourceFilePath))}${warning.sourceFileLine ? `:${warning.sourceFileLine}` : ""}${warning.sourceFileColumn ? `:${warning.sourceFileColumn}` : ""}` : null;
-                return location ? `${location}: ${picocolors.yellow(warning.text)}` : picocolors.yellow(warning.text);
-            };
             if (thirdPartyWarnings.length > 0) {
                 const thirdPartyMessages = thirdPartyWarnings.map(formatWarning).join("\n  ");
                 core_logger.warn(`TSDoc warnings from dependencies for entry "${entryName}" (cannot be fixed, bundled types may have documentation issues):\n  ${thirdPartyMessages}`);
@@ -634,6 +972,11 @@ async function bundleDtsFiles(options) {
                 if ("log" === tsdocWarnings) core_logger.warn(`TSDoc warnings for entry "${entryName}":\n  ${firstPartyMessages}`);
             }
         }
+        if (collectedForgottenExports.length > 0) {
+            const forgottenMessages = collectedForgottenExports.map(formatWarning).join("\n  ");
+            if ("error" === forgottenExports) throw new Error(`Forgotten exports detected for entry "${entryName}":\n  ${forgottenMessages}`);
+            if ("include" === forgottenExports) core_logger.warn(`Forgotten exports for entry "${entryName}":\n  ${forgottenMessages}`);
+        }
         if (generateApiModel && tempApiModelPath) apiModelPath = tempApiModelPath;
         if (generateTsdocMetadata && tempTsdocMetadataPath) tsdocMetadataPath = tempTsdocMetadataPath;
         if (banner || footer) {
@@ -885,7 +1228,7 @@ function runTsgo(options) {
                             if (apiModelPath) {
                                 const defaultApiModelFilename = packageJson.name ? `${getUnscopedPackageName(packageJson.name)}.api.json` : "api.json";
                                 const apiModelFilename = "object" == typeof options.apiModel && options.apiModel.filename ? options.apiModel.filename : defaultApiModelFilename;
-                                const apiModelContent = await readFile(apiModelPath, "utf-8");
+                                const apiModelContent = (await readFile(apiModelPath, "utf-8")).replaceAll("\r\n", "\n");
                                 const apiModelSource = new context.sources.OriginalSource(apiModelContent, apiModelFilename);
                                 context.compilation.emitAsset(apiModelFilename, apiModelSource);
                                 if (filesArray) filesArray.add(`!${apiModelFilename}`);
@@ -900,6 +1243,7 @@ function runTsgo(options) {
                                         apiModelFilename,
                                         localTsdocFilename,
                                         hasTsdocMetadata: !!tsdocMetadataPath,
+                                        hasTsconfig: !!state.parsedConfig && !!state.tsconfigPath,
                                         cwd,
                                         distPath: `dist/${envId}`
                                     });
@@ -908,19 +1252,28 @@ function runTsgo(options) {
                             if (tsdocMetadataPath) {
                                 const tsdocMetadataOption = "object" == typeof options.apiModel ? options.apiModel.tsdocMetadata : void 0;
                                 const tsdocMetadataFilename = "object" == typeof tsdocMetadataOption && tsdocMetadataOption.filename ? tsdocMetadataOption.filename : "tsdoc-metadata.json";
-                                const tsdocMetadataContent = await readFile(tsdocMetadataPath, "utf-8");
+                                const tsdocMetadataContent = (await readFile(tsdocMetadataPath, "utf-8")).replaceAll("\r\n", "\n");
                                 const tsdocMetadataSource = new context.sources.OriginalSource(tsdocMetadataContent, tsdocMetadataFilename);
                                 context.compilation.emitAsset(tsdocMetadataFilename, tsdocMetadataSource);
                                 if (filesArray) filesArray.add(tsdocMetadataFilename);
                                 core_logger.info(`${picocolors.dim(`[${envId}]`)} Emitted TSDoc metadata: ${tsdocMetadataFilename}`);
                             }
                             if (tsdocConfigPath) {
-                                const tsdocConfigContent = await readFile(tsdocConfigPath, "utf-8");
+                                const tsdocConfigContent = (await readFile(tsdocConfigPath, "utf-8")).replaceAll("\r\n", "\n");
                                 const tsdocConfigSource = new context.sources.OriginalSource(tsdocConfigContent, "tsdoc.json");
                                 context.compilation.emitAsset("tsdoc.json", tsdocConfigSource);
                                 if (filesArray) filesArray.add("!tsdoc.json");
                                 core_logger.info(`${picocolors.dim(`[${envId}]`)} Emitted TSDoc config: tsdoc.json (excluded from npm publish)`);
                             }
+                            if (apiModelPath && state.parsedConfig && state.tsconfigPath) {
+                                const resolver = new TsconfigResolver();
+                                const resolvedTsconfig = resolver.resolve(state.parsedConfig, cwd);
+                                const tsconfigContent = `${JSON.stringify(resolvedTsconfig, null, "\t")}\n`;
+                                const tsconfigSource = new context.sources.OriginalSource(tsconfigContent, "tsconfig.json");
+                                context.compilation.emitAsset("tsconfig.json", tsconfigSource);
+                                if (filesArray) filesArray.add("!tsconfig.json");
+                                core_logger.info(`${picocolors.dim(`[${envId}]`)} Emitted resolved tsconfig: tsconfig.json (excluded from npm publish)`);
+                            }
                             for (const [entryName] of bundledFiles){
                                 const bundledFileName = `${entryName}.d.ts`;
                                 const mapFileName = `${bundledFileName}.map`;
@@ -978,7 +1331,7 @@ function runTsgo(options) {
             api.onCloseBuild(async ()=>{
                 const localPathsData = api.useExposed("dts-local-paths-data");
                 if (!localPathsData) return;
-                const { localPaths, apiModelFilename, localTsdocFilename, hasTsdocMetadata, cwd, distPath } = localPathsData;
+                const { localPaths, apiModelFilename, localTsdocFilename, hasTsdocMetadata, hasTsconfig, cwd, distPath } = localPathsData;
                 const distDir = (0, external_node_path_.join)(cwd, distPath);
                 for (const localPath of localPaths){
                     const resolvedPath = (0, external_node_path_.join)(cwd, localPath);
@@ -1002,6 +1355,14 @@ function runTsgo(options) {
                             name: localTsdocFilename
                         });
                     }
+                    if (hasTsconfig) {
+                        const tsconfigSrc = (0, external_node_path_.join)(distDir, "tsconfig.json");
+                        if (existsSync(tsconfigSrc)) filesToCopy.push({
+                            src: tsconfigSrc,
+                            dest: (0, external_node_path_.join)(resolvedPath, "tsconfig.json"),
+                            name: "tsconfig.json"
+                        });
+                    }
                     const packageJsonSrc = (0, external_node_path_.join)(distDir, "package.json");
                     if (existsSync(packageJsonSrc)) filesToCopy.push({
                         src: packageJsonSrc,

package/package.json

@@ -1,9 +1,28 @@
 {
 	"name": "@savvy-web/rslib-builder",
-	"version": "0.5.0",
+	"version": "0.7.0",
 	"private": false,
 	"description": "RSlib-based build system for Node.js libraries with automatic package.json transformation, TypeScript declaration bundling, and multi-target support",
+	"keywords": [
+		"rslib",
+		"rsbuild",
+		"typescript",
+		"declarations",
+		"dts",
+		"bundler",
+		"build",
+		"esm",
+		"node",
+		"library",
+		"api-extractor",
+		"tsgo",
+		"tsdoc",
+		"monorepo"
+	],
 	"homepage": "https://github.com/savvy-web/rslib-builder",
+	"bugs": {
+		"url": "https://github.com/savvy-web/rslib-builder/issues"
+	},
 	"repository": {
 		"type": "git",
 		"url": "https://github.com/savvy-web/rslib-builder.git"
@@ -64,6 +83,7 @@
 	},
 	"files": [
 		"!rslib-builder.api.json",
+		"!tsconfig.json",
 		"LICENSE",
 		"README.md",
 		"index.d.ts",

package/tsdoc-metadata.json

@@ -1,11 +1,11 @@
-// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
-// It should be published with your NPM package.  It should not be tracked by Git.
-{
-  "tsdocVersion": "0.12",
-  "toolPackages": [
-    {
-      "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.55.2"
-    }
-  ]
-}
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.55.2"
+    }
+  ]
+}