sassdoc - npm Package Compare versions

Comparing version 1.0.0-rc.7 to 1.0.0-rc.8

CHANGELOG.md

 # Changelog
 
-## 1.0.0rc.7
+## 1.0.0-rc.8
 
+* Added back the `[Private]` annotation before private items' name
+* Added a `version` parameter to `view.json` that gets displayed right next to the title
+* Prevented empty sections in case items exist but are not displayed
+* Prevented broken links with requires and usedby in case of private items
+
+## 1.0.0-rc.7
+
 * Fixed an issue where links were not displayed
@@ -10,3 +17,3 @@ * Added `--version` option
 
-## 1.0.0rc.6
+## 1.0.0-rc.6
 
@@ -18,3 +25,3 @@ * Added location where item was found
 
-## 1.0.0rc.5
+## 1.0.0-rc.5
 
@@ -28,11 +35,11 @@ * Improved view
 
-## 1.0.0rc.4
+## 1.0.0-rc.4
 
 * Fixed an issue prevented `@requires` form working if there was any `@alias`
 
-## 1.0.0rc.3
+## 1.0.0-rc.3
 
 * Greatly improved the view
 
-## 1.0.0rc.2
+## 1.0.0-rc.2
 
@@ -42,3 +49,3 @@ * Fixed `@deprecated` not supporting a message
 
-## 1.0.0rc.1
+## 1.0.0-rc.1
 
@@ -45,0 +52,0 @@ * Moved to a real parser ([CDocParser](https://github.com/FWeinb/CDocParser) and [ScssCommentParser](https://github.com/FWeinb/ScssCommentParser))

package.json

@@ -6,3 +6,3 @@ {
   "contributors": ["Fabrice Weinberg", "Valérian Galliat"],
-  "version": "1.0.0rc.7",
+  "version": "1.0.0rc.8",
   "license": "MIT",
@@ -9,0 +9,0 @@ "repository": {

README.md

@@ -112,2 +112,3 @@ # SassDoc
 * (`Boolean`) `display_alias`: enable/disable display of alias items
+* (`String`|`Boolean`) `version`: if enabled, gets displayed right next to title
 
@@ -114,0 +115,0 @@ ## Credits

src/api.js

@@ -34,2 +34,3 @@ 'use strict';
       .fail(function (err) {
+        console.log(err);
         throw new Error(err);
@@ -36,0 +37,0 @@ });

src/file.js

@@ -18,2 +18,7 @@ 'use strict';
 extras.useFilter(swig, 'split');
+extras.useFilter(swig, 'trim');
+swig.setFilter('push', function (arr, val) { 
+  return arr.push(val);
+});
+
 ncp.limit = 16;
@@ -260,8 +265,5 @@
 
-              reqItem.usedBy.push({
-                item: item.context.name,
-                type: item.context.type
-              });
+              reqItem.usedBy.push(item);
 
-              return reqItem.context;
+              return reqItem;
             }
@@ -268,0 +270,0 @@

view/view.json

 {
   "title": "SassDoc",
   "display_access": ["public", "private"],
-  "display_alias": false
+  "display_alias": false,
+  "version": false
 }

New alerts

Manifest confusion

Supply chain risk

This package has inconsistent metadata. This could be malicious or caused by an error when publishing the package.

Found 1 instance in 1 package

Fixed alerts

Manifest confusion

Supply chain risk

This package has inconsistent metadata. This could be malicious or caused by an error when publishing the package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

212515

increased by1.97%

Lines of code

572

increased by0.53%

Number of lines in readme file

119

increased by0.85%

No dependency changes