mirror of
https://github.com/optim-enterprises-bv/vault.git
synced 2025-10-30 18:17:55 +00:00
e61bd967e3
* move script to scripts folder * add docfy to router and scripts * add docfy to router and scripts * fix jsdoc syntax * add component markdown files to gitignore * improve error handling for scripts * tidy up remaining jsdoc syntax * add sample jsdoc components * add known issue info * make not using multi-line components clearer * make generating docs clearer * update copy * final how to docfy cleanup * fix ts file @module syntax * fix read more syntax * make docfy typescript compatible
55 lines
1.5 KiB
JavaScript
55 lines
1.5 KiB
JavaScript
#!/usr/bin/env node
|
|
|
|
/**
|
|
* Copyright (c) HashiCorp, Inc.
|
|
* SPDX-License-Identifier: BUSL-1.1
|
|
*/
|
|
|
|
/* eslint-disable */
|
|
|
|
/*
|
|
run from the ui directory:
|
|
yarn docfy-md some-component
|
|
|
|
or if the docs are for a component in an in-repo-addon or an engine:
|
|
yarn docfy-md some-component name-of-engine
|
|
*/
|
|
|
|
const fs = require('fs');
|
|
const jsdoc2md = require('jsdoc-to-markdown');
|
|
|
|
// the fullFilepath arg will override the assumed inputFile which is built using the addonOrEngine arg
|
|
const [nameOrFile, addonOrEngine, fullFilepath] = process.argv.slice(2);
|
|
|
|
const isFile = nameOrFile.includes('.');
|
|
const name = isFile ? nameOrFile?.split('.')[0] : nameOrFile; // can pass component-name or component-name.js
|
|
const path = isFile ? nameOrFile : `${nameOrFile}.js`; // default to js
|
|
|
|
const inputFile = addonOrEngine ? `lib/${addonOrEngine}/addon/components/${path}` : `app/components/${path}`;
|
|
const outputFile = `docs/components/${name}.md`;
|
|
|
|
const outputFormat = `
|
|
{{#module}}
|
|
# {{name}}
|
|
{{>body}}
|
|
{{/module}}
|
|
`;
|
|
|
|
const options = {
|
|
files: fullFilepath || inputFile,
|
|
'example-lang': 'hbs preview-template',
|
|
configure: './jsdoc2md.json',
|
|
template: outputFormat,
|
|
};
|
|
|
|
try {
|
|
const md = jsdoc2md.renderSync(options);
|
|
// for some reason components without a jsdoc @module doesn't throw, so throw manually
|
|
if (md.includes('ERROR')) throw `${md} (there is probably no jsdoc for this component)`;
|
|
fs.writeFileSync(outputFile, md);
|
|
console.log(`✅ ${name}`);
|
|
} catch (error) {
|
|
console.log(`❌ ${name}`);
|
|
console.log(error);
|
|
}
|