vue-docgen-cli/src/multiMd.ts

Generate documentation markdown files from VueJs components using the vue-docgen-api.

import { promises as fs } from 'fs'
import * as path from 'path'
import { FSWatcher } from 'chokidar'
import * as log from 'loglevel'
import { writeDownMdFile } from './utils'
import { DocgenCLIConfigWithComponents } from './docgen'
import compileTemplates from './compileTemplates'
import { FileEventType } from './config'

/**
 * Build one md file per given compnent and save it respecting original scaffolding
 * if `config.watch` is true will jkeep on watch file changes
 * and update all needed files
 * @param files
 * @param config
 */
export default async function (
	files: string[],
	watcher: FSWatcher,
	config: DocgenCLIConfigWithComponents,
	docMap: { [filepath: string]: string },
	_compile = compile
) {
	const compileWithConfig = _compile.bind(null, config, docMap, watcher)

	await Promise.all(files.map(f => compileWithConfig('init', f, false)))

	if (config.watch) {
		watcher
			// on fileChange, recompile the corresponding file
			.on('add', filePath => {
				files.push(filePath)
				compileWithConfig('add', filePath)
			})
			.on('change', compileWithConfig.bind(null, 'change'))
			// on file delete, delete corresponding md file
			.on('unlink', (relPath: string) => {
				if (files.includes(relPath)) {
					files.splice(files.indexOf(relPath), 1)
					fs.unlink(config.getDestFile(relPath, config)).catch(e => {
						log.error(`[vue-docgen-cli] Error while deleting file ${relPath}: ${e}`)
					})
				} else {
					// if it's not a main file recompile the file connected to it
					compileWithConfig('delete', docMap[relPath])
				}
			})
	}
}

/**
 * Compile a markdown file from a components and save it
 * This will use the filePath to know where to save
 * @param config config passed to the current chunk
 * @param docMap a map of each documentation file to the component they refer to
 * @param watcher
 * @param filePath relative path where the MD file is going to be saved
 */
export async function compile(
	config: DocgenCLIConfigWithComponents,
	docMap: { [filepath: string]: string },
	watcher: FSWatcher,
	event: FileEventType,
	filePath: string,
	fromWatcher: boolean = true
) {
	if (fromWatcher) {
		log.info(`[vue-docgen-cli] ${event} to ${filePath} detected.`)
	}
	const componentFile = docMap[filePath] || filePath
	const file = config.getDestFile(componentFile, config)

	// if getDestFile is null, will not create files
	if (file) {
		try {
			const { content, dependencies } = await compileTemplates(
				event,
				path.join(config.componentsRoot, componentFile),
				config,
				componentFile
			)
			dependencies.forEach(d => {
				watcher.add(d)
				docMap[d] = componentFile
			})
			await writeDownMdFile(content, file)
			log.info(`[vue-docgen-cli] File ${file} updated.`)
		} catch (e) {
			if (config.watch) {
				log.error('\x1b[31m%s\x1b[0m', `[vue-docgen-cli] Error compiling file ${file}:`)
				log.error(e)
			} else {
				const err = e as Error
				throw new Error(`[vue-docgen-cli] Error compiling file ${file}: ${err.message}`)
			}
		}
	}
}