@storybook/addon-docs 6.5.0-alpha.6 → 6.5.0-alpha.62

package/dist/esm/frameworks/react/lib/defaultValues/createDefaultValue.js

@@ -1,67 +0,0 @@
-import { FUNCTION_CAPTION, ELEMENT_CAPTION } from '../captions';
-import { InspectionType, inspectValue } from '../inspection';
-import { isHtmlTag } from '../isHtmlTag';
-import { createSummaryValue, isTooLongForDefaultValueSummary } from '../../../../lib';
-import { generateCode } from '../generateCode';
-import { generateObject } from './generateObject';
-import { generateArray } from './generateArray';
-import { getPrettyIdentifier } from './prettyIdentifier';
-
-function generateFunc(_ref) {
-  var inferredType = _ref.inferredType,
-      ast = _ref.ast;
-  var _ref2 = inferredType,
-      identifier = _ref2.identifier;
-
-  if (identifier != null) {
-    return createSummaryValue(getPrettyIdentifier(inferredType), generateCode(ast));
-  }
-
-  var prettyCaption = generateCode(ast, true);
-  return !isTooLongForDefaultValueSummary(prettyCaption) ? createSummaryValue(prettyCaption) : createSummaryValue(FUNCTION_CAPTION, generateCode(ast));
-} // All elements are JSX elements.
-// JSX elements are not supported by escodegen.
-
-
-function generateElement(defaultValue, inspectionResult) {
-  var inferredType = inspectionResult.inferredType;
-  var _ref3 = inferredType,
-      identifier = _ref3.identifier;
-
-  if (identifier != null) {
-    if (!isHtmlTag(identifier)) {
-      var prettyIdentifier = getPrettyIdentifier(inferredType);
-      return createSummaryValue(prettyIdentifier, defaultValue);
-    }
-  }
-
-  return !isTooLongForDefaultValueSummary(defaultValue) ? createSummaryValue(defaultValue) : createSummaryValue(ELEMENT_CAPTION, defaultValue);
-}
-
-export function createDefaultValue(defaultValue) {
-  try {
-    var inspectionResult = inspectValue(defaultValue);
-
-    switch (inspectionResult.inferredType.type) {
-      case InspectionType.OBJECT:
-        return generateObject(inspectionResult);
-
-      case InspectionType.FUNCTION:
-        return generateFunc(inspectionResult);
-
-      case InspectionType.ELEMENT:
-        return generateElement(defaultValue, inspectionResult);
-
-      case InspectionType.ARRAY:
-        return generateArray(inspectionResult);
-
-      default:
-        return null;
-    }
-  } catch (e) {
-    // eslint-disable-next-line no-console
-    console.error(e);
-  }
-
-  return null;
-}

package/dist/esm/frameworks/react/lib/defaultValues/createFromRawDefaultProp.js

@@ -1,191 +0,0 @@
-function _typeof(obj) { "@babel/helpers - typeof"; if (typeof Symbol === "function" && typeof Symbol.iterator === "symbol") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }; } return _typeof(obj); }
-
-import "core-js/modules/es.function.name.js";
-import "core-js/modules/es.string.replace.js";
-import "core-js/modules/es.regexp.exec.js";
-import "core-js/modules/es.object.to-string.js";
-import "core-js/modules/es.regexp.to-string.js";
-import "core-js/modules/es.object.assign.js";
-import "core-js/modules/es.symbol.js";
-import "core-js/modules/es.symbol.description.js";
-import "core-js/modules/es.symbol.iterator.js";
-import "core-js/modules/es.string.iterator.js";
-import "core-js/modules/es.array.iterator.js";
-import "core-js/modules/web.dom-collections.iterator.js";
-import isPlainObject from 'lodash/isPlainObject';
-import isFunction from 'lodash/isFunction';
-import isString from 'lodash/isString'; // @ts-ignore
-
-import reactElementToJSXString from 'react-element-to-jsx-string';
-import { createSummaryValue, isTooLongForDefaultValueSummary } from '../../../../lib';
-import { inspectValue } from '../inspection';
-import { generateObject } from './generateObject';
-import { generateArray } from './generateArray';
-import { getPrettyElementIdentifier, getPrettyFuncIdentifier } from './prettyIdentifier';
-import { OBJECT_CAPTION, FUNCTION_CAPTION, ELEMENT_CAPTION } from '../captions';
-import { isHtmlTag } from '../isHtmlTag';
-
-function isReactElement(element) {
-  return element.$$typeof != null;
-}
-
-export function extractFunctionName(func, propName) {
-  var name = func.name; // Comparison with the prop name is to discard inferred function names.
-
-  if (name !== '' && name !== 'anonymous' && name !== propName) {
-    return name;
-  }
-
-  return null;
-}
-
-var stringResolver = function stringResolver(rawDefaultProp) {
-  return createSummaryValue(JSON.stringify(rawDefaultProp));
-};
-
-function generateReactObject(rawDefaultProp) {
-  var type = rawDefaultProp.type;
-  var displayName = type.displayName;
-  var jsx = reactElementToJSXString(rawDefaultProp, {});
-
-  if (displayName != null) {
-    var prettyIdentifier = getPrettyElementIdentifier(displayName);
-    return createSummaryValue(prettyIdentifier, jsx);
-  }
-
-  if (isString(type)) {
-    // This is an HTML element.
-    if (isHtmlTag(type)) {
-      var jsxCompact = reactElementToJSXString(rawDefaultProp, {
-        tabStop: 0
-      });
-      var jsxSummary = jsxCompact.replace(/\r?\n|\r/g, '');
-
-      if (!isTooLongForDefaultValueSummary(jsxSummary)) {
-        return createSummaryValue(jsxSummary);
-      }
-    }
-  }
-
-  return createSummaryValue(ELEMENT_CAPTION, jsx);
-}
-
-var objectResolver = function objectResolver(rawDefaultProp) {
-  if (isReactElement(rawDefaultProp) && rawDefaultProp.type != null) {
-    return generateReactObject(rawDefaultProp);
-  }
-
-  if (isPlainObject(rawDefaultProp)) {
-    var inspectionResult = inspectValue(JSON.stringify(rawDefaultProp));
-    return generateObject(inspectionResult);
-  }
-
-  if (Array.isArray(rawDefaultProp)) {
-    var _inspectionResult = inspectValue(JSON.stringify(rawDefaultProp));
-
-    return generateArray(_inspectionResult);
-  }
-
-  return createSummaryValue(OBJECT_CAPTION);
-};
-
-var functionResolver = function functionResolver(rawDefaultProp, propDef) {
-  var isElement = false;
-  var inspectionResult; // Try to display the name of the component. The body of the component is omitted since the code has been transpiled.
-
-  if (isFunction(rawDefaultProp.render)) {
-    isElement = true;
-  } else if (rawDefaultProp.prototype != null && isFunction(rawDefaultProp.prototype.render)) {
-    isElement = true;
-  } else {
-    var innerElement;
-
-    try {
-      inspectionResult = inspectValue(rawDefaultProp.toString());
-      var _ref = inspectionResult.inferredType,
-          hasParams = _ref.hasParams,
-          params = _ref.params;
-
-      if (hasParams) {
-        // It might be a functional component accepting props.
-        if (params.length === 1 && params[0].type === 'ObjectPattern') {
-          innerElement = rawDefaultProp({});
-        }
-      } else {
-        innerElement = rawDefaultProp();
-      }
-
-      if (innerElement != null) {
-        if (isReactElement(innerElement)) {
-          isElement = true;
-        }
-      }
-    } catch (e) {// do nothing.
-    }
-  }
-
-  var funcName = extractFunctionName(rawDefaultProp, propDef.name);
-
-  if (funcName != null) {
-    if (isElement) {
-      return createSummaryValue(getPrettyElementIdentifier(funcName));
-    }
-
-    if (inspectionResult != null) {
-      inspectionResult = inspectValue(rawDefaultProp.toString());
-    }
-
-    var _ref2 = inspectionResult.inferredType,
-        _hasParams = _ref2.hasParams;
-    return createSummaryValue(getPrettyFuncIdentifier(funcName, _hasParams));
-  }
-
-  return createSummaryValue(isElement ? ELEMENT_CAPTION : FUNCTION_CAPTION);
-};
-
-var defaultResolver = function defaultResolver(rawDefaultProp) {
-  return createSummaryValue(rawDefaultProp.toString());
-};
-
-var DEFAULT_TYPE_RESOLVERS = {
-  string: stringResolver,
-  object: objectResolver,
-  function: functionResolver,
-  default: defaultResolver
-};
-export function createTypeResolvers() {
-  var customResolvers = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-  return Object.assign({}, DEFAULT_TYPE_RESOLVERS, customResolvers);
-} // When react-docgen cannot provide a defaultValue we take it from the raw defaultProp.
-// It works fine for types that are not transpiled. For the types that are transpiled, we can only provide partial support.
-// This means that:
-//   - The detail might not be available.
-//   - Identifiers might not be "prettified" for all the types.
-
-export function createDefaultValueFromRawDefaultProp(rawDefaultProp, propDef) {
-  var typeResolvers = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : DEFAULT_TYPE_RESOLVERS;
-
-  try {
-    // Keep the extra () otherwise it will fail for functions.
-    switch (_typeof(rawDefaultProp)) {
-      case 'string':
-        return typeResolvers.string(rawDefaultProp, propDef);
-
-      case 'object':
-        return typeResolvers.object(rawDefaultProp, propDef);
-
-      case 'function':
-        {
-          return typeResolvers.function(rawDefaultProp, propDef);
-        }
-
-      default:
-        return typeResolvers.default(rawDefaultProp, propDef);
-    }
-  } catch (e) {
-    // eslint-disable-next-line no-console
-    console.error(e);
-  }
-
-  return null;
-}

package/dist/esm/frameworks/react/lib/defaultValues/generateArray.js

@@ -1,19 +0,0 @@
-import { ARRAY_CAPTION } from '../captions';
-import { createSummaryValue, isTooLongForDefaultValueSummary } from '../../../../lib';
-import { generateArrayCode } from '../generateCode';
-export function generateArray(_ref) {
-  var inferredType = _ref.inferredType,
-      ast = _ref.ast;
-  var _ref2 = inferredType,
-      depth = _ref2.depth;
-
-  if (depth <= 2) {
-    var compactArray = generateArrayCode(ast, true);
-
-    if (!isTooLongForDefaultValueSummary(compactArray)) {
-      return createSummaryValue(compactArray);
-    }
-  }
-
-  return createSummaryValue(ARRAY_CAPTION, generateArrayCode(ast));
-}

package/dist/esm/frameworks/react/lib/defaultValues/generateObject.js

@@ -1,19 +0,0 @@
-import { OBJECT_CAPTION } from '../captions';
-import { createSummaryValue, isTooLongForDefaultValueSummary } from '../../../../lib';
-import { generateObjectCode } from '../generateCode';
-export function generateObject(_ref) {
-  var inferredType = _ref.inferredType,
-      ast = _ref.ast;
-  var _ref2 = inferredType,
-      depth = _ref2.depth;
-
-  if (depth === 1) {
-    var compactObject = generateObjectCode(ast, true);
-
-    if (!isTooLongForDefaultValueSummary(compactObject)) {
-      return createSummaryValue(compactObject);
-    }
-  }
-
-  return createSummaryValue(OBJECT_CAPTION, generateObjectCode(ast));
-}

package/dist/esm/frameworks/react/lib/defaultValues/index.js

@@ -1,2 +0,0 @@
-export * from './createDefaultValue';
-export * from './createFromRawDefaultProp';

package/dist/esm/frameworks/react/lib/defaultValues/prettyIdentifier.js

@@ -1,22 +0,0 @@
-import { InspectionType } from '../inspection';
-export function getPrettyIdentifier(inferredType) {
-  var type = inferredType.type,
-      identifier = inferredType.identifier;
-
-  switch (type) {
-    case InspectionType.FUNCTION:
-      return getPrettyFuncIdentifier(identifier, inferredType.hasParams);
-
-    case InspectionType.ELEMENT:
-      return getPrettyElementIdentifier(identifier);
-
-    default:
-      return identifier;
-  }
-}
-export function getPrettyFuncIdentifier(identifier, hasArguments) {
-  return hasArguments ? "".concat(identifier, "( ... )") : "".concat(identifier, "()");
-}
-export function getPrettyElementIdentifier(identifier) {
-  return "<".concat(identifier, " />");
-}

package/dist/esm/frameworks/react/lib/generateCode.js

@@ -1,68 +0,0 @@
-import "core-js/modules/es.object.assign.js";
-import "core-js/modules/es.string.ends-with.js";
-import "core-js/modules/es.array.slice.js";
-import "core-js/modules/es.string.starts-with.js";
-import "core-js/modules/es.string.replace.js";
-import "core-js/modules/es.regexp.exec.js";
-import { generate } from 'escodegen';
-import dedent from 'ts-dedent';
-var BASIC_OPTIONS = {
-  format: {
-    indent: {
-      style: '  '
-    },
-    semicolons: false
-  }
-};
-var COMPACT_OPTIONS = Object.assign({}, BASIC_OPTIONS, {
-  format: {
-    newline: ''
-  }
-});
-var PRETTY_OPTIONS = Object.assign({}, BASIC_OPTIONS);
-export function generateCode(ast) {
-  var compact = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
-  return generate(ast, compact ? COMPACT_OPTIONS : PRETTY_OPTIONS);
-}
-export function generateObjectCode(ast) {
-  var compact = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
-  return !compact ? generateCode(ast) : generateCompactObjectCode(ast);
-}
-
-function generateCompactObjectCode(ast) {
-  var result = generateCode(ast, true); // Cannot get escodegen to add a space before the last } with the compact mode settings.
-  // Fix it until a better solution is found.
-
-  if (!result.endsWith(' }')) {
-    result = "".concat(result.slice(0, -1), " }");
-  }
-
-  return result;
-}
-
-export function generateArrayCode(ast) {
-  var compact = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
-  return !compact ? generateMultilineArrayCode(ast) : generateCompactArrayCode(ast);
-}
-
-function generateMultilineArrayCode(ast) {
-  var result = generateCode(ast); // escodegen add extra spacing before the closing bracket of a multiple line array with a nested object.
-  // Fix it until a better solution is found.
-
-  if (result.endsWith('  }]')) {
-    result = dedent(result);
-  }
-
-  return result;
-}
-
-function generateCompactArrayCode(ast) {
-  var result = generateCode(ast, true); // escodegen add extra an extra before the opening bracket of a compact array that contains primitive values.
-  // Fix it until a better solution is found.
-
-  if (result.startsWith('[    ')) {
-    result = result.replace('[    ', '[');
-  }
-
-  return result;
-}

package/dist/esm/frameworks/react/lib/index.js

@@ -1,4 +0,0 @@
-export * from './captions';
-export * from './isHtmlTag';
-export * from './generateCode';
-export * from './componentTypes';

package/dist/esm/frameworks/react/lib/inspection/acornParser.js

@@ -1,213 +0,0 @@
-import "core-js/modules/es.object.assign.js";
-import "core-js/modules/es.function.name.js";
-import "core-js/modules/es.array.filter.js";
-import { Parser } from 'acorn';
-import jsx from 'acorn-jsx'; // eslint-disable-next-line import/no-extraneous-dependencies
-
-import * as acornWalk from 'acorn-walk';
-import { InspectionType } from './types';
-var ACORN_WALK_VISITORS = Object.assign({}, acornWalk.base, {
-  JSXElement: function JSXElement() {}
-});
-var acornParser = Parser.extend(jsx()); // Cannot use "estree.Identifier" type because this function also support "JSXIdentifier".
-
-function extractIdentifierName(identifierNode) {
-  return identifierNode != null ? identifierNode.name : null;
-}
-
-function filterAncestors(ancestors) {
-  return ancestors.filter(function (x) {
-    return x.type === 'ObjectExpression' || x.type === 'ArrayExpression';
-  });
-}
-
-function calculateNodeDepth(node) {
-  var depths = [];
-  acornWalk.ancestor( // @ts-ignore
-  node, {
-    ObjectExpression: function ObjectExpression(_, ancestors) {
-      depths.push(filterAncestors(ancestors).length);
-    },
-    ArrayExpression: function ArrayExpression(_, ancestors) {
-      depths.push(filterAncestors(ancestors).length);
-    }
-  }, ACORN_WALK_VISITORS);
-  return Math.max.apply(Math, depths);
-}
-
-function parseIdentifier(identifierNode) {
-  return {
-    inferredType: {
-      type: InspectionType.IDENTIFIER,
-      identifier: extractIdentifierName(identifierNode)
-    },
-    ast: identifierNode
-  };
-}
-
-function parseLiteral(literalNode) {
-  return {
-    inferredType: {
-      type: InspectionType.LITERAL
-    },
-    ast: literalNode
-  };
-}
-
-function parseFunction(funcNode) {
-  var innerJsxElementNode; // If there is at least a JSXElement in the body of the function, then it's a React component.
-
-  acornWalk.simple( // @ts-ignore
-  funcNode.body, {
-    JSXElement: function JSXElement(node) {
-      innerJsxElementNode = node;
-    }
-  }, ACORN_WALK_VISITORS);
-  var isJsx = innerJsxElementNode != null;
-  var inferredType = {
-    type: isJsx ? InspectionType.ELEMENT : InspectionType.FUNCTION,
-    params: funcNode.params,
-    hasParams: funcNode.params.length !== 0
-  };
-  var identifierName = extractIdentifierName(funcNode.id);
-
-  if (identifierName != null) {
-    inferredType.identifier = identifierName;
-  }
-
-  return {
-    inferredType: inferredType,
-    ast: funcNode
-  };
-}
-
-function parseClass(classNode) {
-  var innerJsxElementNode; // If there is at least a JSXElement in the body of the class, then it's a React component.
-
-  acornWalk.simple( // @ts-ignore
-  classNode.body, {
-    JSXElement: function JSXElement(node) {
-      innerJsxElementNode = node;
-    }
-  }, ACORN_WALK_VISITORS);
-  var inferredType = {
-    type: innerJsxElementNode != null ? InspectionType.ELEMENT : InspectionType.CLASS,
-    identifier: extractIdentifierName(classNode.id)
-  };
-  return {
-    inferredType: inferredType,
-    ast: classNode
-  };
-}
-
-function parseJsxElement(jsxElementNode) {
-  var inferredType = {
-    type: InspectionType.ELEMENT
-  };
-  var identifierName = extractIdentifierName(jsxElementNode.openingElement.name);
-
-  if (identifierName != null) {
-    inferredType.identifier = identifierName;
-  }
-
-  return {
-    inferredType: inferredType,
-    ast: jsxElementNode
-  };
-}
-
-function parseCall(callNode) {
-  var identifierNode = callNode.callee.type === 'MemberExpression' ? callNode.callee.property : callNode.callee;
-  var identifierName = extractIdentifierName(identifierNode);
-
-  if (identifierName === 'shape') {
-    return parseObject(callNode.arguments[0]);
-  }
-
-  return null;
-}
-
-function parseObject(objectNode) {
-  return {
-    inferredType: {
-      type: InspectionType.OBJECT,
-      depth: calculateNodeDepth(objectNode)
-    },
-    ast: objectNode
-  };
-}
-
-function parseArray(arrayNode) {
-  return {
-    inferredType: {
-      type: InspectionType.ARRAY,
-      depth: calculateNodeDepth(arrayNode)
-    },
-    ast: arrayNode
-  };
-} // Cannot set "expression" type to "estree.Expression" because the type doesn't include JSX.
-
-
-function parseExpression(expression) {
-  switch (expression.type) {
-    case 'Identifier':
-      return parseIdentifier(expression);
-
-    case 'Literal':
-      return parseLiteral(expression);
-
-    case 'FunctionExpression':
-    case 'ArrowFunctionExpression':
-      return parseFunction(expression);
-
-    case 'ClassExpression':
-      return parseClass(expression);
-
-    case 'JSXElement':
-      return parseJsxElement(expression);
-
-    case 'CallExpression':
-      return parseCall(expression);
-
-    case 'ObjectExpression':
-      return parseObject(expression);
-
-    case 'ArrayExpression':
-      return parseArray(expression);
-
-    default:
-      return null;
-  }
-}
-
-export function parse(value) {
-  var ast = acornParser.parse("(".concat(value, ")"));
-  var parsingResult = {
-    inferredType: {
-      type: InspectionType.UNKNOWN
-    },
-    ast: ast
-  };
-
-  if (ast.body[0] != null) {
-    var rootNode = ast.body[0];
-
-    switch (rootNode.type) {
-      case 'ExpressionStatement':
-        {
-          var expressionResult = parseExpression(rootNode.expression);
-
-          if (expressionResult != null) {
-            parsingResult = expressionResult;
-          }
-
-          break;
-        }
-
-      default:
-        break;
-    }
-  }
-
-  return parsingResult;
-}

package/dist/esm/frameworks/react/lib/inspection/index.js

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

package/dist/esm/frameworks/react/lib/inspection/inspectValue.js

@@ -1,16 +0,0 @@
-import "core-js/modules/es.object.assign.js";
-import { parse } from './acornParser';
-import { InspectionType } from './types';
-export function inspectValue(value) {
-  try {
-    var parsingResult = parse(value);
-    return Object.assign({}, parsingResult);
-  } catch (e) {// do nothing.
-  }
-
-  return {
-    inferredType: {
-      type: InspectionType.UNKNOWN
-    }
-  };
-}

package/dist/esm/frameworks/react/lib/inspection/types.js

@@ -1,12 +0,0 @@
-export var InspectionType;
-
-(function (InspectionType) {
-  InspectionType["IDENTIFIER"] = "Identifier";
-  InspectionType["LITERAL"] = "Literal";
-  InspectionType["OBJECT"] = "Object";
-  InspectionType["ARRAY"] = "Array";
-  InspectionType["FUNCTION"] = "Function";
-  InspectionType["CLASS"] = "Class";
-  InspectionType["ELEMENT"] = "Element";
-  InspectionType["UNKNOWN"] = "Unknown";
-})(InspectionType || (InspectionType = {}));

package/dist/esm/frameworks/react/lib/isHtmlTag.js

@@ -1,6 +0,0 @@
-import "core-js/modules/es.array.includes.js";
-import "core-js/modules/es.string.includes.js";
-import htmlTags from 'html-tags';
-export function isHtmlTag(tagName) {
-  return htmlTags.includes(tagName.toLowerCase());
-}