apidoc-mock - npm Package Compare versions

Comparing version 4.0.3 to 4.0.4

CHANGELOG.md

@@ -5,2 +5,21 @@ # Changelog
 
+### [4.0.4](https://github.com/cdcabrera/apidoc-mock/compare/v4.0.3...v4.0.4) (2022-08-04)
+
+
+### Bug Fixes
+
+* **build:** eslint, jsdoc updates ([#163](https://github.com/cdcabrera/apidoc-mock/issues/163)) ([dd20d53](https://github.com/cdcabrera/apidoc-mock/commit/dd20d537b5e94a651f5a7ceb965033ae90df18d2))
+
+
+### Build Updates
+
+* **deps-dev:** bump nodemon from 2.0.16 to 2.0.19 ([#155](https://github.com/cdcabrera/apidoc-mock/issues/155)) ([c51981a](https://github.com/cdcabrera/apidoc-mock/commit/c51981aa711028b1c87a7e3f97dd265eda42d973))
+* **deps-dev:** bump standard-version from 9.3.2 to 9.5.0 ([#145](https://github.com/cdcabrera/apidoc-mock/issues/145)) ([7286515](https://github.com/cdcabrera/apidoc-mock/commit/7286515f50b4afa6f5fcaa96aa27aeb8e1e11f66))
+
+
+### Maintenance
+
+* **build:** npm packages ([#139](https://github.com/cdcabrera/apidoc-mock/issues/139)) ([6f0f55d](https://github.com/cdcabrera/apidoc-mock/commit/6f0f55d324d8e62204eeca859c8f4b1fc3226824))
+* **build:** npm packages ([#163](https://github.com/cdcabrera/apidoc-mock/issues/163)) ([e5c456e](https://github.com/cdcabrera/apidoc-mock/commit/e5c456eaf5f093954610fa4aff781d406631b1e2))
+
 ### [4.0.3](https://github.com/cdcabrera/apidoc-mock/compare/v4.0.2...v4.0.3) (2022-05-03)
@@ -7,0 +26,0 @@

data/example.js

 /**
  * @api {get} /hello/world/
  * @apiMock {RandomResponse}
- * @apiSuccess {String} foo
- * @apiSuccess {String} bar
+ * @apiSuccess {string} foo
+ * @apiSuccess {string} bar
  * @apiSuccessExample {json} Success-Response:
@@ -18,4 +18,4 @@ *     HTTP/1.1 200 OK
  *     }
- * @apiError {String} bad
- * @apiError {String} request
+ * @apiError {string} bad
+ * @apiError {string} request
  * @apiErrorExample {json} Error-Response:
@@ -33,5 +33,5 @@ *     HTTP/1.1 400 OK
  * @apiMock {RandomResponse}
- * @apiHeader {String} Authorization Authorization: Token AUTH_TOKEN
- * @apiSuccess {String} foo
- * @apiSuccess {String} bar
+ * @apiHeader {string} Authorization Authorization: Token AUTH_TOKEN
+ * @apiSuccess {string} foo
+ * @apiSuccess {string} bar
  * @apiSuccessExample {json} Success-Response:
@@ -43,3 +43,3 @@ *     HTTP/1.1 201 OK
  *     }
- * @apiError {String} detail
+ * @apiError {string} detail
  * @apiErrorExample {json} Error-Response:
@@ -55,5 +55,5 @@ *     HTTP/1.1 401 Unauthorized
  * @api {put} /hello/world/
- * @apiHeader {String} Authorization Authorization: Token AUTH_TOKEN
- * @apiSuccess {String} foo
- * @apiSuccess {String} bar
+ * @apiHeader {string} Authorization Authorization: Token AUTH_TOKEN
+ * @apiSuccess {string} foo
+ * @apiSuccess {string} bar
  * @apiSuccessExample {json} Success-Response:
@@ -70,5 +70,5 @@ *     HTTP/1.1 200 OK
  * @api {patch} /hello/world/
- * @apiHeader {String} Authorization Authorization: Token AUTH_TOKEN
- * @apiSuccess {String} foo
- * @apiSuccess {String} bar
+ * @apiHeader {string} Authorization Authorization: Token AUTH_TOKEN
+ * @apiSuccess {string} foo
+ * @apiSuccess {string} bar
  * @apiSuccessExample {json} Success-Response:
@@ -85,5 +85,5 @@ *     HTTP/1.1 200 OK
  * @api {delete} /hello/world/
- * @apiHeader {String} Authorization Authorization: Token AUTH_TOKEN
- * @apiSuccess {String} foo
- * @apiSuccess {String} bar
+ * @apiHeader {string} Authorization Authorization: Token AUTH_TOKEN
+ * @apiSuccess {string} foo
+ * @apiSuccess {string} bar
  * @apiSuccessExample {json} Success-Response:
@@ -90,0 +90,0 @@ *     HTTP/1.1 200 OK

package.json

 {
   "name": "apidoc-mock",
-  "version": "4.0.3",
+  "version": "4.0.4",
   "description": "Create a mock server from apiDoc comments.",
@@ -35,3 +35,3 @@ "author": "cdcabrera",
     "test:integration-dev": "jest --roots=./tests --watchAll",
-    "test:lint": "eslint ./src ./bin"
+    "test:lint": "eslint ./src ./bin ./data"
   },
@@ -90,24 +90,22 @@ "jest": {
     "apidoc": "^0.29.0",
-    "express": "^4.17.2",
-    "node-watch": "^0.7.2",
-    "winston": "^3.6.0",
-    "yargs": "^17.3.1"
+    "express": "^4.18.1",
+    "node-watch": "^0.7.3",
+    "winston": "^3.8.1",
+    "yargs": "^17.5.1"
   },
   "devDependencies": {
-    "@babel/eslint-parser": "^7.17.0",
-    "eslint": "^8.9.0",
-    "eslint-config-esnext": "^4.1.0",
-    "eslint-config-node": "^4.1.0",
-    "eslint-config-prettier": "^8.3.0",
+    "eslint": "^8.21.0",
+    "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-babel": "^5.3.1",
-    "eslint-plugin-import": "^2.25.4",
-    "eslint-plugin-jest": "^26.1.1",
+    "eslint-plugin-import": "^2.26.0",
+    "eslint-plugin-jest": "^26.7.0",
+    "eslint-plugin-jsdoc": "^39.3.4",
     "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-prettier": "^4.0.0",
-    "jest": "^27.5.1",
-    "nodemon": "^2.0.15",
-    "npm-check-updates": "^12.5.2",
+    "eslint-plugin-prettier": "^4.2.1",
+    "jest": "^28.1.3",
+    "nodemon": "^2.0.19",
+    "npm-check-updates": "^16.0.5",
     "npm-run-all": "^4.1.5",
-    "prettier": "^2.5.1",
-    "standard-version": "^9.3.2"
+    "prettier": "^2.7.1",
+    "standard-version": "^9.5.0"
   },
@@ -114,0 +112,0 @@ "resolutions": {

src/api/buildApi.js

@@ -15,3 +15,3 @@ const { logger } = require('../logger/configLogger');
  * @param {object} response
- * @param {function} next
+ * @param {Function} next
  */
@@ -41,4 +41,4 @@ const buildRequestHeaders = (request, response, next) => {
  *
- * @param {array} apiJson
- * @returns {{app:array, routesLoaded: boolean}}
+ * @param {Array} apiJson
+ * @returns {{app:Array, routesLoaded: boolean}}
  */
@@ -45,0 +45,0 @@ const buildResponse = (apiJson = []) => {

src/api/parseApi.js

@@ -7,5 +7,5 @@ const { logger } = require('../logger/configLogger');
  * @param {object} mockSettings
- * @param {array} exampleObjects
- * @param {array} successObjects
- * @param {array} errorObjects
+ * @param {Array} exampleObjects
+ * @param {Array} successObjects
+ * @param {Array} errorObjects
  * @returns {{type: string, status: number, content: string}}
@@ -77,3 +77,3 @@ */
  *
- * @param {array} errorObjects
+ * @param {Array} errorObjects
  * @returns {{type: string, status: number, content: string}}
@@ -90,3 +90,4 @@ */
  *
- * @param {Object} mock
+ * @param {object} params
+ * @param {object} params.mock
  * @returns {object}
@@ -148,3 +149,3 @@ */
  *
- * @param {array} examples
+ * @param {Array} examples
  * @param {string} response
@@ -151,0 +152,0 @@ * @param {string} type

src/docs/buildDocs.js

@@ -8,4 +8,5 @@ const fs = require('fs');
  *
- * @param {object} apiDocsConfig
- * @param {string} apiJsonFile
+ * @param {object} params
+ * @param {object} params.apiDocsConfig
+ * @param {string} params.apiJsonFile
  * @returns {object}
@@ -12,0 +13,0 @@ */

src/index.js

@@ -46,3 +46,3 @@ const fs = require('fs');
  *
- * @param {array} apiJson
+ * @param {Array} apiJson
  * @param {number} port
@@ -71,5 +71,6 @@ * @returns {*}
  *
- * @param {number} port
- * @param {(string|string[])} dataPath
- * @param {string} docsPath
+ * @param {object} params
+ * @param {number} params.port
+ * @param {(string|string[])} params.dataPath
+ * @param {string} params.docsPath
  * @returns {*}
@@ -76,0 +77,0 @@ */

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

40410

increased by3.11%

Dev dependency count

14

decreased by-12.5%

Lines of code

587

increased by0.51%

Dependency changes

• Updatedexpress@^4.18.1

• Updatednode-watch@^0.7.3

• Updatedwinston@^3.8.1

• Updatedyargs@^17.5.1