@backstage/repo-tools 0.2.0 → 0.3.0

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @backstage/repo-tools
 
+## 0.3.0
+
+### Minor Changes
+
+- 799c33047ed: **BREAKING**: The OpenAPI commands are now found within the `schema openapi` sub-command. For example `yarn backstage-repo-tools schema:openapi:verify` is now `yarn backstage-repo-tools schema openapi verify`.
+- 27956d78671: Generated OpenAPI files now have a `.generated.ts` file name and a warning header at the top, to highlight that they should not be edited by hand.
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/cli-common@0.1.12
+  - @backstage/cli-node@0.1.0
+  - @backstage/errors@1.1.5
+
+## 0.3.0-next.0
+
+### Minor Changes
+
+- 27956d78671: Generated OpenAPI files now have a `.generated.ts` file name and a warning header at the top, to highlight that they should not be edited by hand.
+
 ## 0.2.0
 
 ### Minor Changes

package/dist/cjs/{constants-d6934676.cjs.js → constants-2eebdd79.cjs.js}

@@ -32,11 +32,11 @@ async function runner(paths$1, command) {
 }
 
 const YAML_SCHEMA_PATH = "src/schema/openapi.yaml";
-const TS_MODULE = "src/schema/openapi";
+const TS_MODULE = "src/schema/openapi.generated";
 const TS_SCHEMA_PATH = `${TS_MODULE}.ts`;
 
 exports.TS_MODULE = TS_MODULE;
 exports.TS_SCHEMA_PATH = TS_SCHEMA_PATH;
 exports.YAML_SCHEMA_PATH = YAML_SCHEMA_PATH;
 exports.runner = runner;
-//# sourceMappingURL=constants-d6934676.cjs.js.map
+//# sourceMappingURL=constants-2eebdd79.cjs.js.map

package/dist/cjs/{generate-9b41d8d7.cjs.js → generate-6f0190dd.cjs.js}

@@ -4,10 +4,10 @@ var fs = require('fs-extra');
 var YAML = require('js-yaml');
 var chalk = require('chalk');
 var path = require('path');
-var constants = require('./constants-d6934676.cjs.js');
+var paths = require('./paths-9ab9b8a8.cjs.js');
+var constants = require('./constants-2eebdd79.cjs.js');
 var util = require('util');
 var child_process = require('child_process');
-require('./paths-9ab9b8a8.cjs.js');
 require('@backstage/cli-common');
 require('@backstage/cli-node');
 require('minimatch');
@@ -33,9 +33,18 @@ async function generate(directoryPath, config) {
   const tsPath = path.resolve(directoryPath, constants.TS_SCHEMA_PATH);
   await fs__default["default"].writeFile(
     tsPath,
-    `export default ${JSON.stringify(yaml, null, 2)} as const`
+    `//
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+
+export default ${JSON.stringify(yaml, null, 2)} as const;`
   );
   await exec(`yarn backstage-cli package lint --fix ${tsPath}`);
+  if (await paths.paths.resolveTargetRoot("node_modules/.bin/prettier")) {
+    await exec(`yarn prettier --write ${tsPath}`);
+  }
 }
 async function bulkCommand(paths = []) {
   const resultsList = await constants.runner(
@@ -63,4 +72,4 @@ async function bulkCommand(paths = []) {
 }
 
 exports.bulkCommand = bulkCommand;
-//# sourceMappingURL=generate-9b41d8d7.cjs.js.map
+//# sourceMappingURL=generate-6f0190dd.cjs.js.map

package/dist/cjs/{verify-be04e091.cjs.js → verify-46e56357.cjs.js}

@@ -6,7 +6,7 @@ var lodash = require('lodash');
 var path = require('path');
 var chalk = require('chalk');
 var Parser = require('@apidevtools/swagger-parser');
-var constants = require('./constants-d6934676.cjs.js');
+var constants = require('./constants-2eebdd79.cjs.js');
 var paths = require('./paths-9ab9b8a8.cjs.js');
 require('p-limit');
 require('@backstage/cli-common');
@@ -56,7 +56,7 @@ async function verify(directoryPath) {
   if (!lodash.isEqual(schema.default, yaml)) {
     const path$1 = path.relative(paths.paths.targetRoot, directoryPath);
     throw new Error(
-      `\`${constants.YAML_SCHEMA_PATH}\` and \`${constants.TS_SCHEMA_PATH}\` do not match. Please run \`yarn backstage-repo-tools schema:openapi:generate ${path$1}\` to regenerate \`${constants.TS_SCHEMA_PATH}\`.`
+      `\`${constants.YAML_SCHEMA_PATH}\` and \`${constants.TS_SCHEMA_PATH}\` do not match. Please run \`yarn backstage-repo-tools schema openapi generate ${path$1}\` to regenerate \`${constants.TS_SCHEMA_PATH}\`.`
     );
   }
 }
@@ -79,4 +79,4 @@ async function bulkCommand(paths = []) {
 }
 
 exports.bulkCommand = bulkCommand;
-//# sourceMappingURL=verify-be04e091.cjs.js.map
+//# sourceMappingURL=verify-46e56357.cjs.js.map

package/dist/index.cjs.js

@@ -37,6 +37,16 @@ ${chalk__default["default"].red(`${error}`)}
   }
 }
 
+function registerSchemaCommand(program) {
+  const command = program.command("schema [command]").description("Various tools for working with API schema");
+  const openApiCommand = command.command("openapi [command]").description("Tooling for OpenApi schema");
+  openApiCommand.command("verify [paths...]").description(
+    "Verify that all OpenAPI schemas are valid and have a matching `schemas/openapi.generated.ts` file."
+  ).action(lazy(() => Promise.resolve().then(function () { return require('./cjs/verify-46e56357.cjs.js'); }).then((m) => m.bulkCommand)));
+  openApiCommand.command("generate [paths...]").description(
+    "Generates a Typescript file from an OpenAPI yaml spec. For use with the `@backstage/backend-openapi-utils` ApiRouter type."
+  ).action(lazy(() => Promise.resolve().then(function () { return require('./cjs/generate-6f0190dd.cjs.js'); }).then((m) => m.bulkCommand)));
+}
 function registerCommands(program) {
   program.command("api-reports [paths...]").option("--ci", "CI run checks that there is no changes on API reports").option("--tsc", "executes the tsc compilation before extracting the APIs").option("--docs", "generates the api documentation").option(
     "--include <pattern>",
@@ -65,12 +75,7 @@ function registerCommands(program) {
     )
   );
   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-5eacd931.cjs.js'); }).then((m) => m.default)));
-  program.command("schema:openapi:verify [paths...]").description(
-    "Verify that all OpenAPI schemas are valid and have a matching `schemas/openapi.ts` file."
-  ).action(lazy(() => Promise.resolve().then(function () { return require('./cjs/verify-be04e091.cjs.js'); }).then((m) => m.bulkCommand)));
-  program.command("schema:openapi:generate [paths...]").description(
-    "Generates a Typescript file from an OpenAPI yaml spec. For use with the `@backstage/backend-openapi-utils` ApiRouter type."
-  ).action(lazy(() => Promise.resolve().then(function () { return require('./cjs/generate-9b41d8d7.cjs.js'); }).then((m) => m.bulkCommand)));
+  registerSchemaCommand(program);
 }
 function lazy(getActionFunc) {
   return async (...args) => {
@@ -85,7 +90,7 @@ function lazy(getActionFunc) {
   };
 }
 
-var version = "0.2.0";
+var version = "0.3.0";
 
 const main = (argv) => {
   commander.program.name("backstage-repo-tools").version(version);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/repo-tools",
   "description": "CLI for Backstage repo tooling ",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "publishConfig": {
     "access": "public"
   },
@@ -49,7 +49,7 @@
     "ts-node": "^10.0.0"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.22.6",
+    "@backstage/cli": "^0.22.7",
     "@backstage/types": "^1.0.2",
     "@types/is-glob": "^4.0.2",
     "@types/mock-fs": "^4.13.0",