@backstage/repo-tools 0.3.0 → 0.3.1

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # @backstage/repo-tools
 
+## 0.3.1
+
+### Patch Changes
+
+- ee411e7c2623: Adding a new command `schema openapi lint` to lint your OpenAPI specs and ensure consistent style across Backstage plugins.
+- Updated dependencies
+  - @backstage/errors@1.2.0
+  - @backstage/cli-common@0.1.12
+  - @backstage/cli-node@0.1.1
+
+## 0.3.1-next.0
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/errors@1.2.0-next.0
+  - @backstage/cli-node@0.1.1-next.0
+  - @backstage/cli-common@0.1.12
+
 ## 0.3.0
 
 ### Minor Changes

package/dist/cjs/lint-d126add4.cjs.js

@@ -0,0 +1,94 @@
+'use strict';
+
+var spectralCore = require('@stoplight/spectral-core');
+var spectralParsers = require('@stoplight/spectral-parsers');
+var ruleset = require('@apisyouwonthate/style-guide');
+var fs = require('fs-extra');
+var chalk = require('chalk');
+var path = require('path');
+var constants = require('./constants-2eebdd79.cjs.js');
+var spectralRulesets = require('@stoplight/spectral-rulesets');
+var types = require('@stoplight/types');
+var spectralFormatters = require('@stoplight/spectral-formatters');
+require('./paths-9ab9b8a8.cjs.js');
+require('@backstage/cli-common');
+require('@backstage/cli-node');
+require('minimatch');
+require('p-limit');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var ruleset__default = /*#__PURE__*/_interopDefaultLegacy(ruleset);
+var fs__default = /*#__PURE__*/_interopDefaultLegacy(fs);
+var chalk__default = /*#__PURE__*/_interopDefaultLegacy(chalk);
+
+async function lint(directoryPath, config) {
+  const { skipMissingYamlFile, strict } = config != null ? config : {};
+  const openapiPath = path.resolve(directoryPath, constants.YAML_SCHEMA_PATH);
+  if (!await fs__default["default"].pathExists(openapiPath)) {
+    if (skipMissingYamlFile) {
+      return;
+    }
+    throw new Error(`Could not find a file at ${openapiPath}.`);
+  }
+  const openapiFileContent = await fs__default["default"].readFile(openapiPath, "utf8");
+  const document = new spectralCore.Document(openapiFileContent, spectralParsers.Yaml, openapiPath);
+  const spectral = new spectralCore.Spectral();
+  const backstageRuleset = new spectralCore.Ruleset(
+    {
+      extends: [spectralRulesets.oas, ruleset__default["default"]],
+      overrides: [
+        {
+          files: ["*"],
+          rules: {
+            "api-health": "off",
+            "api-home": "off",
+            "api-home-get": "off",
+            "operation-tags": "off",
+            "hosts-https-only-oas3": "off",
+            "no-unknown-error-format": "off"
+          }
+        }
+      ]
+    },
+    { source: openapiPath }
+  );
+  spectral.setRuleset(backstageRuleset);
+  const result = await spectral.run(document);
+  const errors = result.filter((e) => e.severity === types.DiagnosticSeverity.Error);
+  const numberOfErrors = strict && result.length || errors.length;
+  if (numberOfErrors > 0) {
+    console.error(
+      spectralFormatters.pretty(result, {
+        // Used to fulfill the types, but not used for prettier output.
+        failSeverity: types.DiagnosticSeverity.Error
+      })
+    );
+    throw new Error(`${numberOfErrors} error(s) found when linting your spec.`);
+  }
+}
+async function bulkCommand(paths = [], options) {
+  const resultsList = await constants.runner(
+    paths,
+    (dir) => lint(dir, { skipMissingYamlFile: true, strict: !!options.strict })
+  );
+  let failed = false;
+  for (const { relativeDir, resultText } of resultsList) {
+    if (resultText) {
+      console.log();
+      console.log(
+        chalk__default["default"].red(`OpenAPI yaml file linting failed in ${relativeDir}:`)
+      );
+      console.log(resultText.trimStart());
+      failed = true;
+    }
+  }
+  if (failed) {
+    process.exit(1);
+  } else {
+    console.log(chalk__default["default"].green("Linted all files."));
+  }
+}
+
+exports.bulkCommand = bulkCommand;
+//# sourceMappingURL=lint-d126add4.cjs.js.map

package/dist/index.cjs.js

@@ -46,6 +46,10 @@ function registerSchemaCommand(program) {
   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)));
+  openApiCommand.command("lint [paths...]").description("Lint OpenAPI schemas.").option(
+    "--strict",
+    "Fail on any linting severity messages, not just errors."
+  ).action(lazy(() => Promise.resolve().then(function () { return require('./cjs/lint-d126add4.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(
@@ -90,7 +94,7 @@ function lazy(getActionFunc) {
   };
 }
 
-var version = "0.3.0";
+var version = "0.3.1";
 
 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.3.0",
+  "version": "0.3.1",
   "publishConfig": {
     "access": "public"
   },
@@ -31,12 +31,20 @@
   },
   "dependencies": {
     "@apidevtools/swagger-parser": "^10.1.0",
+    "@apisyouwonthate/style-guide": "^1.4.0",
     "@backstage/cli-common": "^0.1.12",
-    "@backstage/cli-node": "^0.1.0",
-    "@backstage/errors": "^1.1.5",
+    "@backstage/cli-node": "^0.1.1",
+    "@backstage/errors": "^1.2.0",
     "@manypkg/get-packages": "^1.1.3",
     "@microsoft/api-documenter": "^7.19.27",
     "@microsoft/api-extractor": "^7.33.7",
+    "@stoplight/spectral-core": "^1.18.0",
+    "@stoplight/spectral-formatters": "^1.1.0",
+    "@stoplight/spectral-functions": "^1.7.2",
+    "@stoplight/spectral-parsers": "^1.0.2",
+    "@stoplight/spectral-rulesets": "^1.16.0",
+    "@stoplight/spectral-runtime": "^1.1.2",
+    "@stoplight/types": "^13.14.0",
     "chalk": "^4.0.0",
     "commander": "^9.1.0",
     "fs-extra": "10.1.0",
@@ -49,8 +57,8 @@
     "ts-node": "^10.0.0"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.22.7",
-    "@backstage/types": "^1.0.2",
+    "@backstage/cli": "^0.22.8",
+    "@backstage/types": "^1.1.0",
     "@types/is-glob": "^4.0.2",
     "@types/mock-fs": "^4.13.0",
     "@types/node": "^16.11.26",