vue-docgen-cli/src/templates/utils.ts

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

import fs from 'fs'
import path from 'path'
import memoize from 'lodash.memoize'

/**
 * Replaces returns and tubes to make the input compatible with markdown
 * also makes sure < and > are escaped so html tags are not rendered
 * @param input
 */
export function mdclean(input: string): string {
	if (typeof input !== 'string') {
		return `${input}`
	}
	return input
		.replace(/</g, '&lt;')
		.replace(/>/g, '&gt;')
		.replace(/\|/g, '\\|')
		.replace(/\r?\n/g, '<br/>')
}

const readdirSync = memoize(fs.readdirSync)

/**
 * Find a file in a directory, case-insensitive
 *
 * @param {string} filepath
 * @return {string|undefined} File path with correct case
 */
export function findFileCaseInsensitive(filepath: string): string | undefined {
	const dir = path.dirname(filepath)
	const fileNameLower = path.basename(filepath).toLowerCase()
	const files = readdirSync(dir)
	const found = files.find((file: string) => file.toLowerCase() === fileNameLower)
	return found && path.join(dir, found)
}

/**
 * Clear cache.
 */
export function clearCache() {
	const sync = readdirSync.cache as any
	sync.clear()
}