Skip to content

Commit

Permalink
refactor: refactored generate-readmes.js helper a bit
Browse files Browse the repository at this point in the history
  • Loading branch information
andres-kovalev committed Oct 30, 2019
1 parent 41c52b1 commit 7ada431
Showing 1 changed file with 17 additions and 6 deletions.
23 changes: 17 additions & 6 deletions tools/generate-readmes.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,16 @@ jsdoc2md.getTemplateDataSync({ files: './src/*/*/index.js' })
.forEach(generateReadme);

function generateReadme(meta) {
const { filename, path } = meta.meta;
const [ name ] = filename.split('.');
const mdName = name === 'index' ? 'README' : name;
const file = getMarkdownFileName(meta);
const markdown = generateReadmeMarkdown(meta);

writeFile(file, markdown);
}

function generateReadmeMarkdown(meta) {
const { scope, customTags, ...data } = meta;

let md = jsdoc2md.renderSync({
const markdown = jsdoc2md.renderSync({
data: [ data ],
'param-list-format': 'list'
});
Expand All @@ -21,8 +24,16 @@ function generateReadme(meta) {
({ tag }) => tag === 'docs'
) || {};

md = [ md, '**Description**', value ].join('\n\n');
return [ markdown, '**Description**', value ].join('\n\n');
}

writeFile(`${ path }/${ mdName }.md`, md);
return markdown;
}

function getMarkdownFileName({ meta }) {
const { filename, path } = meta;
const [ name ] = filename.split('.');
const mdName = name === 'index' ? 'README' : name;

return `${ path }/${ mdName }.md`;
}

0 comments on commit 7ada431

Please sign in to comment.