oas-normalize 5.0.0 → 5.0.4

package/README.md

@@ -83,3 +83,17 @@ For security reasons, you need to opt into allowing fetching by a local path. To
 ```js
 const oas = new OASNormalize('./petstore.json', { enablePaths: true })
 ```
+
+### Colorized errors
+
+If you wish errors from `.validate()` to be styled and colorized, supply `colorizeErrors: true` to your instance of `OASNormalize`:
+
+```js
+const oas = new OASNormalize('https://example.com/petstore.json', {
+  colorizeErrors: true,
+})
+```
+
+Error messages will look like such:
+
+<img src="https://user-images.githubusercontent.com/33762/137796648-7e1157c2-cee4-466e-9129-dd2a743dd163.png" width="600" />

package/index.js

@@ -7,7 +7,12 @@ const utils = require('./lib/utils');
 class oasNormalize {
   constructor(file, opts) {
     this.file = file;
-    this.opts = { enablePaths: false, ...opts };
+    this.opts = {
+      colorizeErrors: false,
+      enablePaths: false,
+      ...opts,
+    };
+
     this.type = utils.type(this.file);
 
     this.cache = {
@@ -69,7 +74,9 @@ class oasNormalize {
       });
   }
 
-  async validate(convertToLatest) {
+  async validate(convertToLatest = false) {
+    const colorizeErrors = this.opts.colorizeErrors;
+
     return this.load().then(async schema => {
       const baseVersion = parseInt(utils.version(schema), 10);
 
@@ -84,7 +91,11 @@ class oasNormalize {
         const clonedSchema = JSON.parse(JSON.stringify(schema));
 
         return openapiParser
-          .validate(clonedSchema)
+          .validate(clonedSchema, {
+            validate: {
+              colorizeErrors,
+            },
+          })
           .then(() => {
             if (!convertToLatest) {
               return schema;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oas-normalize",
-  "version": "5.0.0",
+  "version": "5.0.4",
   "description": "OpenAPI 3.x or Swagger 2.0? YAML or JSON? URL, path, string or object? Who cares! It just works.",
   "main": "index.js",
   "engines": {