vue-docgen-api - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

dist/utils/blockTags.js

@@ -6,2 +6,2 @@ 'use strict';
 });
-exports.default = ['abstract', 'access', 'alias', 'augments', 'author', 'callback', 'class', 'classdesc', 'constant', 'copyright', 'default', 'deprecated', 'description', 'event', 'example', 'examples', 'exports', 'external', 'file', 'function', 'global', 'ignore', 'implements', 'inner', 'instance', 'interface', 'kind', 'lends', 'license', 'member', 'module', 'name', 'param', 'params', 'private', 'property', 'protected', 'public', 'readonly', 'requires', 'returns', 'see', 'since', 'static', 'summary', 'this', 'throws', 'todo', 'tutorial', 'type', 'typedef', 'variation', 'version', 'link'];
+exports.default = ['abstract', 'access', 'alias', 'augments', 'author', 'callback', 'class', 'classdesc', 'constant', 'copyright', 'default', 'deprecated', 'event', 'example', 'examples', 'exports', 'external', 'file', 'function', 'global', 'ignore', 'implements', 'inner', 'instance', 'interface', 'lends', 'license', 'member', 'module', 'param', 'params', 'private', 'property', 'protected', 'public', 'readonly', 'requires', 'returns', 'see', 'since', 'static', 'summary', 'this', 'throws', 'todo', 'tutorial', 'type', 'typedef', 'variation', 'version', 'link'];

dist/utils/getTag.js

@@ -72,12 +72,12 @@ 'use strict';
 			}
-		} else if (docPart['tags'] && isExistInTagList(tagName, docPart)) {
-			return docPart['tags'].filter(function (tagObj) {
-				return tagObj['title'] === tagName;
-			}).map(function (tagObj) {
-				return generateTag(tagName, tagObj['text']);
-			});
 		}
-	} else {
 		return false;
+	} else if (docPart['tags'] && isExistInTagList(docPart, tagName)) {
+		return docPart['tags'].filter(function (tagObj) {
+			return tagObj['title'] === tagName;
+		}).map(function (tagObj) {
+			return generateTag(tagName, tagObj['text']);
+		});
 	}
+	return false;
 }

dist/utils/getVueDoc.js

@@ -6,7 +6,2 @@ 'use strict';
 });
-
-var _toConsumableArray2 = require('babel-runtime/helpers/toConsumableArray');
-
-var _toConsumableArray3 = _interopRequireDefault(_toConsumableArray2);
-
 exports.default = getVueDoc;
@@ -63,3 +58,3 @@
 		var comment = (0, _variables.getComment)(docComponent);
-		var tags = (0, _processTags2.default)(docComponent, ['name'].concat((0, _toConsumableArray3.default)(_variables.IGNORE_DEFAULT)));
+		var tags = (0, _processTags2.default)(docComponent, _variables.IGNORE_DEFAULT);
 		var props = (0, _processProps2.default)(docFile, component);
@@ -66,0 +61,0 @@ var methods = (0, _processMethods2.default)(docFile, component);

dist/utils/processProps.js

@@ -33,5 +33,10 @@ 'use strict';
 				var prop = component.props[propName];
-				var listTag = (0, _getProp2.default)(prop, docPart);
-				if (listTag['tags'] && !listTag['tags']['ignore']) {
-					listProps[propName] = listTag;
+				var docProp = (0, _getProp2.default)(prop, docPart);
+				var listTags = docProp['tags'];
+				if (listTags) {
+					if (!listTags['ignore']) {
+						listProps[propName] = docProp;
+					}
+				} else {
+					listProps[propName] = docProp;
 				}
@@ -38,0 +43,0 @@ });

package.json

 {
   "name": "vue-docgen-api",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Toolbox to extract information from Vue component files for documentation generation purposes.",
@@ -5,0 +5,0 @@ "bugs": {

README.md

@@ -74,3 +74,2 @@ # vue-docgen-api
      * @version 1.0.5
-     * @ignore
      * @since Version 1.0.1
@@ -86,2 +85,3 @@ * @see See [Wikipedia](https://en.wikipedia.org/wiki/Web_colors#HTML_color_names) for a list of color names
      * describe data
+     * @version 1.0.5
      */
@@ -95,2 +95,3 @@ data: [Array],
      * filter key
+     * @ignore
      */
@@ -143,10 +144,10 @@ filterKey: {
     /**
-    * Sets the order
-    *
-    * @public
-    * @version 1.0.5
-    * @since Version 1.0.1
-    * @param {string} key Key to order
-    * @returns {string} Test
-    */
+   * Sets the order
+   *
+   * @public
+   * @version 1.0.5
+   * @since Version 1.0.1
+   * @param {string} key Key to order
+   * @returns {string} Test
+   */
     sortBy: function (key) {
@@ -157,3 +158,5 @@ this.sortKey = key
 
-    hiddenMethod: function(){}
+    hiddenMethod: function(){
+
+    }
   }
@@ -178,3 +181,3 @@ }
       "name": "sortBy",
-      "comment": "/**\n\t * Sets the order\n\t *\n\t * @public\n\t * @version 1.0.5\n\t * @since Version 1.0.1\n\t * @param {string} key Key to order\n\t * @returns {string} Test\n\t */",
+      "comment": "/**\n   * Sets the order\n   *\n   * @public\n   * @version 1.0.5\n   * @since Version 1.0.1\n   * @param {string} key Key to order\n   * @returns {string} Test\n   */",
       "modifiers": [],
@@ -204,20 +207,2 @@ "params": [
         ],
-        "description": [
-          {
-            "title": "description",
-            "description": "Sets the order"
-          }
-        ],
-        "kind": [
-          {
-            "title": "kind",
-            "description": "function"
-          }
-        ],
-        "name": [
-          {
-            "title": "name",
-            "description": "sortBy"
-          }
-        ],
         "params": [
@@ -261,33 +246,51 @@ {
   "props": {
-    "filterKey": {
+    "msg": {
       "type": {
-        "name": "string"
+        "name": "string|number"
       },
       "required": "",
       "defaultValue": {
-        "value": "\"example\"",
+        "value": "\"Ejemplo\"",
         "computed": false
       },
       "tags": {
-        "description": [
+        "see": [
           {
-            "title": "description",
-            "description": "filter key"
+            "title": "see",
+            "description": "See [Wikipedia](https://en.wikipedia.org/wiki/Web_colors#HTML_color_names) for a list of color names"
           }
         ],
-        "kind": [
+        "since": [
           {
-            "title": "kind",
-            "description": "member"
+            "title": "since",
+            "description": "Version 1.0.1"
           }
         ],
-        "name": [
+        "version": [
           {
-            "title": "name",
-            "description": "filterKey"
+            "title": "version",
+            "description": "1.0.5"
           }
+        ],
+        "link": [
+          {
+            "title": "link",
+            "description": "See [Wikipedia](https://en.wikipedia.org/wiki/Web_colors#HTML_color_names) for a list of color names"
+          }
         ]
       },
-      "comment": "/**\n     * filter key\n     */",
-      "description": "filter key"
+      "comment": "/**\n     * object/array defaults should be returned from a factory function\n     * @version 1.0.5\n     * @since Version 1.0.1\n     * @see See [Wikipedia](https://en.wikipedia.org/wiki/Web_colors#HTML_color_names) for a list of color names\n     * @link See [Wikipedia](https://en.wikipedia.org/wiki/Web_colors#HTML_color_names) for a list of color names\n     */",
+      "description": "object/array defaults should be returned from a factory function"
+    },
+    "data": {
+      "type": {
+        "name": "array"
+      },
+      "description": "describe data"
+    },
+    "columns": {
+      "type": {
+        "name": "array"
+      },
+      "description": "get columns list"
     }
@@ -303,14 +306,2 @@ },
     ],
-    "description": [
-      {
-        "title": "description",
-        "description": "This is an example of creating a reusable grid component and using it with external data."
-      }
-    ],
-    "kind": [
-      {
-        "title": "kind",
-        "description": "member"
-      }
-    ],
     "since": [
@@ -317,0 +308,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

29213

increased by0.25%

Lines of code

561

increased by0.54%

Worsened metrics

Number of lines in readme file

318

decreased by-2.75%

No dependency changes