chore: api-extractor no longer supports filename "api.md"

zwave-js · Jul 5, 2024 · 1739a42 · 1739a42
1 parent 0881730
commit 1739a42
Show file tree

Hide file tree

Showing 12 changed files with 4,298 additions and 3,579 deletions.
diff --git a/.dprint.jsonc b/.dprint.jsonc
@@ -58,7 +58,7 @@
 		".yarn/releases",
 		".tmp/",
 		"cache/",
-		"packages/*/api.md",
+		"packages/*/*.api.md",
 		"CHANGELOG*.md",
 		".yarnrc.yml",
 	],

diff --git a/.github/action-scripts/generateTypedDocs.js b/.github/action-scripts/generateTypedDocs.js
@@ -13,7 +13,7 @@ const branchName = "docs/update-typed-docs";
 const reviewers = ["AlCalzone"];
 const assignees = [];
 
-const checkPaths = ["docs/", "packages/*/api.md"];
+const checkPaths = ["docs/", "packages/*/*.api.md"];
 
 /**
  * @param {{github: Github, context: Context}} param

diff --git a/api-extractor-base.json b/api-extractor-base.json
@@ -145,7 +145,7 @@
 		 * SUPPORTED TOKENS: <packageName>, <unscopedPackageName>
 		 * DEFAULT VALUE: "<unscopedPackageName>.api.md"
 		 */
-		"reportFileName": "api.md",
+		// "reportFileName": "<unscopedPackageName>.api.md",
 
 		/**
 		 * Specifies the folder where the API report file is written.  The file name portion is determined by