apidoc-core - npm Package Compare versions

Comparing version 0.11.1 to 0.12.0

CHANGELOG.md

 # Changelog for apidoc-core
 
+## 0.12.0
+
+### Changed
+
+* Allow '#' and '@' in apiParam names (#102 by Fulvio Gentile)
+
 ## 0.11.1
@@ -4,0 +10,0 @@

lib/index.js

@@ -107,3 +107,3 @@ var _      = require('lodash');
     time   : new Date(),
-    url    : 'http://apidocjs.com',
+    url    : 'https://apidocjs.com',
     version: '0.0.0'
@@ -347,3 +347,3 @@ };
  * @param {String} [packageInfos.description] A short description.
- * @param {String} [packageInfos.sampleUrl]   @see http://apidocjs.com/#param-api-sample-request
+ * @param {String} [packageInfos.sampleUrl]   @see https://apidocjs.com/#param-api-sample-request
  */
@@ -350,0 +350,0 @@ function setPackageInfos(packageInfos) {

lib/parsers/api_param.js

@@ -39,3 +39,3 @@ var trim     = require('../utils/trim');
         b:               '(\\[?\\s*',                       // 5 optional optional-marker
-        name:                '([a-zA-Z0-9\\$\\:\\.\\/\\\\_-]+',   // 6
+        name:                '([#@a-zA-Z0-9\\$\\:\\.\\/\\\\_-]+',   // 6
             withArray:           '(?:\\[[a-zA-Z0-9\\.\\/\\\\_-]*\\])?)', // https://github.com/apidoc/apidoc-core/pull/4
@@ -42,0 +42,0 @@ oDefaultValue: {                                    // optional defaultValue

lib/parsers/api_private.js

@@ -1,2 +0,2 @@
-function parse(content) {
+function parse() {
     return 'private';
@@ -3,0 +3,0 @@ }

package.json

 {
   "name": "apidoc-core",
-  "version": "0.11.1",
+  "version": "0.12.0",
   "description": "Core parser library to generate apidoc result following the apidoc-spec",
@@ -32,14 +32,15 @@ "author": "Peter Rottmann <[e-mail]>",
   "dependencies": {
-    "fs-extra": "^8.1.0",
-    "glob": "^7.1.4",
-    "iconv-lite": "^0.5.0",
+    "fs-extra": "^9.0.1",
+    "glob": "^7.1.6",
+    "iconv-lite": "^0.6.2",
     "klaw-sync": "^6.0.0",
-    "lodash": "~4.17.15",
-    "semver": "~6.3.0"
+    "lodash": "^4.17.20",
+    "semver": "~7.3.2"
   },
   "devDependencies": {
-    "apidoc-example": "^0.2.1",
-    "jshint": "~2.10.2",
-    "markdown-it": "^10.0.0",
-    "mocha": "~6.2.1",
+    "apidoc-example": "^0.2.3",
+    "deep-equal": "^2.0.3",
+    "jshint": "^2.12.0",
+    "markdown-it": "^11.0.0",
+    "mocha": "^8.1.1",
     "should": "~13.2.3"
@@ -46,0 +47,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

112939

increased by0.31%

Number of package files

65

increased by1.56%

Worsened metrics

Dev dependency count

6

increased by20%

Dependency changes

• + Addedat-least-node@1.0.0(transitive)

• + Addedfs-extra@9.1.0(transitive)

• + Addediconv-lite@0.6.3(transitive)

• + Addedjsonfile@6.1.0(transitive)

• + Addedlru-cache@6.0.0(transitive)

• + Addedsemver@7.3.8(transitive)

• + Addeduniversalify@2.0.1(transitive)

• + Addedyallist@4.0.0(transitive)

• - Removedfs-extra@8.1.0(transitive)

• - Removediconv-lite@0.5.2(transitive)

• - Removedjsonfile@4.0.0(transitive)

• - Removedsemver@6.3.1(transitive)

• - Removeduniversalify@0.1.2(transitive)

• Updatedfs-extra@^9.0.1

• Updatedglob@^7.1.6

• Updatediconv-lite@^0.6.2

• Updatedlodash@^4.17.20

• Updatedsemver@~7.3.2