Merge branch 'master' of https://github.com/Radiergummi/vue-docgen-api into Radiergummi-master

Author: rafaesc

README.md

@@ -1,6 +1,8 @@
-# vue-docgen-api
+# vue-docgen-api (Fork)
 [![npm](https://img.shields.io/npm/v/vue-docgen-api.svg)](https://www.npmjs.com/package/vue-docgen-api)
 
+**This fork adds a `parseSource` method to parse plain sources instead of files only**
+
 `vue-docgen-api` is a toolbox to help extracting information from [Vue][] components, and generate documentation from it.
 
 Use [babel][] and [jsdoc-api][] to compile the code and analyze the contents of the component extracting methods and props. The output is a JavaScript object.
@@ -10,24 +12,22 @@ Use [babel][] and [jsdoc-api][] to compile the code and analyze the contents of
 Install the module directly from npm:
 
 ```
-npm install vue-docgen-api --save-dev
+npm install git://github.com/Radiergummi/vue-docgen-api --save-dev
 ```
 
 ## API
 
 The tool can be used programmatically to extract component information and customize the extraction process:
 
 ```js
-var vueDocs = require('vue-docgen-api');
-var componentInfo = vueDocs.parse(filePath);
-```
+const vueDocs = require('vue-docgen-api');
 
-### parse(filePath)
-
-| Parameter |  Type | Description |
-| -------------- | ------ | --------------- |
-| filePath       | string | The file path |
+// from file
+const componentFileInfo = vueDocs.parseFile(filePath);
 
+// from source
+const componentSourceInfo = vueDocs.parseSource(sourceCode, filePath);
+```
 
 ## Using JSDoc tags
 

package.json

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

@@ -1,12 +1,17 @@
 import * as utils from './utils';
-import parse from './parse';
+import { parseFile, parseSource } from './parse';
 
-function defaultParse(src) {
-  return parse(src);
+function parseFile(path) {
+  return parseFile(path);
+}
+
+function parseSource(src, path) {
+	return parseSource(src, path);
 }
 
 export {
-	defaultParse as parse,
+	parseFile,
+	parseSource,
 	utils,
 };
 

src/parse.js

@@ -2,7 +2,7 @@ import fs from 'fs';
 import * as utils from './utils';
 import stateDoc from './utils/stateDoc';
 
-export default function parse(file) {
+export const parseFile = function(file) {
 	const source = fs.readFileSync(file, { encoding: 'utf-8' });
 	if (source === '') {
 		throw new Error('The document is empty');
@@ -13,3 +13,15 @@ export default function parse(file) {
 	const vueDoc = utils.getVueDoc(stateDoc, component);
 	return vueDoc;
 }
+
+export const parseSource = function(source, path) {
+	if (source === '') {
+		throw new Error('The document is empty');
+	}
+	
+	stateDoc.file = path;
+	stateDoc.saveComponent(source, path);
+	const component = utils.getSandbox(stateDoc.jscodeReqest, path).default;
+	const vueDoc = utils.getVueDoc(stateDoc, component);
+	return vueDoc;
+}