doxme - npm Package Compare versions

Comparing version 1.7.1 to 1.8.0

index.js

@@ -60,3 +60,6 @@ var util = require('./util.js'),
     dox.forEach(function(d) {
-        var alias, returns;
+        var returns, access;
+        var access = getTag(d.tags, 'access');
+        // do not generate documentation for private members
+        if (access && access.string === 'private') return;
         var name = '', mod;
@@ -63,0 +66,0 @@ if (alias = getTag(d.tags, ['alias', 'function', 'func', 'method'])) {

package.json

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

test.js

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

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

14905

increased by3.87%

Number of package files

19

increased by11.76%

Lines of code

219

increased by7.88%

Worsened metrics

Number of low supply chain risk alerts

8

increased by14.29%

No dependency changes