Fix parser

Author: rafaesc

README.md

@@ -71,7 +71,6 @@ export default {
     /**
      * object/array defaults should be returned from a factory function
      * @version 1.0.5
-     * @ignore
      * @since Version 1.0.1
      * @see See [Wikipedia](https://en.wikipedia.org/wiki/Web_colors#HTML_color_names) for a list of color names
      * @link See [Wikipedia](https://en.wikipedia.org/wiki/Web_colors#HTML_color_names) for a list of color names
@@ -82,6 +81,7 @@ export default {
     },
     /**
      * describe data
+     * @version 1.0.5
      */
     data: [Array],
     /**
@@ -90,6 +90,7 @@ export default {
     columns: [Array],
     /**
      * filter key
+     * @ignore
      */
     filterKey: {
       type: String,
@@ -137,20 +138,22 @@ export default {
   methods: {
 
     /**
-    * 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) {
       this.sortKey = key
       this.sortOrders[key] = this.sortOrders[key] * -1
     },
 
-    hiddenMethod: function(){}
+    hiddenMethod: function(){
+
+    }
   }
 }
 </script>
@@ -170,7 +173,7 @@ we are getting this output:
   "methods": [
     {
       "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": [],
       "params": [
         {
@@ -195,24 +198,6 @@ we are getting this output:
             "description": "public"
           }
         ],
-        "description": [
-          {
-            "title": "description",
-            "description": "Sets the order"
-          }
-        ],
-        "kind": [
-          {
-            "title": "kind",
-            "description": "function"
-          }
-        ],
-        "name": [
-          {
-            "title": "name",
-            "description": "sortBy"
-          }
-        ],
         "params": [
           {
             "title": "param",
@@ -251,37 +236,55 @@ we are getting this output:
   ],
   "displayName": "Grid",
   "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"
     }
   },
   "comment": "/**\n * This is an example of creating a reusable grid component and using it with external data.\n * @version 1.0.5\n * @author [Rafael](https://github.com/rafaesc92)\n * @since Version 1.0.1\n */",
@@ -292,18 +295,6 @@ we are getting this output:
         "description": "[Rafael](https://github.com/rafaesc92)"
       }
     ],
-    "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": [
       {
         "title": "since",

package.json

@@ -1,6 +1,6 @@
 {
   "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.",
   "bugs": {
     "url": "https://github.com/vue-styleguidist/vue-docgen-api/issues"

src/utils/blockTags.js

@@ -11,7 +11,6 @@ export default [
 	'copyright',
 	'default',
 	'deprecated',
-	'description',
 	'event',
 	'example',
 	'examples',
@@ -25,12 +24,10 @@ export default [
 	'inner',
 	'instance',
 	'interface',
-	'kind',
 	'lends',
 	'license',
 	'member',
 	'module',
-	'name',
 	'param',
 	'params',
 	'private',

src/utils/getTag.js

@@ -1,9 +1,9 @@
 import { EMPTY } from './variables';
 
 function isExistInTagList(docPart, tagName) {
-	return docPart['tags'].some( tagObj => {
-		return tagObj['title'] === tagName;
-	})
+	return docPart['tags'].some(tagObj => {
+		return tagObj['title'] === tagName
+	});
 }
 
 function generateTag(title, description, type) {
@@ -62,15 +62,15 @@ export default function getTag(tagName, docPart) {
 					return generateTag(tagName, description)
 				})
 			}
-		} else if (docPart['tags'] &&
-		isExistInTagList(tagName, docPart)) {
-			return docPart['tags'].filter(tagObj => {
+		}
+		return false;
+	} else if (docPart['tags'] &&
+		isExistInTagList(docPart, tagName)) {
+		return docPart['tags'].filter(tagObj => {
 				return tagObj['title'] === tagName;
 			}).map(tagObj =>{
 				return generateTag(tagName, tagObj['text'])
 			})
-		}
-	} else {
-		return false;
 	}
+	return false;
 }

src/utils/getVueDoc.js

@@ -34,7 +34,7 @@ export default function getVueDoc(docFile, component) {
 		})[0];
 		const description = getDescription(docComponent);
 		const comment = getComment(docComponent);
-		const tags = processTags(docComponent, ['name', ...IGNORE_DEFAULT]);
+		const tags = processTags(docComponent, IGNORE_DEFAULT);
 		const props = processProps(docFile, component);
 		const methods = processMethods(docFile, component);
 

src/utils/processProps.js

@@ -14,9 +14,14 @@ export default function processProps(docFile, component) {
 					return comment.longname.indexOf('props.' + propName) > -1
 				})[0];
 				const prop = component.props[propName];
-				const listTag = getProp(prop, docPart);
-				if ( listTag['tags'] && !listTag['tags']['ignore'] ) {
-					listProps[propName] = listTag;
+				const docProp = getProp(prop, docPart);
+				const listTags = docProp['tags']
+				if ( listTags ) {
+					if ( !listTags['ignore'] ) {
+						listProps[propName] = docProp;
+					}
+				} else {
+					listProps[propName] = docProp;
 				}
 			})
 		}

tests/components/grid/Grid.vue

@@ -37,17 +37,17 @@ export default {
     /**
      * object/array defaults should be returned from a factory function
      * @version 1.0.5
-     * @ignore
      * @since Version 1.0.1
      * @see See [Wikipedia](https://en.wikipedia.org/wiki/Web_colors#HTML_color_names) for a list of color names
      * @link See [Wikipedia](https://en.wikipedia.org/wiki/Web_colors#HTML_color_names) for a list of color names
      */
     msg: {
-	    type: [String, Number],
-	    default: 'Ejemplo'
+      type: [String, Number],
+      default: 'Ejemplo'
     },
     /**
      * describe data
+     * @version 1.0.5
      */
     data: [Array],
     /**
@@ -56,6 +56,7 @@ export default {
     columns: [Array],
     /**
      * filter key
+     * @ignore
      */
     filterKey: {
       type: String,
@@ -103,22 +104,22 @@ export default {
   methods: {
 
     /**
-	 * 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) {
       this.sortKey = key
       this.sortOrders[key] = this.sortOrders[key] * -1
     },
 
-		hiddenMethod: function(){
+    hiddenMethod: function(){
 
-		}
+    }
   }
 }
 </script>

tests/index.js

@@ -39,19 +39,15 @@ describe('tests', () => {
 		expect(typeof docJson['props'] !== 'undefined').to.be.true
 	})
 
-	it('should the component have kind', () => {
-		expect(typeof docJson['tags']['kind'] !== 'undefined').to.be.true
-	})
-
 	it('should the component have version', () => {
 		expect(typeof docJson['tags']['version'] !== 'undefined').to.be.true
 	})
 
-	it('should the component have one prop', () => {
-		expect(Object.keys(docJson['props']).length === 1).to.be.true
+	it('should the component have three prop', () => {
+		expect(Object.keys(docJson['props']).length === 3).to.be.true
 	})
 
-	it('should the prop filter key have three tags', () => {
-		expect(Object.keys(docJson['props']['filterKey']['tags']).length === 3).to.be.true
+	it('should the prop msg have four tags', () => {
+		expect(Object.keys(docJson['props']['msg']['tags']).length === 4).to.be.true
 	})
 })