Commit ae49051

author

season

committed

log

1 parent 4c43359 commit ae49051Copy full SHA for ae49051

File tree

+34

-1

lines changed

+34

-1

lines changed

Lines changed: 3 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -54,6 +54,9 @@ export default {}`
`54`	`54`	`"plugins/markdown",`
`55`	`55`	`"plugins/summarize"`
`56`	`56`	`],`
	`57`	`+ "jsdoc-vue-component": {`
	`58`	`+ "log": true`
	`59`	`+ },`
`57`	`60`	`"markdown": {`
`58`	`61`	`"tags": ["author", "classdesc", "description", "param", "property", "returns", "see", "throws", "vue"]`
`59`	`62`	`},`

Lines changed: 3 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@ const compiler = require('vue-template-compiler');`
`4`	`4`	`const stripIndent = require('strip-indent');`
`5`	`5`	`const indentString = require('indent-string');`
`6`	`6`	`const parse = require('./parse');`
	`7`	`+const log = require('./util').log;`
`7`	`8`
`8`	`9`	`// get markdown comment`
`9`	`10`	`function getMarkDown(obj) {`
`@@ -92,6 +93,8 @@ const markdownCodes = {};`
`92`	`93`	`exports.handlers = {`
`93`	`94`	`beforeParse (e) {`
`94`	`95`	`if (/\.vue$/.test(e.filename)) {`
	`96`	+ log(`parse file begin: ${e.filename}`);
	`97`	`+`
`95`	`98`	`const parsedComponent = compiler.parseComponent(e.source);`
`96`	`99`	`const code = parsedComponent.script ? parsedComponent.script.content : '';`
`97`	`100`	`const parsed = parse(code);`

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "jsdoc-vue-component",`
`3`		`- "version": "2.0.1",`
	`3`	`+ "version": "2.0.2",`
`4`	`4`	"description": "A simple plugin for jsdoc (`pase vue SFC info to description`)",
`5`	`5`	`"main": "index.js",`
`6`	`6`	`"repository": {`

Lines changed: 9 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -1,8 +1,11 @@`
`1`	`1`	`const esprima = require('esprima');`
`2`	`2`	`const esquery = require('esquery');`
`3`	`3`	`const escodegen = require('escodegen');`
	`4`	`+const log = require('./util').log;`
`4`	`5`
`5`	`6`	`function parseProps(item) {`
	`7`	`+ log('parse props begin ...');`
	`8`	`+`
`6`	`9`	`let props = [];`
`7`	`10`
`8`	`11`	`// props: [], array`
`@@ -112,6 +115,8 @@ function parseProps(item) {`
`112`	`115`	`}`
`113`	`116`
`114`	`117`	`function parseMethods(item) {`
	`118`	`+ log('parse methods begin ...');`
	`119`	`+`
`115`	`120`	`let methods = [];`
`116`	`121`
`117`	`122`	`// error methods format`
`@@ -140,6 +145,8 @@ function parseMethods(item) {`
`140`	`145`	`}`
`141`	`146`
`142`	`147`	`function parseComponents(item) {`
	`148`	`+ log('parse components begin ...');`
	`149`	`+`
`143`	`150`	`let components = [];`
`144`	`151`
`145`	`152`	`// error format`
`@@ -158,6 +165,8 @@ function parseComponents(item) {`
`158`	`165`	`}`
`159`	`166`
`160`	`167`	`function parseCode(code) {`
	`168`	`+ log('parse code begin ...');`
	`169`	`+`
`161`	`170`	`const ast = esprima.parseModule(code);`
`162`	`171`	`const propertyList = esquery(ast, "ExportDefaultDeclaration > .declaration > .properties");`
`163`	`172`

Lines changed: 18 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,18 @@`
	`1`	`+let config = {`
	`2`	`+ log: true`
	`3`	`+}`
	`4`	`+`
	`5`	`+try {`
	`6`	`+ const env = require('jsdoc/env')`
	`7`	`+ config = Object.assign({}, config, env.conf['jsdoc-vue-component']);`
	`8`	`+} catch (e) {`
	`9`	`+ console.log(e);`
	`10`	`+}`
	`11`	`+`
	`12`	`+function log(message) {`
	`13`	`+ if (!config.log) return;`
	`14`	`+ console.log('jsdoc-vue-component: ');`
	`15`	`+ console.log(message);`
	`16`	`+}`
	`17`	`+`
	`18`	`+exports.config = config;`

Comments

(0)