@storybook/addon-docs 6.5.0-alpha.5 → 6.5.0-alpha.52

package/dist/modern/lib/convert/proptypes/convert.js

@@ -1,102 +0,0 @@
-/* eslint-disable no-case-declarations */
-import mapValues from 'lodash/mapValues';
-import { trimQuotes } from '../utils';
-const SIGNATURE_REGEXP = /^\(.*\) => /;
-export const convert = type => {
-  const {
-    name,
-    raw,
-    computed,
-    value
-  } = type;
-  const base = {};
-  if (typeof raw !== 'undefined') base.raw = raw;
-
-  switch (name) {
-    case 'enum':
-      {
-        const values = computed ? value : value.map(v => trimQuotes(v.value));
-        return Object.assign({}, base, {
-          name,
-          value: values
-        });
-      }
-
-    case 'string':
-    case 'number':
-    case 'symbol':
-      return Object.assign({}, base, {
-        name
-      });
-
-    case 'func':
-      return Object.assign({}, base, {
-        name: 'function'
-      });
-
-    case 'bool':
-    case 'boolean':
-      return Object.assign({}, base, {
-        name: 'boolean'
-      });
-
-    case 'arrayOf':
-    case 'array':
-      return Object.assign({}, base, {
-        name: 'array',
-        value: value && convert(value)
-      });
-
-    case 'object':
-      return Object.assign({}, base, {
-        name
-      });
-
-    case 'objectOf':
-      return Object.assign({}, base, {
-        name,
-        value: convert(value)
-      });
-
-    case 'shape':
-    case 'exact':
-      const values = mapValues(value, field => convert(field));
-      return Object.assign({}, base, {
-        name: 'object',
-        value: values
-      });
-
-    case 'union':
-      return Object.assign({}, base, {
-        name: 'union',
-        value: value.map(v => convert(v))
-      });
-
-    case 'instanceOf':
-    case 'element':
-    case 'elementType':
-    default:
-      {
-        if ((name === null || name === void 0 ? void 0 : name.indexOf('|')) > 0) {
-          // react-docgen-typescript-plugin doesn't always produce enum-like unions
-          // (like if a user has turned off shouldExtractValuesFromUnion) so here we
-          // try to recover and construct one.
-          try {
-            const literalValues = name.split('|').map(v => JSON.parse(v));
-            return Object.assign({}, base, {
-              name: 'enum',
-              value: literalValues
-            });
-          } catch (err) {// fall through
-          }
-        }
-
-        const otherVal = value ? `${name}(${value})` : name;
-        const otherName = SIGNATURE_REGEXP.test(name) ? 'function' : 'other';
-        return Object.assign({}, base, {
-          name: otherName,
-          value: otherVal
-        });
-      }
-  }
-};

package/dist/modern/lib/convert/proptypes/index.js

@@ -1,2 +0,0 @@
-export * from './convert';
-export * from './types';

package/dist/modern/lib/convert/typescript/convert.js

@@ -1,67 +0,0 @@
-/* eslint-disable no-case-declarations */
-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 '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':
-    case 'intersection':
-      return Object.assign({}, base, {
-        name,
-        value: type.elements.map(convert)
-      });
-
-    default:
-      return Object.assign({}, base, {
-        name: 'other',
-        value: name
-      });
-  }
-};

package/dist/modern/lib/convert/typescript/index.js

@@ -1,2 +0,0 @@
-export * from './convert';
-export * from './types';

package/dist/modern/lib/convert/utils.js

@@ -1,2 +0,0 @@
-const QUOTE_REGEX = /^['"]|['"]$/g;
-export const trimQuotes = str => str.replace(QUOTE_REGEX, '');

package/dist/modern/lib/docgen/createPropDef.js

@@ -1,142 +0,0 @@
-import { TypeSystem } from './types';
-import { createSummaryValue } from '../utils';
-import { createFlowPropDef } from './flow/createPropDef';
-import { isDefaultValueBlacklisted } from './utils/defaultValue';
-import { createTsPropDef } from './typeScript/createPropDef';
-import { convert } from '../convert';
-
-function createType(type) {
-  // A type could be null if a defaultProp has been provided without a type definition.
-  return type != null ? createSummaryValue(type.name) : null;
-} // A heuristic to tell if a defaultValue comes from RDT
-
-
-function isReactDocgenTypescript(defaultValue) {
-  const {
-    computed,
-    func
-  } = defaultValue;
-  return typeof computed === 'undefined' && typeof func === 'undefined';
-}
-
-function isStringValued(type) {
-  if (!type) {
-    return false;
-  }
-
-  if (type.name === 'string') {
-    return true;
-  }
-
-  if (type.name === 'enum') {
-    return Array.isArray(type.value) && type.value.every(({
-      value: tv
-    }) => typeof tv === 'string' && tv[0] === '"' && tv[tv.length - 1] === '"');
-  }
-
-  return false;
-}
-
-function createDefaultValue(defaultValue, type) {
-  if (defaultValue != null) {
-    const {
-      value
-    } = defaultValue;
-
-    if (!isDefaultValueBlacklisted(value)) {
-      // Work around a bug in `react-docgen-typescript-loader`, which returns 'string' for a string
-      // default, instead of "'string'" -- which is incorrect
-      if (isReactDocgenTypescript(defaultValue) && isStringValued(type)) {
-        return createSummaryValue(JSON.stringify(value));
-      }
-
-      return createSummaryValue(value);
-    }
-  }
-
-  return null;
-}
-
-function createBasicPropDef(name, type, docgenInfo) {
-  const {
-    description,
-    required,
-    defaultValue
-  } = docgenInfo;
-  return {
-    name,
-    type: createType(type),
-    required,
-    description,
-    defaultValue: createDefaultValue(defaultValue, type)
-  };
-}
-
-function applyJsDocResult(propDef, jsDocParsingResult) {
-  if (jsDocParsingResult.includesJsDoc) {
-    const {
-      description,
-      extractedTags
-    } = jsDocParsingResult;
-
-    if (description != null) {
-      // eslint-disable-next-line no-param-reassign
-      propDef.description = jsDocParsingResult.description;
-    }
-
-    const hasParams = extractedTags.params != null;
-    const hasReturns = extractedTags.returns != null && extractedTags.returns.type != null;
-
-    if (hasParams || hasReturns) {
-      // eslint-disable-next-line no-param-reassign
-      propDef.jsDocTags = {
-        params: hasParams && extractedTags.params.map(x => ({
-          name: x.getPrettyName(),
-          description: x.description
-        })),
-        returns: hasReturns && {
-          description: extractedTags.returns.description
-        }
-      };
-    }
-  }
-
-  return propDef;
-}
-
-export const javaScriptFactory = (propName, docgenInfo, jsDocParsingResult) => {
-  const propDef = createBasicPropDef(propName, docgenInfo.type, docgenInfo);
-  propDef.sbType = convert(docgenInfo);
-  return applyJsDocResult(propDef, jsDocParsingResult);
-};
-export const tsFactory = (propName, docgenInfo, jsDocParsingResult) => {
-  const propDef = createTsPropDef(propName, docgenInfo);
-  propDef.sbType = convert(docgenInfo);
-  return applyJsDocResult(propDef, jsDocParsingResult);
-};
-export const flowFactory = (propName, docgenInfo, jsDocParsingResult) => {
-  const propDef = createFlowPropDef(propName, docgenInfo);
-  propDef.sbType = convert(docgenInfo);
-  return applyJsDocResult(propDef, jsDocParsingResult);
-};
-export const unknownFactory = (propName, docgenInfo, jsDocParsingResult) => {
-  const propDef = createBasicPropDef(propName, {
-    name: 'unknown'
-  }, docgenInfo);
-  return applyJsDocResult(propDef, jsDocParsingResult);
-};
-export const getPropDefFactory = typeSystem => {
-  switch (typeSystem) {
-    case TypeSystem.JAVASCRIPT:
-      return javaScriptFactory;
-
-    case TypeSystem.TYPESCRIPT:
-      return tsFactory;
-
-    case TypeSystem.FLOW:
-      return flowFactory;
-
-    default:
-      return unknownFactory;
-  }
-};

package/dist/modern/lib/docgen/extractDocgenProps.js

@@ -1,80 +0,0 @@
-import { parseJsDoc } from '../jsdocParser';
-import { TypeSystem } from './types';
-import { getDocgenSection, isValidDocgenSection, getDocgenDescription } from './utils';
-import { getPropDefFactory } from './createPropDef';
-
-const getTypeSystem = docgenInfo => {
-  if (docgenInfo.type != null) {
-    return TypeSystem.JAVASCRIPT;
-  }
-
-  if (docgenInfo.flowType != null) {
-    return TypeSystem.FLOW;
-  }
-
-  if (docgenInfo.tsType != null) {
-    return TypeSystem.TYPESCRIPT;
-  }
-
-  return TypeSystem.UNKNOWN;
-};
-
-export const extractComponentSectionArray = docgenSection => {
-  const typeSystem = getTypeSystem(docgenSection[0]);
-  const createPropDef = getPropDefFactory(typeSystem);
-  return docgenSection.map(item => {
-    var _item$type;
-
-    let sanitizedItem = item;
-
-    if ((_item$type = item.type) !== null && _item$type !== void 0 && _item$type.elements) {
-      sanitizedItem = Object.assign({}, item, {
-        type: Object.assign({}, item.type, {
-          value: item.type.elements
-        })
-      });
-    }
-
-    return extractProp(sanitizedItem.name, sanitizedItem, typeSystem, createPropDef);
-  });
-};
-export const extractComponentSectionObject = docgenSection => {
-  const docgenPropsKeys = Object.keys(docgenSection);
-  const typeSystem = getTypeSystem(docgenSection[docgenPropsKeys[0]]);
-  const createPropDef = getPropDefFactory(typeSystem);
-  return docgenPropsKeys.map(propName => {
-    const docgenInfo = docgenSection[propName];
-    return docgenInfo != null ? extractProp(propName, docgenInfo, typeSystem, createPropDef) : null;
-  }).filter(Boolean);
-};
-export const extractComponentProps = (component, section) => {
-  const docgenSection = getDocgenSection(component, section);
-
-  if (!isValidDocgenSection(docgenSection)) {
-    return [];
-  } // vue-docgen-api has diverged from react-docgen and returns an array
-
-
-  return Array.isArray(docgenSection) ? extractComponentSectionArray(docgenSection) : extractComponentSectionObject(docgenSection);
-};
-
-function extractProp(propName, docgenInfo, typeSystem, createPropDef) {
-  const jsDocParsingResult = parseJsDoc(docgenInfo.description);
-  const isIgnored = jsDocParsingResult.includesJsDoc && jsDocParsingResult.ignore;
-
-  if (!isIgnored) {
-    const propDef = createPropDef(propName, docgenInfo, jsDocParsingResult);
-    return {
-      propDef,
-      jsDocTags: jsDocParsingResult.extractedTags,
-      docgenInfo,
-      typeSystem
-    };
-  }
-
-  return null;
-}
-
-export function extractComponentDescription(component) {
-  return component != null && getDocgenDescription(component);
-}

package/dist/modern/lib/docgen/flow/createDefaultValue.js

@@ -1,15 +0,0 @@
-import { createSummaryValue, isTooLongForDefaultValueSummary } from '../../utils';
-import { isDefaultValueBlacklisted } from '../utils/defaultValue';
-export function createDefaultValue(defaultValue, type) {
-  if (defaultValue != null) {
-    const {
-      value
-    } = defaultValue;
-
-    if (!isDefaultValueBlacklisted(value)) {
-      return !isTooLongForDefaultValueSummary(value) ? createSummaryValue(value) : createSummaryValue(type.name, value);
-    }
-  }
-
-  return null;
-}

package/dist/modern/lib/docgen/flow/createPropDef.js

@@ -1,17 +0,0 @@
-import { createType } from './createType';
-import { createDefaultValue } from './createDefaultValue';
-export const createFlowPropDef = (propName, docgenInfo) => {
-  const {
-    flowType,
-    description,
-    required,
-    defaultValue
-  } = docgenInfo;
-  return {
-    name: propName,
-    type: createType(flowType),
-    required,
-    description,
-    defaultValue: createDefaultValue(defaultValue, flowType)
-  };
-};

package/dist/modern/lib/docgen/flow/createType.js

@@ -1,103 +0,0 @@
-import { createSummaryValue, isTooLongForTypeSummary } from '../../utils';
-var FlowTypesType;
-
-(function (FlowTypesType) {
-  FlowTypesType["UNION"] = "union";
-  FlowTypesType["SIGNATURE"] = "signature";
-})(FlowTypesType || (FlowTypesType = {}));
-
-function generateUnionElement({
-  name,
-  value,
-  elements,
-  raw
-}) {
-  if (value != null) {
-    return value;
-  }
-
-  if (elements != null) {
-    return elements.map(generateUnionElement).join(' | ');
-  }
-
-  if (raw != null) {
-    return raw;
-  }
-
-  return name;
-}
-
-function generateUnion({
-  name,
-  raw,
-  elements
-}) {
-  if (elements != null) {
-    return createSummaryValue(elements.map(generateUnionElement).join(' | '));
-  }
-
-  if (raw != null) {
-    // Flow Unions can be defined with or without a leading `|` character, so try to remove it.
-    return createSummaryValue(raw.replace(/^\|\s*/, ''));
-  }
-
-  return createSummaryValue(name);
-}
-
-function generateFuncSignature({
-  type,
-  raw
-}) {
-  if (raw != null) {
-    return createSummaryValue(raw);
-  }
-
-  return createSummaryValue(type);
-}
-
-function generateObjectSignature({
-  type,
-  raw
-}) {
-  if (raw != null) {
-    return !isTooLongForTypeSummary(raw) ? createSummaryValue(raw) : createSummaryValue(type, raw);
-  }
-
-  return createSummaryValue(type);
-}
-
-function generateSignature(flowType) {
-  const {
-    type
-  } = flowType;
-  return type === 'object' ? generateObjectSignature(flowType) : generateFuncSignature(flowType);
-}
-
-function generateDefault({
-  name,
-  raw
-}) {
-  if (raw != null) {
-    return !isTooLongForTypeSummary(raw) ? createSummaryValue(raw) : createSummaryValue(name, raw);
-  }
-
-  return createSummaryValue(name);
-}
-
-export function createType(type) {
-  // A type could be null if a defaultProp has been provided without a type definition.
-  if (type == null) {
-    return null;
-  }
-
-  switch (type.name) {
-    case FlowTypesType.UNION:
-      return generateUnion(type);
-
-    case FlowTypesType.SIGNATURE:
-      return generateSignature(type);
-
-    default:
-      return generateDefault(type);
-  }
-}

package/dist/modern/lib/docgen/index.js

@@ -1,3 +0,0 @@
-export * from './types';
-export * from './utils';
-export * from './extractDocgenProps';

package/dist/modern/lib/docgen/typeScript/createDefaultValue.js

@@ -1,17 +0,0 @@
-import { createSummaryValue } from '../../utils';
-import { isDefaultValueBlacklisted } from '../utils/defaultValue';
-export function createDefaultValue({
-  defaultValue
-}) {
-  if (defaultValue != null) {
-    const {
-      value
-    } = defaultValue;
-
-    if (!isDefaultValueBlacklisted(value)) {
-      return createSummaryValue(value);
-    }
-  }
-
-  return null;
-}

package/dist/modern/lib/docgen/typeScript/createPropDef.js

@@ -1,15 +0,0 @@
-import { createType } from './createType';
-import { createDefaultValue } from './createDefaultValue';
-export const createTsPropDef = (propName, docgenInfo) => {
-  const {
-    description,
-    required
-  } = docgenInfo;
-  return {
-    name: propName,
-    type: createType(docgenInfo),
-    required,
-    description,
-    defaultValue: createDefaultValue(docgenInfo)
-  };
-};

package/dist/modern/lib/docgen/typeScript/createType.js

@@ -1,16 +0,0 @@
-import { createSummaryValue } from '../../utils';
-export function createType({
-  tsType,
-  required
-}) {
-  // A type could be null if a defaultProp has been provided without a type definition.
-  if (tsType == null) {
-    return null;
-  }
-
-  if (!required) {
-    return createSummaryValue(tsType.name.replace(' | undefined', ''));
-  }
-
-  return createSummaryValue(tsType.name);
-}

package/dist/modern/lib/docgen/types.js

@@ -1,10 +0,0 @@
-// eslint-disable-next-line @typescript-eslint/no-empty-interface
-// export type DocgenType = DocgenPropType | DocgenFlowType | DocgenTypeScriptType;
-export let TypeSystem;
-
-(function (TypeSystem) {
-  TypeSystem["JAVASCRIPT"] = "JavaScript";
-  TypeSystem["FLOW"] = "Flow";
-  TypeSystem["TYPESCRIPT"] = "TypeScript";
-  TypeSystem["UNKNOWN"] = "Unknown";
-})(TypeSystem || (TypeSystem = {}));

package/dist/modern/lib/docgen/utils/defaultValue.js

@@ -1,4 +0,0 @@
-const BLACKLIST = ['null', 'undefined'];
-export function isDefaultValueBlacklisted(value) {
-  return BLACKLIST.some(x => x === value);
-}

package/dist/modern/lib/docgen/utils/docgenInfo.js

@@ -1,14 +0,0 @@
-/* eslint-disable no-underscore-dangle */
-import { str } from './string';
-export function hasDocgen(component) {
-  return !!component.__docgenInfo;
-}
-export function isValidDocgenSection(docgenSection) {
-  return docgenSection != null && Object.keys(docgenSection).length > 0;
-}
-export function getDocgenSection(component, section) {
-  return hasDocgen(component) ? component.__docgenInfo[section] : null;
-}
-export function getDocgenDescription(component) {
-  return hasDocgen(component) && str(component.__docgenInfo.description);
-}

package/dist/modern/lib/docgen/utils/index.js

@@ -1,3 +0,0 @@
-export * from './defaultValue';
-export * from './string';
-export * from './docgenInfo';

package/dist/modern/lib/docgen/utils/string.js

@@ -1,11 +0,0 @@
-export const str = obj => {
-  if (!obj) {
-    return '';
-  }
-
-  if (typeof obj === 'string') {
-    return obj;
-  }
-
-  throw new Error(`Description: expected string, got: ${JSON.stringify(obj)}`);
-};

package/dist/modern/lib/index.js

@@ -1 +0,0 @@
-export * from './utils';