express-swagger-generator - npm Package Compare versions

Comparing version 1.1.14 to 1.1.15

index.js

@@ -5,2 +5,2 @@ /**
 
-module.exports = require('./lib/swagger');
+module.exports = require('./lib/swagger').generateSpecAndMount;

lib/swagger.js

@@ -152,3 +152,5 @@ /**
 function parseDescription(obj) {
-    return obj.description || ''
+    const description = obj.description || '';
+    const sanitizedDescription = description.replace('/**','');
+    return sanitizedDescription;
 }
@@ -417,3 +419,3 @@
  */
-module.exports = function (app) {
+function generateSpecAndMount(app) {
 
@@ -441,9 +443,12 @@ return function (options) {
             for (let j in comments) {
-
-                let parsed = fileFormat(comments[j])
-                swaggerHelpers.addDataToSwaggerObject(swaggerObject, [{
-                    paths: parsed.parameters,
-                    tags: parsed.tags,
-                    definitions: parsed.definitions
-                }]);
+                try {
+                    let parsed = fileFormat(comments[j])
+                    swaggerHelpers.addDataToSwaggerObject(swaggerObject, [{
+                        paths: parsed.parameters,
+                        tags: parsed.tags,
+                        definitions: parsed.definitions
+                    }]);
+                } catch (e) {
+                    console.log(`Incorrect comment format. Method was not documented.\nFile: ${apiFiles[i]}\nComment:`, comments[j])
+                }
             }
@@ -471,1 +476,8 @@ }
 };
+
+
+module.exports = {
+    generateSpecAndMount,
+    fileFormat,
+    parseApiFile
+};

package.json

 {
   "name": "express-swagger-generator",
-  "version": "1.1.14",
+  "version": "1.1.15",
   "description": "Generates swagger doc & ui based on express existing routes.",
@@ -5,0 +5,0 @@ "main": "index.js",

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

29419

increased by1.57%

Lines of code

714

increased by1.56%

No dependency changes