Updated parseSource

Author: rafaesc

README.md

@@ -1,8 +1,6 @@
-# vue-docgen-api (Fork)
+# vue-docgen-api
 [![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.
@@ -12,22 +10,24 @@ Use [babel][] and [jsdoc-api][] to compile the code and analyze the contents of
 Install the module directly from npm:
 
 ```
-npm install git://github.com/Radiergummi/vue-docgen-api --save-dev
+npm install vue-docgen-api --save-dev
 ```
 
 ## API
 
 The tool can be used programmatically to extract component information and customize the extraction process:
 
 ```js
-const vueDocs = require('vue-docgen-api');
+var vueDocs = require('vue-docgen-api');
+var componentInfo = vueDocs.parse(filePath);
+```
 
-// from file
-const componentFileInfo = vueDocs.parseFile(filePath);
+### parse(filePath)
+
+| Parameter |  Type | Description |
+| -------------- | ------ | --------------- |
+| filePath       | string | The file path |
 
-// from source
-const componentSourceInfo = vueDocs.parseSource(sourceCode, filePath);
-```
 
 ## Using JSDoc tags
 

package.json

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

@@ -3,6 +3,6 @@ const expect = require("chai").expect;
 
 describe('parse', () => {
 	it('should return an function', () => {
-		expect(parse.default).to.be.an('function')
+		expect(parse.parse).to.be.an('function')
 	})
 })

src/main.js

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

src/parse.js

@@ -2,7 +2,7 @@ import fs from 'fs';
 import * as utils from './utils';
 import stateDoc from './utils/stateDoc';
 
-export const parseFile = function(file) {
+export const parse = function(file) {
 	const source = fs.readFileSync(file, { encoding: 'utf-8' });
 	if (source === '') {
 		throw new Error('The document is empty');
@@ -18,7 +18,7 @@ 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;