log

season · season · commit ae490516b79e · 2017-11-16T18:45:11.000+08:00
diff --git a/README.md b/README.md
@@ -54,6 +54,9 @@ export default {}
     "plugins/markdown",
     "plugins/summarize"
   ],
+  "jsdoc-vue-component": {
+    "log": true
+  },
   "markdown": {
     "tags": ["author", "classdesc", "description", "param", "property", "returns", "see", "throws", "vue"]
   },
diff --git a/index.js b/index.js
@@ -4,6 +4,7 @@ const compiler = require('vue-template-compiler');
 const stripIndent = require('strip-indent');
 const indentString = require('indent-string');
 const parse = require('./parse');
+const log = require('./util').log;
 
 // get markdown comment
 function getMarkDown(obj) {
@@ -92,6 +93,8 @@ const markdownCodes = {};
 exports.handlers = {
   beforeParse (e) {
     if (/\.vue$/.test(e.filename)) {
+      log(`parse file begin: ${e.filename}`);
+
       const parsedComponent = compiler.parseComponent(e.source);
       const code = parsedComponent.script ? parsedComponent.script.content : '';
       const parsed = parse(code);
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "jsdoc-vue-component",
-  "version": "2.0.1",
+  "version": "2.0.2",
   "description": "A simple plugin for jsdoc (`pase vue SFC info to description`)",
   "main": "index.js",
   "repository": {
diff --git a/parse.js b/parse.js
@@ -1,8 +1,11 @@
 const esprima = require('esprima');
 const esquery = require('esquery');
 const escodegen = require('escodegen');
+const log = require('./util').log;
 
 function parseProps(item) {
+  log('parse props begin ...');
+
   let props = [];
 
   // props: [], array
@@ -112,6 +115,8 @@ function parseProps(item) {
 }
 
 function parseMethods(item) {
+  log('parse methods begin ...');
+
   let methods = [];
 
   // error methods format
@@ -140,6 +145,8 @@ function parseMethods(item) {
 }
 
 function parseComponents(item) {
+  log('parse components begin ...');
+
   let components = [];
 
   // error format
@@ -158,6 +165,8 @@ function parseComponents(item) {
 }
 
 function parseCode(code) {
+  log('parse code begin ...');
+
   const ast = esprima.parseModule(code);
   const propertyList = esquery(ast, "ExportDefaultDeclaration > .declaration > .properties");
 
diff --git a/util.js b/util.js
@@ -0,0 +1,18 @@
+let config = {
+  log: true
+}
+
+try {
+  const env = require('jsdoc/env')
+  config = Object.assign({}, config, env.conf['jsdoc-vue-component']);
+} catch (e) {
+  console.log(e);
+}
+
+function log(message) {
+  if (!config.log) return;
+  console.log('jsdoc-vue-component: ');
+  console.log(message);
+}
+
+exports.config = config;

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": {`