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

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

import type { MethodDescriptor, Param } from 'vue-docgen-api'
import { mdclean } from './utils'
import { SubTemplateOptions } from '../compileTemplates'

const paramsTmpl = (params: Param[], subComponent: boolean): string => {
	let ret = `
${subComponent ? '#' : ''}#### Params

  | Param name     | Type        | Description  |
  | ------------- |------------- | -------------|
  `

	params.forEach(p => {
		const t = p.type && p.type.name ? p.type.name : ''
		const n = p.name ? p.name : ''
		const d = typeof p.description === 'string' ? p.description : ''

		ret += `| ${mdclean(n)} | ${mdclean(t)} | ${mdclean(d)} |\n`
	})

	return ret
}

const returnsTemplate = (ret: Param, subComponent: boolean) => {
	const p = ret
	const t = p.type && p.type.name ? p.type.name : ''
	const d = p.description ? p.description : ''

	return `
${subComponent ? '#' : ''}#### Return

  | Type        | Description  |
  | ------------- | -------------|
  | ${t} | ${d} |
  `
}

const tmpl = function (methods: MethodDescriptor[], subComponent: boolean) {
	let ret = ''

	methods.forEach(m => {
		ret += `
${subComponent ? '#' : ''}### ${m.name ? m.name : ''}
  > ${m.description || ''}

  ${m.params ? paramsTmpl(m.params, subComponent) : ''}
  ${m.returns ? returnsTemplate(m.returns, subComponent) : ''}
  `
	})
	return ret
}

export default (methods: MethodDescriptor[], opt: SubTemplateOptions = {}): string => {
	if (Object.keys(methods).length === 0) {
		return ''
	}
	return `
${opt.isSubComponent || opt.hasSubComponents ? '#' : ''}## Methods

  ${tmpl(methods, opt.isSubComponent || opt.hasSubComponents || false)}
  `
}