Fixed the problem of the props ignored

Author: rafaesc

package.json

@@ -1,6 +1,6 @@
 {
   "name": "vue-docgen-api",
-  "version": "2.0.3",
+  "version": "2.0.4",
   "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/getProp.js

@@ -19,10 +19,16 @@ function getTypeNameToFunction(object) {
 export default function getProp(prop, docPart){
 	if ( prop ) {
 		let obj = {};
-		if ( typeof prop === 'function' || Array.isArray(prop) ) {
+		if ( Array.isArray(prop) ) {
 			obj['type'] = {
 				name: getTypeName(prop),
 			};
+		} else if (typeof prop === 'function') {
+			obj['type'] = {
+				name: getTypeName(prop),
+			};
+			obj['tags'] = processTags(docPart, IGNORE_DEFAULT);
+			obj['comment'] = getComment(docPart);
 		} else {
 			obj['type'] = {
 				name: getTypeName(prop.type),

tests/components/button/Button.vue

@@ -28,11 +28,17 @@ export default {
 			default: 'normal'
 		},
 		/**
+		 * @ignore
 		 * Add custom click actions.
 		 **/
 		onCustomClick: {
 			default: () => () => null,
 		},
+		/**
+		 *@ignore
+		 *
+		 */
+		prop1: String
 	},
 	data () {
 		return {

tests/parse.js

@@ -57,7 +57,7 @@ describe('tests grid', () => {
 
 describe('tests button', () => {
 	docButton = api.parse(button);
-	// console.log(JSON.stringify(docButton, null, 2));
+	console.log(JSON.stringify(docButton, null, 2));
 
 	it('should return an object', () => {
 		expect(docButton).to.be.an('object')
@@ -99,8 +99,20 @@ describe('tests button', () => {
 		expect(typeof docButton['tags']['version'] !== 'undefined').to.be.true
 	})
 
-	it('should the component have four props', () => {
-		expect(Object.keys(docButton['props']).length).to.equal(4)
+	it('should the component have five props', () => {
+		expect(Object.keys(docButton['props']).length).to.equal(5)
+	})
+
+	it('should prop1 to be string', () => {
+		expect(docButton['props']['prop1']['type']['name']).to.equal('string')
+	})
+
+	it('should onCustomClick to be ignored', () => {
+		expect(docButton['props']['onCustomClick']['tags']['ignore']).to.be.an('array')
+	})
+
+	it('should prop1 to be ignored', () => {
+		expect(docButton['props']['prop1']['tags']['ignore']).to.be.an('array')
 	})
 })
 

tests/parseWebpack.js

@@ -6,7 +6,7 @@ const expect = require("chai").expect;
 let docGrid;
 let docButton;
 
-describe('tests grid', () => {
+describe('tests parseWebpack grid', () => {
 	docGrid = api.parseWebpack(grid);
 
 	it('should return an object', () => {
@@ -58,7 +58,7 @@ describe('tests grid', () => {
 	})
 })
 
-describe('tests button', () => {
+describe('tests parseWebpack button', () => {
 	docButton = api.parseWebpack(button);
 	console.log(JSON.stringify(docButton, null, 2));
 
@@ -78,10 +78,6 @@ describe('tests button', () => {
 		expect(Object.keys(docButton['tags']).length).to.equal(2)
 	})
 
-	it('should the component have four props', () => {
-		expect(Object.keys(docButton['props']).length).to.equal(4)
-	})
-
 	it('should the component have size prop default equal normal', () => {
 		expect(docButton['props']['size']['defaultValue']['value']).to.equal('"normal"')
 	})
@@ -110,7 +106,19 @@ describe('tests button', () => {
 		expect(typeof docButton['tags']['version'] !== 'undefined').to.be.true
 	})
 
-	it('should the component have four props', () => {
-		expect(Object.keys(docButton['props']).length).to.equal(4)
+	it('should the component have five props', () => {
+		expect(Object.keys(docButton['props']).length).to.equal(5)
+	})
+
+	it('should prop1 to be string', () => {
+		expect(docButton['props']['prop1']['type']['name']).to.equal('string')
+	})
+
+	it('should onCustomClick to be ignored', () => {
+		expect(docButton['props']['onCustomClick']['tags']['ignore']).to.be.an('array')
+	})
+
+	it('should prop1 to be ignored', () => {
+		expect(docButton['props']['prop1']['tags']['ignore']).to.be.an('array')
 	})
 })