2
0
mirror of https://github.com/tenrok/vue-select.git synced 2026-06-19 09:50:33 +03:00
Files
vue-select/docs/.vuepress/generateApiDocs.js
T

41 lines
1.1 KiB
JavaScript

const docs = require('vue-docgen-api');
const path = require('path');
const fs = require('fs');
/**
* Get all of the component mixin paths.
* @param directory
* @return {string[]}
*/
function getMixins (directory) {
return fs.readdirSync(directory)
.filter(file => file !== 'index.js')
.map(file => path.resolve(directory, file));
}
/**
* Dynamically generates all API documentation with vue-docgen-api.
* Resulting object can be imported and used client-side:
*
* import documentation from '@dynamic/api'
*
* @see https://vuepress.vuejs.org/plugin/option-api.html#clientdynamicmodules
* @param options
* @param sourceDir
* @return {{clientDynamicModules(): Promise<{name: string, content: string}>}}
*/
module.exports = (options, {sourceDir}) => ({
/**
* Generate documentation for Select.vue
* @return {Promise<{name: string, content: string}>}
*/
async clientDynamicModules () {
const file = path.resolve(sourceDir, '../src/components/Select.vue');
return {
name: 'api.js',
content: `export default ${JSON.stringify(await docs.parse(file))}`,
};
},
});