yuidoc-filters - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

package.json

@@ -18,3 +18,3 @@ {
   ],
-  "version": "0.0.1"
+  "version": "0.0.2"
 }

README.md

 # yuidoc-filters
 A YUIDoc preprocessor for filtering out parts of documentation
+
+## Installation
+To install `yuidoc-filters`, simply run `npm install --save-dev yuidoc-filters` in your npm project root.
+
+## Usage
+To use on an existing yuidoc project, add the following entries to your `yuidoc.json` file:
+
+```javascript
+{
+  ...
+  "preprocessor": "yuidoc-filters",
+  "yuidoc-filters-exclude": ["private", "deprecated"]
+}
+```
+
+`yuidoc-filters-exclude` takes an array of exclusion types. Currently yuidoc filters only filters classes marked private or deprecated.
+

yuidoc-filters.js

 
 function isPrivateClass(item) {
-  return item.hasOwnProperty('access') && item.access === 'private';
+  return item.access === 'private';
 };
 
 function isDeprecatedClass(item) {
-  return item.hasOwnProperty('deprecated') && item.deprecated === true;
+  return item.deprecated === true;
 };
@@ -48,4 +48,4 @@
     for(var className in originalClasses) {
-      if (contains(Object.keys(data.classes), className)) {
-        namespaceClasses[className] = 1;
+      if (data.classes.hasOwnProperty(className)) {
+        namespaceClasses[className] = originalClasses[className]
       }
@@ -52,0 +52,0 @@ }

No alert changes

Improved metrics

Total package byte prevSize

3937

increased by12.2%

Number of lines in readme file

20

increased by566.67%

No dependency changes