@backstage/repo-tools 0.1.1-next.1 → 0.1.1-next.2

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @backstage/repo-tools
 
+## 0.1.1-next.2
+
+### Patch Changes
+
+- 76fc6f7ec8: Updates Api-extractor and api-documenter version
+- Updated dependencies
+  - @backstage/cli-common@0.1.11
+  - @backstage/errors@1.1.4
+
 ## 0.1.1-next.1
 
 ### Patch Changes

package/dist/cjs/{api-reports-8eae9181.cjs.js → api-reports-c87f7f0e.cjs.js}

@@ -79,16 +79,6 @@ var _tokens;
 const tmpDir = paths.resolveTargetRoot(
   "./node_modules/.cache/api-extractor"
 );
-const {
-  PackageJsonLookup
-} = require("@rushstack/node-core-library/lib/PackageJsonLookup");
-const old = PackageJsonLookup.prototype.tryGetPackageJsonFilePathFor;
-PackageJsonLookup.prototype.tryGetPackageJsonFilePathFor = function tryGetPackageJsonFilePathForPatch(path$1) {
-  if (path$1.includes("@material-ui") && !path.dirname(path$1).endsWith("@material-ui")) {
-    return void 0;
-  }
-  return old.call(this, path$1);
-};
 const {
   ApiReportGenerator
 } = require("@microsoft/api-extractor/lib/generators/ApiReportGenerator");
@@ -114,7 +104,7 @@ ApiReportGenerator.generateReviewFileContent = function decoratedGenerateReviewF
     collector.messageRouter,
     (messages) => {
       return messages.filter((message) => {
-        var _a2, _b, _c;
+        var _a2, _b, _c, _d;
         if (message.messageId !== "ae-forgotten-export") {
           return true;
         }
@@ -131,13 +121,17 @@ ApiReportGenerator.generateReviewFileContent = function decoratedGenerateReviewF
             `Failed to find source file in program at path "${message.sourceFilePath}"`
           );
         }
-        const localName = (_a2 = sourceFile.identifiers) == null ? void 0 : _a2.get(symbolName);
+        let localName = (_a2 = sourceFile.identifiers) == null ? void 0 : _a2.get(symbolName);
+        if (!localName) {
+          const [, trimmedSymbolName] = symbolName.match(/(.*)_\d+/) || [];
+          localName = (_b = sourceFile.identifiers) == null ? void 0 : _b.get(trimmedSymbolName);
+        }
         if (!localName) {
           throw new Error(
             `Unable to find local name of "${symbolName}" in ${sourceFile.fileName}`
           );
         }
-        const local = (_b = sourceFile.locals) == null ? void 0 : _b.get(localName);
+        const local = (_c = sourceFile.locals) == null ? void 0 : _c.get(localName);
         if (!local) {
           return true;
         }
@@ -147,7 +141,7 @@ ApiReportGenerator.generateReviewFileContent = function decoratedGenerateReviewF
             `Unable to find type declaration of "${symbolName}" in ${sourceFile.fileName}`
           );
         }
-        const declarations = (_c = type.aliasSymbol) == null ? void 0 : _c.declarations;
+        const declarations = (_d = type.aliasSymbol) == null ? void 0 : _d.declarations;
         if (!declarations || declarations.length === 0) {
           return true;
         }
@@ -190,9 +184,11 @@ async function createTemporaryTsConfig(includedPackageDirs) {
   await fs__default["default"].writeJson(path$1, {
     extends: "./tsconfig.json",
     include: [
+      // These two contain global definitions that are needed for stable API report generation
       ...assetTypeFile,
       ...includedPackageDirs.map((dir) => path.join(dir, "src"))
     ],
+    // we don't exclude node_modules so that we can use the asset-types.d.ts file
     exclude: []
   });
   return path$1;
@@ -308,9 +304,12 @@ async function runApiExtraction({
           enabled: false
         },
         messages: {
+          // Silence compiler warnings, as these will prevent the CI build to work
           compilerMessageReporting: {
             default: {
               logLevel: "none"
+              // These contain absolute file paths, so can't be included in the report
+              // addToApiReportFile: true,
             }
           },
           extractorMessageReporting: {
@@ -332,7 +331,8 @@ async function runApiExtraction({
       },
       configObjectFullPath: projectFolder,
       packageJsonFullPath: path.resolve(projectFolder, "package.json"),
-      tsdocConfigFile: await getTsDocConfig()
+      tsdocConfigFile: await getTsDocConfig(),
+      ignoreMissingEntryPoint: true
     });
     extractorConfig.packageFolder = packageFolder;
     if (!compilerState) {
@@ -610,6 +610,7 @@ async function buildDocs({
       super(parameters);
       this.values = parameters.values;
     }
+    /** @override */
     get kind() {
       return _DocFrontMatter.kind;
     }
@@ -617,6 +618,7 @@ async function buildDocs({
   let DocFrontMatter = _DocFrontMatter;
   DocFrontMatter.kind = "DocFrontMatter";
   const _DocCodeSpanLink = class extends tsdoc.DocLinkTag {
+    /** @override */
     get kind() {
       return _DocCodeSpanLink.kind;
     }
@@ -624,9 +626,12 @@ async function buildDocs({
   let DocCodeSpanLink = _DocCodeSpanLink;
   DocCodeSpanLink.kind = "DocCodeSpanLink";
   class CustomCustomMarkdownEmitter extends CustomMarkdownEmitter.CustomMarkdownEmitter {
+    // Until https://github.com/microsoft/rushstack/issues/2914 gets fixed or we change markdown renderer we need a fix
+    // to render pipe | character correctly.
     getEscapedText(text) {
       return text.replace(/\\/g, "\\\\").replace(/[*#[\]_`~]/g, (x) => `\\${x}`).replace(/---/g, "\\-\\-\\-").replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/\|/g, "&#124;");
     }
+    /** @override */
     writeNode(docNode, context, docNodeSiblings) {
       switch (docNode.kind) {
         case DocFrontMatter.kind: {
@@ -671,6 +676,7 @@ async function buildDocs({
           super.writeNode(docNode, context, docNodeSiblings);
       }
     }
+    /** @override */
     emit(stringBuilder, docNode, options) {
       stringBuilder._chunks.length = 0;
       return super.emit(stringBuilder, docNode, options);
@@ -710,6 +716,10 @@ async function buildDocs({
       }
       return filename;
     }
+    // We don't really get many chances to modify the generated AST
+    // so we hook in wherever we can. In this case we add the front matter
+    // just before writing the breadcrumbs at the top.
+    /** @override */
     _writeBreadcrumb(output, apiItem) {
       let title;
       let description;
@@ -820,6 +830,7 @@ async function buildDocs({
     documenterConfig: {
       outputTarget: "markdown",
       newlineKind: "\n",
+      // De ba dålig kod
       configFilePath: "",
       configFile: {}
     },
@@ -1125,4 +1136,4 @@ function parseArrayOption(value) {
 }
 
 exports.buildApiReports = buildApiReports;
-//# sourceMappingURL=api-reports-8eae9181.cjs.js.map
+//# sourceMappingURL=api-reports-c87f7f0e.cjs.js.map

package/dist/index.cjs.js

@@ -50,7 +50,7 @@ function registerCommands(program) {
     "select some message code to be omited on the API Extractor (comma separated values i.e ae-cyclic-inherit-doc,ae-missing-getter )"
   ).description("Generate an API report for selected packages").action(
     lazy(
-      () => Promise.resolve().then(function () { return require('./cjs/api-reports-8eae9181.cjs.js'); }).then((m) => m.buildApiReports)
+      () => Promise.resolve().then(function () { return require('./cjs/api-reports-c87f7f0e.cjs.js'); }).then((m) => m.buildApiReports)
     )
   );
   program.command("type-deps").description("Find inconsistencies in types of all packages and plugins").action(lazy(() => Promise.resolve().then(function () { return require('./cjs/type-deps-fba15630.cjs.js'); }).then((m) => m.default)));

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/repo-tools",
   "description": "CLI for Backstage repo tooling ",
-  "version": "0.1.1-next.1",
+  "version": "0.1.1-next.2",
   "publishConfig": {
     "access": "public"
   },
@@ -33,8 +33,8 @@
     "@backstage/cli-common": "^0.1.11",
     "@backstage/errors": "^1.1.4",
     "@manypkg/get-packages": "^1.1.3",
-    "@microsoft/api-documenter": "^7.17.11",
-    "@microsoft/api-extractor": "^7.23.0",
+    "@microsoft/api-documenter": "^7.19.27",
+    "@microsoft/api-extractor": "^7.33.7",
     "chalk": "^4.0.0",
     "commander": "^9.1.0",
     "fs-extra": "10.1.0",
@@ -44,7 +44,7 @@
     "ts-node": "^10.0.0"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.22.1-next.1",
+    "@backstage/cli": "^0.22.1-next.2",
     "@types/is-glob": "^4.0.2",
     "@types/mock-fs": "^4.13.0",
     "mock-fs": "^5.1.0"
@@ -53,7 +53,6 @@
     "@microsoft/api-extractor-model": "*",
     "@microsoft/tsdoc": "*",
     "@microsoft/tsdoc-config": "*",
-    "@rushstack/node-core-library": "*",
     "prettier": "^2.8.1",
     "typescript": "> 3.0.0"
   },