doxme - npm Package Compare versions

Comparing version 1.7.0 to 1.7.1

index.js

 var util = require('./util.js'),
     table = require('markdown-table'),
     reformat = util.reformat,
+    escape = util.escape,
     getTag = util.getTag,
@@ -90,3 +91,3 @@ getTags = util.getTags,
                                 p.typesDescription.replace(/\|/g, '/') :
-                                p.types.join(',');
+                                escape(p.types.join(','));
                             return ['`' + p.name + '`', type,
@@ -93,0 +94,0 @@ (p.optional ? '_optional:_ ' : '') +

package.json

 {
   "name": "doxme",
-  "version": "1.7.0",
+  "version": "1.7.1",
   "description": "create markdown docs for dox output",
@@ -5,0 +5,0 @@ "main": "index.js",

test.js

@@ -44,3 +44,9 @@ var test = require('tape'),
     });
+    t.test('params', function(t) {
+        var result = doxme(dox.parseComments(fs.readFileSync('./test/params.js', 'utf8')));
+        if (process.env.UPDATE) { fs.writeFileSync('test/params.md', result); }
+        t.equal(result, fs.readFileSync('test/params.md', 'utf8'));
+        t.end();
+    });
     t.end();
 });

util.js

@@ -28,1 +28,5 @@ var striptags = require('striptags');
 };
+
+module.exports.escape = function(str) {
+    return str.replace(/([\\`*_{}\[\]()<>#+-.!])/g, '\\$1');
+};

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

14349

increased by4.92%

Number of package files

17

increased by13.33%

Lines of code

203

increased by8.56%

Worsened metrics

Number of low supply chain risk alerts

7

increased by16.67%

No dependency changes