@team-supercharge/oasg 8.0.0 → 8.0.1

package/CHANGELOG.md

@@ -2,6 +2,19 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [8.0.1](https://gitlab.com/team-supercharge/oasg/compare/v8.0.0...v8.0.1) (2023-02-23)
+
+
+### Bug Fixes
+
+* install dependencies used as CLI scripts in Docker ([5d041e0](https://gitlab.com/team-supercharge/oasg/commit/5d041e0c7d1651bd21fcb33287c237b6a18bb6f1))
+* use fixed version for prism and redocly ([3986814](https://gitlab.com/team-supercharge/oasg/commit/39868141b55234e922ce8df5dd58d88a0b54baf3))
+
+
+### Documentation
+
+* improve extending the default oasg ruleset, add to migration notes ([9a70342](https://gitlab.com/team-supercharge/oasg/commit/9a703421a6eb7e75ddb8e83753fd9a6bc3b9edc7))
+
 ## [8.0.0](https://gitlab.com/team-supercharge/oasg/compare/v7.1.0...v8.0.0) (2023-02-22)
 
 

package/CONTRIBUTING.md

@@ -0,0 +1,14 @@
+# Contributing
+
+When contributing to this repository, please first discuss the change you wish to make via issue,
+email, or any other method with the owners of this repository before making a change.
+
+## CLI Dependencies
+
+The following dependencies are used as CLI scripts both on CI machines and running locally:
+
+* `@stoplight/spectral`
+* `@stoplight/prism-cli`
+* `@redocly/cli`
+
+On updating these packages in `package.json`, please make sure to update the respective versions in `Dockerfile` as well.

package/Dockerfile

@@ -6,3 +6,8 @@ RUN chmod +x setup.sh && ./setup.sh
 
 WORKDIR /
 RUN npm install -g /app
+
+# install cli dependencies
+RUN npm install -g @stoplight/spectral@5.9.0
+RUN npm install -g @stoplight/prism-cli@4.1.0
+RUN npm install -g @redocly/cli@1.0.0-beta.123

package/README.md

@@ -99,7 +99,7 @@ For detailed configuration instructions please refer to the [Configuration](#con
 Create a `.spectral.yaml` file in the repo's root directory with the following minimal content:
 
 ```yaml
-extends: node_modules/@team-supercharge/oasg/rules/default.yaml
+extends: '@team-supercharge/oasg/rules/default.yaml'
 ```
 
 The file is used for configuring [Spectral](https://stoplight.io/open-source/spectral/) on a per-project basis and will enable usage of custom _OASg_ rulesets.
@@ -166,7 +166,7 @@ _OASg_ makes use of the awesome [Spectral](https://stoplight.io/open-source/spec
 The `.spectral.yaml` file in the API repository should be always configured to extend the default _OASg Ruleset_ using:
 
 ```yaml
-extends: node_modules/@team-supercharge/oasg/rules/default.yaml
+extends: '@team-supercharge/oasg/rules/default.yaml'
 ```
 
 Rules defined in the ruleset can be split into two categories:
@@ -179,7 +179,7 @@ You can further customize the ruleset in `.spectral.yaml` according to the [docu
 An example configuration can be found here:
 
 ```yaml
-extends: node_modules/@team-supercharge/oasg/rules/default.yaml
+extends: '@team-supercharge/oasg/rules/default.yaml'
 
 rules:
   oasg-object-names-pascal-case: off             # disables a default rule - don't do this in general :)
@@ -707,6 +707,20 @@ This section covers the breaking changes and their migrations across major versi
 
 ### From `7.x.x` to `8.0.0`
 
+**Linting**
+
+If you plan to use the _OASg_ base image with the preinstalled `oasg` binary without installing npm dependencies on CI, make sure you update your `.spectral.yaml` from the previously recommended syntax which picked up the rules directly from the file system:
+
+  ```yaml
+  extends: node_modules/@team-supercharge/oasg/rules/default.yaml
+  ```
+
+to use the syntax which picks up rules from the npm package wherever it's installed:
+
+  ```yaml
+  extends: '@team-supercharge/oasg/rules/default.yaml'
+  ```
+
 **Generators: `spring-kotlin`, `spring` and `feign`**
 
 Spring Boot 3 version is the default for these generators. To generate Spring Boot 2 libraries, add `-puseSpringBoot3=false` to `generatorCustomArgs` in the projects `config.json`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@team-supercharge/oasg",
-  "version": "8.0.0",
+  "version": "8.0.1",
   "description": "Node-based tool to lint OpenAPI documents and generate clients, servers and documentation from them",
   "author": "Supercharge",
   "license": "MIT",
@@ -15,8 +15,8 @@
   "dependencies": {
     "@apidevtools/json-schema-ref-parser": "^9.0.6",
     "@apidevtools/swagger-parser": "^10.0.2",
-    "@redocly/cli": "^1.0.0-beta.123",
-    "@stoplight/prism-cli": "^4.1.0",
+    "@redocly/cli": "1.0.0-beta.123",
+    "@stoplight/prism-cli": "4.1.0",
     "@stoplight/spectral": "5.9.0",
     "ajv": "^8.11.0",
     "command-exists": "^1.2.9",

package/bin/bundler.js

@@ -1,34 +0,0 @@
-const crypto = require('crypto');
-const fs = require('fs');
-
-const { exec } = require(`${__dirname}/exec.js`);
-
-async function bundleSpecification(source, file) {
-  // do NOT bundle by default for any sources
-  if (source.bundle === undefined || source.bundle === false) {
-    return file;
-  }
-
-  let outFile;
-
-  if (!file.startsWith("./out/.tmp")) {
-    if (!fs.existsSync('./out')) {
-      fs.mkdirSync('./out');
-    }
-
-    if (!fs.existsSync('./out/.tmp')) {
-      fs.mkdirSync('./out/.tmp');
-    }
-
-    outFile = `./out/.tmp/${source.id}-${crypto.randomBytes(4).readUInt32LE(0)}`;
-  } else {
-    outFile = file;
-  }
-
-  // using @redocly/cli to bundle
-  exec(`npx redocly bundle ${file} --keep-url-references --output ${outFile}`);
-
-  return outFile;
-}
-
-exports.bundleSpecification = bundleSpecification;