		@@ -12,4 +12,4 @@ const generator = require('./node/generator');
		*/
		async function clientDynamicModules (sourceDir) {
		const docs = await generator(sourceDir);
		async function clientDynamicModules (src) {
		const docs = await generator(src);

		@@ -16,0 +16,0 @@ console.log(green('✅ Generated API documentation for Select.vue'));

extendPageData.js

		const generator = require('./node/generator');

		module.exports = async function (page) {
		module.exports = async function (page, src) {
		const section = ['props', 'events', 'slots', 'methods'].find(
		@@ -9,3 +9,3 @@ section => page.frontmatter['api'] === section,
		if (section) {
		const docs = await generator(process.cwd());
		const docs = await generator(src);

		@@ -12,0 +12,0 @@ if (typeof docs[section] === 'undefined') {

index.js

		@@ -6,8 +6,7 @@ const path = require('path');
		/**
		* @param options
		* @param sourceDir
		* @return {{clientDynamicModules(): Promise<{name: string, content: string}>}}
		* @param src Absolute path to the file of the component being documented
		* @return {{enhanceAppFiles: , name: string, clientDynamicModules: (function(): {name: string, content: string}), extendPageData: }}
		*/
		module.exports = (options, {sourceDir}) => ({
		name: 'vuepress-docgen',
		module.exports = ({src}) => ({
		name: '@vuesource/vuepress',

		@@ -20,3 +19,3 @@ /**
		*/
		clientDynamicModules: async () => await clientDynamicModules(sourceDir),
		clientDynamicModules: async () => await clientDynamicModules(src),

		@@ -35,3 +34,3 @@ /**
		*/
		extendPageData,
		extendPageData: (page) => extendPageData(page, src),
		});

node/generator.js

		@@ -1,2 +0,1 @@
		const path = require('path');
		const bt = require('@babel/types');
		@@ -10,13 +9,8 @@ const docs = require('vue-docgen-api');
		* Generate an object of API documentation.
		* @param documentationRootDir
		* @param {String} src absolute path to the component being documented
		* @return {Promise<ComponentDoc>}
		*/
		module.exports = async (documentationRootDir) => {
		module.exports = async (src) => {

		const file = path.resolve(
		documentationRootDir,
		'../src/components/Select.vue',
		);

		const documentation = await docs.parse(file, {
		const documentation = await docs.parse(src, {
		jsx: false,
		@@ -46,3 +40,3 @@ addScriptHandlers: [

		const definitions = additionalSlotProperties(file);
		const definitions = additionalSlotProperties(src);

		@@ -49,0 +43,0 @@ documentation.slots = documentation.slots.map(slot => ({ ...slot, ...definitions[slot.name] }));

package.json

		{
		"name": "@vuesource/vuepress",
		"version": "0.1.0",
		"version": "0.1.1",
		"description": "Generates API documentation for Vue components.",
		"main": "index.js",
		"module": "index.js",
		"scripts": {
		"test": "echo \"Error: no test specified\" && exit 1"
		},
		"keywords": [
		@@ -18,3 +15,24 @@ "Vue",
		"author": "Jeff Sagal",
		"license": "MIT"
		"license": "MIT",
		"devDependencies": {
		"ast-types": "^0.13.2",
		"chalk": "^3.0.0",
		"cheerio": "^1.0.0-rc.3",
		"commitizen": "^4.0.3",
		"cz-conventional-changelog": "3.0.2",
		"jest": "^24.9.0",
		"markdown-it": "^10.0.0",
		"prettier": "^1.19.1",
		"prismjs": "^1.17.1",
		"vue": "^2.6.10",
		"vue-docgen-api": "^4.0.5",
		"vue-template-compiler": "^2.6.10",
		"vuepress": "^1.2.0",
		"webpack": "^4.41.2"
		},
		"config": {
		"commitizen": {
		"path": "./node_modules/cz-conventional-changelog"
		}
		}
		}

.idea/workspace.xml

Sorry, the diff of this file is not supported yet

@vuesource/vuepress - npm Package Compare versions

New alerts