@backstage/repo-tools 0.1.0-next.2 → 0.1.0

package/CHANGELOG.md

@@ -1,5 +1,33 @@
 # @backstage/repo-tools
 
+## 0.1.0
+
+### Minor Changes
+
+- 99713fd671: Introducing repo-tools package
+- 03843259b4: Api reference documentation improvements
+
+  - breadcrumbs links semantics as code spans
+  - new `@config` annotation to describe related config keys
+
+### Patch Changes
+
+- 9b1193f277: declare dependencies
+- a8611bcac4: Add new command options to the `api-report`
+
+  - added `--allow-warnings`, `-a` to continue processing packages if selected packages have warnings
+  - added `--allow-all-warnings` to continue processing packages any packages have warnings
+  - added `--omit-messages`, `-o` to pass some warnings messages code to be omitted from the api-report.md files
+  - The `paths` argument for this command now takes as default the value on `workspaces.packages` inside the root package.json
+  - change the path resolution to use the `@backstage/cli-common` packages instead
+
+- 25ec5c0c3a: Include asset-types.d.ts while running the api report command
+- 71f80eb354: add the command type-deps to the repo tool package.
+- ac440299ef: Updated api docs generation to be compatible with Docusaurus 2-alpha and 2.x.
+- Updated dependencies
+  - @backstage/errors@1.1.4
+  - @backstage/cli-common@0.1.11
+
 ## 0.1.0-next.2
 
 ### Patch Changes

package/dist/cjs/{api-reports-bc48eddc.cjs.js → api-reports-ab9d0a66.cjs.js}

@@ -3,7 +3,6 @@
 var fs = require('fs-extra');
 var path = require('path');
 var child_process = require('child_process');
-var prettier = require('prettier');
 var apiExtractor = require('@microsoft/api-extractor');
 var tsdoc = require('@microsoft/tsdoc');
 var tsdocConfig = require('@microsoft/tsdoc-config');
@@ -22,7 +21,6 @@ var minimatch = require('minimatch');
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
 var fs__default = /*#__PURE__*/_interopDefaultLegacy(fs);
-var prettier__default = /*#__PURE__*/_interopDefaultLegacy(prettier);
 var g__default = /*#__PURE__*/_interopDefaultLegacy(g);
 var isGlob__default = /*#__PURE__*/_interopDefaultLegacy(isGlob);
 var minimatch__default = /*#__PURE__*/_interopDefaultLegacy(minimatch);
@@ -111,12 +109,13 @@ function patchFileMessageFetcher(router, transform) {
 }
 const originalGenerateReviewFileContent = ApiReportGenerator.generateReviewFileContent;
 ApiReportGenerator.generateReviewFileContent = function decoratedGenerateReviewFileContent(collector, ...moreArgs) {
+  var _a;
   const program = collector.program;
   patchFileMessageFetcher(
     collector.messageRouter,
     (messages) => {
       return messages.filter((message) => {
-        var _a, _b, _c;
+        var _a2, _b, _c;
         if (message.messageId !== "ae-forgotten-export") {
           return true;
         }
@@ -133,7 +132,7 @@ ApiReportGenerator.generateReviewFileContent = function decoratedGenerateReviewF
             `Failed to find source file in program at path "${message.sourceFilePath}"`
           );
         }
-        const localName = (_a = sourceFile.identifiers) == null ? void 0 : _a.get(symbolName);
+        const localName = (_a2 = sourceFile.identifiers) == null ? void 0 : _a2.get(symbolName);
         if (!localName) {
           throw new Error(
             `Unable to find local name of "${symbolName}" in ${sourceFile.fileName}`
@@ -166,22 +165,36 @@ ApiReportGenerator.generateReviewFileContent = function decoratedGenerateReviewF
     collector,
     ...moreArgs
   );
-  return prettier__default["default"].format(content, {
-    ...require("@spotify/prettier-config"),
-    parser: "markdown"
-  });
+  try {
+    const prettier = require("prettier");
+    const config = (_a = prettier.resolveConfig.sync(paths.targetRoot)) != null ? _a : {};
+    return prettier.format(content, {
+      ...config,
+      parser: "markdown"
+    });
+  } catch (e) {
+    return content;
+  }
 };
 async function createTemporaryTsConfig(includedPackageDirs) {
   const path$1 = paths.resolveTargetRoot("tsconfig.tmp.json");
   process.once("exit", () => {
     fs__default["default"].removeSync(path$1);
   });
+  let assetTypeFile = [];
+  try {
+    assetTypeFile = [
+      require.resolve("@backstage/cli/asset-types/asset-types.d.ts")
+    ];
+  } catch {
+  }
   await fs__default["default"].writeJson(path$1, {
     extends: "./tsconfig.json",
     include: [
-      "packages/cli/asset-types/asset-types.d.ts",
+      ...assetTypeFile,
       ...includedPackageDirs.map((dir) => path.join(dir, "src"))
-    ]
+    ],
+    exclude: []
   });
   return path$1;
 }
@@ -622,7 +635,9 @@ async function buildDocs({
           context.writer.writeLine("---");
           for (const [name, value] of Object.entries(node.values)) {
             if (value) {
-              context.writer.writeLine(`${name}: ${value}`);
+              context.writer.writeLine(
+                `${name}: "${String(value).replace(/\"/g, "")}"`
+              );
             }
           }
           context.writer.writeLine("---");
@@ -1111,4 +1126,4 @@ function parseArrayOption(value) {
 }
 
 exports.buildApiReports = buildApiReports;
-//# sourceMappingURL=api-reports-bc48eddc.cjs.js.map
+//# sourceMappingURL=api-reports-ab9d0a66.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-bc48eddc.cjs.js'); }).then((m) => m.buildApiReports)
+      () => Promise.resolve().then(function () { return require('./cjs/api-reports-ab9d0a66.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.0-next.2",
+  "version": "0.1.0",
   "publishConfig": {
     "access": "public"
   },
@@ -30,13 +30,14 @@
     "backstage-repo-tools": "bin/backstage-repo-tools"
   },
   "dependencies": {
-    "@backstage/cli-common": "^0.1.11-next.0",
-    "@backstage/errors": "^1.1.4-next.1",
+    "@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-extractor-model": "^7.17.2",
     "@microsoft/tsdoc": "0.14.1",
+    "@microsoft/tsdoc-config": "0.16.1",
     "chalk": "^4.0.0",
     "commander": "^9.1.0",
     "fs-extra": "10.1.0",
@@ -46,11 +47,21 @@
     "ts-node": "^10.0.0"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.22.0-next.4",
+    "@backstage/cli": "^0.22.0",
     "@types/is-glob": "^4.0.2",
     "@types/mock-fs": "^4.13.0",
     "mock-fs": "^5.1.0"
   },
+  "peerDependencies": {
+    "@rushstack/node-core-library": "*",
+    "prettier": "^2.8.1",
+    "typescript": "> 3.0.0"
+  },
+  "peerDependenciesMeta": {
+    "prettier": {
+      "optional": true
+    }
+  },
   "files": [
     "bin",
     "dist/**/*.js"