@storybook/addon-docs/dist/modern/lib/convert/flow/convert.js

Document component usage and properties in Markdown

/* eslint-disable no-case-declarations */
const isLiteral = type => type.name === 'literal';

const toEnumOption = element => element.value.replace(/['|"]/g, '');

const convertSig = type => {
  switch (type.type) {
    case 'function':
      return {
        name: 'function'
      };

    case 'object':
      const values = {};
      type.signature.properties.forEach(prop => {
        values[prop.key] = convert(prop.value);
      });
      return {
        name: 'object',
        value: values
      };

    default:
      throw new Error(`Unknown: ${type}`);
  }
};

export const convert = type => {
  const {
    name,
    raw
  } = type;
  const base = {};
  if (typeof raw !== 'undefined') base.raw = raw;

  switch (type.name) {
    case 'literal':
      return Object.assign({}, base, {
        name: 'other',
        value: type.value
      });

    case 'string':
    case 'number':
    case 'symbol':
    case 'boolean':
      {
        return Object.assign({}, base, {
          name
        });
      }

    case 'Array':
      {
        return Object.assign({}, base, {
          name: 'array',
          value: type.elements.map(convert)
        });
      }

    case 'signature':
      return Object.assign({}, base, convertSig(type));

    case 'union':
      if (type.elements.every(isLiteral)) {
        return Object.assign({}, base, {
          name: 'enum',
          value: type.elements.map(toEnumOption)
        });
      }

      return Object.assign({}, base, {
        name,
        value: type.elements.map(convert)
      });

    case 'intersection':
      return Object.assign({}, base, {
        name,
        value: type.elements.map(convert)
      });

    default:
      return Object.assign({}, base, {
        name: 'other',
        value: name
      });
  }
};