swagger-jsdoc
Advanced tools
Comparing version 3.2.9 to 3.3.0
@@ -130,5 +130,3 @@ #!/usr/bin/env node | ||
} catch (error) { | ||
const message = `Error while loading definition file '${ | ||
program.definition | ||
}':\n${error.message}`; | ||
const message = `Error while loading definition file '${program.definition}':\n${error.message}`; | ||
return console.log(message); | ||
@@ -135,0 +133,0 @@ } |
@@ -26,5 +26,5 @@ /** @module index */ | ||
const bufferParts = err.mark.buffer.split('\n'); | ||
bufferParts[line] = `${ | ||
bufferParts[line] | ||
} -------------- Pay attention at this place`; | ||
bufferParts[ | ||
line | ||
] = `${bufferParts[line]} -------------- Pay attention at this place`; | ||
msg = bufferParts.join('\n'); | ||
@@ -31,0 +31,0 @@ } |
{ | ||
"name": "swagger-jsdoc", | ||
"version": "3.2.9", | ||
"version": "3.3.0", | ||
"description": "Generates swagger doc based on JSDoc", | ||
"main": "index.js", | ||
"scripts": { | ||
"precommit": "lint-staged", | ||
"test:lint": "eslint .", | ||
@@ -34,25 +33,25 @@ "test:js": "mocha --timeout 10000 --exit", | ||
"dependencies": { | ||
"commander": "2.17.1", | ||
"doctrine": "2.1.0", | ||
"glob": "7.1.3", | ||
"commander": "2.20.0", | ||
"doctrine": "3.0.0", | ||
"glob": "7.1.4", | ||
"js-yaml": "3.13.1", | ||
"swagger-parser": "5.0.5" | ||
"swagger-parser": "8.0.0" | ||
}, | ||
"devDependencies": { | ||
"body-parser": "1.18.3", | ||
"chai": "4.1.2", | ||
"body-parser": "1.19.0", | ||
"chai": "4.2.0", | ||
"chai-jest-snapshot": "2.0.0", | ||
"eslint": "5.5.0", | ||
"eslint-config-airbnb-base": "13.1.0", | ||
"eslint-config-prettier": "3.0.1", | ||
"eslint-loader": "2.1.0", | ||
"eslint-plugin-import": "2.14.0", | ||
"eslint-plugin-prettier": "2.6.2", | ||
"express": "4.16.3", | ||
"husky": "1.0.0-rc.13", | ||
"lint-staged": "7.2.2", | ||
"mocha": "5.2.0", | ||
"npm-run-all": "4.1.3", | ||
"prettier": "1.14.2", | ||
"supertest": "3.1.0" | ||
"eslint": "6.0.1", | ||
"eslint-config-airbnb-base": "13.2.0", | ||
"eslint-config-prettier": "6.0.0", | ||
"eslint-loader": "2.2.1", | ||
"eslint-plugin-import": "2.18.0", | ||
"eslint-plugin-prettier": "3.1.0", | ||
"express": "4.17.1", | ||
"husky": "3.0.0", | ||
"lint-staged": "9.1.0", | ||
"mocha": "6.1.4", | ||
"npm-run-all": "4.1.5", | ||
"prettier": "1.18.2", | ||
"supertest": "4.0.2" | ||
}, | ||
@@ -59,0 +58,0 @@ "husky": { |
@@ -14,3 +14,3 @@ # swagger-jsdoc | ||
**swagger-jsdoc** enables you to integrate [Swagger](http://swagger.io) | ||
using [`JSDoc`](http://usejsdoc.org/) comments in your code. Just add `@swagger` on top of your DocBlock and declare the meaning of your code in YAML complying to the OpenAPI specification. If you prefer to keep some parts of your specification aside your code in order to keep it lighter/cleaner, you can also pass these parts as separate input YAML files. | ||
using [`JSDoc`](https://jsdoc.app/) comments in your code. Just add `@swagger` on top of your DocBlock and declare the meaning of your code in YAML complying to the OpenAPI specification. If you prefer to keep some parts of your specification aside your code in order to keep it lighter/cleaner, you can also pass these parts as separate input YAML files. | ||
@@ -17,0 +17,0 @@ `swagger-jsdoc` will parse the above-mentioned and output an OpenAPI specification. You can use it to integrate any server and client technology as long as both sides comply with the specification. |
Sorry, the diff of this file is not supported yet
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
139098
517
+ Addedcommander@2.20.0(transitive)
+ Addeddoctrine@3.0.0(transitive)
+ Addedglob@7.1.4(transitive)
+ Addedjson-schema-ref-parser@7.1.4(transitive)
+ Addedono@5.1.06.0.1(transitive)
+ Addedopenapi-schemas@1.0.3(transitive)
+ Addedopenapi-types@1.3.5(transitive)
+ Addedswagger-methods@2.0.2(transitive)
+ Addedswagger-parser@8.0.0(transitive)
+ Addedvalidator@13.12.0(transitive)
+ Addedz-schema@4.2.4(transitive)
- Removedcommander@2.17.1(transitive)
- Removedcore-js@2.6.12(transitive)
- Removeddebug@3.2.7(transitive)
- Removeddoctrine@2.1.0(transitive)
- Removedformat-util@1.0.5(transitive)
- Removedglob@7.1.3(transitive)
- Removedjson-schema-ref-parser@5.1.3(transitive)
- Removedjsonschema@1.2.4(transitive)
- Removedjsonschema-draft4@1.0.0(transitive)
- Removedms@2.1.3(transitive)
- Removedono@4.0.11(transitive)
- Removedopenapi-schema-validation@0.4.2(transitive)
- Removedswagger-methods@1.0.8(transitive)
- Removedswagger-parser@5.0.5(transitive)
- Removedswagger-schema-official@2.0.0-bab6bed(transitive)
- Removedvalidator@10.11.0(transitive)
- Removedz-schema@3.25.1(transitive)
Updatedcommander@2.20.0
Updateddoctrine@3.0.0
Updatedglob@7.1.4
Updatedswagger-parser@8.0.0