Provide an option to allow throwing on parsing errors

package.json

@@ -1,7 +1,7 @@
 {
   "name": "swagger-jsdoc",
   "description": "Generates swagger doc based on JSDoc",
-  "version": "6.0.9",
+  "version": "6.1.0",
   "engines": {
     "node": ">=12.0.0"
   },

src/lib.js

@@ -4,6 +4,7 @@ const { build } = require('./specification');
  * Generates the specification.
  * @param {object} options - Configuration options
  * @param {string} options.encoding Optional, passed to readFileSync options. Defaults to 'utf8'.
+ * @param {boolean} options.failOnErrors Whether or not to throw when parsing errors. Defaults to false.
  * @param {string} options.format Optional, defaults to '.json' - target file format '.yml' or '.yaml'.
  * @param {object} options.swaggerDefinition
  * @param {object} options.definition

src/specification.js

@@ -260,6 +260,9 @@ function build(options) {
       .filter((error) => !!error);
 
     if (errReport.length) {
+      if (options.failOnErrors) {
+        throw new Error(errReport);
+      }
       // Place to provide feedback for errors. Previously throwing, now reporting only.
       console.info(
         'Not all input has been taken into account at your final specification.'

test/lib.spec.js

@@ -44,6 +44,30 @@ describe('Main lib module', () => {
         tags: [],
       });
     });
+
+    it('should support a flag for throw errors', () => {
+      expect(() => {
+        swaggerJsdoc({
+          swaggerDefinition: {
+            info: {
+              title: 'Example weird characters',
+              version: '1.0.0',
+            },
+          },
+          apis: [path.resolve(__dirname, './files/v2/wrong_syntax.yaml')],
+          failOnErrors: true,
+        });
+      })
+        .toThrow(`YAMLSemanticError: The !!! tag handle is non-default and was not declared. at line 2, column 3:
+
+  !!!title: Hello World
+  ^^^^^^^^^^^^^^^^^^^^^…
+
+YAMLSemanticError: Implicit map keys need to be on a single line at line 2, column 3:
+
+  !!!title: Hello World
+  ^^^^^^^^^^^^^^^^^^^^^…`);
+    });
   });
 
   describe('Error handling', () => {