@dotconnor/grommet/tools/generate-readme.js

focus on the essential experience

import del from 'del';
import fs from 'fs';
import path from 'path';

const code = '```';

const replaceHoc = content => content.replace(/(With.*\()(.*)(\))/g, '$2');

const toMarkdown = theme => {
  const themeProps = Object.keys(theme).map(
    themeEntry => `
**${themeEntry}**

${theme[themeEntry].description} Expects \`${theme[themeEntry].type}\`.

Defaults to

${code}
${theme[themeEntry].defaultValue}
${code}
`,
  );
  return `## Theme
  ${themeProps.join('')}`;
};

const components = folder =>
  fs
    .readdirSync(folder)
    .filter(
      file =>
        fs.statSync(path.join(folder, file)).isDirectory() &&
        fs.existsSync(path.join(folder, file, 'doc.js')),
    );

const FOLDER = path.resolve('src/js/components');

components(FOLDER).forEach(component => {
  /* eslint-disable */
  const { doc, themeDoc } = require(path.join(FOLDER, component, 'doc.js'));
  const componentModule = require(path.join(FOLDER, component, 'index.js'));
  // we use the second array element since the first is '__esModule'.
  const Component =
    componentModule[
      Object.keys(componentModule).filter(k => k === component)[0]
    ];
  /* eslint-enable */

  const readmeDestination = path.join(FOLDER, component, 'README.md');

  const DocumentedComponent = doc(Component);

  const readmeContent = themeDoc
    ? `${replaceHoc(DocumentedComponent.toMarkdown())}\n${toMarkdown(themeDoc)}`
    : `${replaceHoc(DocumentedComponent.toMarkdown())}`;
  del(readmeDestination).then(() =>
    fs.writeFileSync(readmeDestination, readmeContent),
  );
});