@storybook/addon-docs 6.5.0-alpha.45 → 6.5.0-alpha.48

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

@@ -1,28 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.createTsPropDef = void 0;
-
-require("core-js/modules/es.symbol.js");
-
-require("core-js/modules/es.symbol.description.js");
-
-var _createType = require("./createType");
-
-var _createDefaultValue = require("./createDefaultValue");
-
-var createTsPropDef = function createTsPropDef(propName, docgenInfo) {
-  var description = docgenInfo.description,
-      required = docgenInfo.required;
-  return {
-    name: propName,
-    type: (0, _createType.createType)(docgenInfo),
-    required: required,
-    description: description,
-    defaultValue: (0, _createDefaultValue.createDefaultValue)(docgenInfo)
-  };
-};
-
-exports.createTsPropDef = createTsPropDef;

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

@@ -1,30 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.createType = createType;
-
-require("core-js/modules/es.regexp.exec.js");
-
-require("core-js/modules/es.string.replace.js");
-
-require("core-js/modules/es.function.name.js");
-
-var _utils = require("../../utils");
-
-function createType(_ref) {
-  var tsType = _ref.tsType,
-      required = _ref.required;
-
-  // A type could be null if a defaultProp has been provided without a type definition.
-  if (tsType == null) {
-    return null;
-  }
-
-  if (!required) {
-    return (0, _utils.createSummaryValue)(tsType.name.replace(' | undefined', ''));
-  }
-
-  return (0, _utils.createSummaryValue)(tsType.name);
-}

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

@@ -1,17 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.TypeSystem = void 0;
-// eslint-disable-next-line @typescript-eslint/no-empty-interface
-// export type DocgenType = DocgenPropType | DocgenFlowType | DocgenTypeScriptType;
-var TypeSystem;
-exports.TypeSystem = TypeSystem;
-
-(function (TypeSystem) {
-  TypeSystem["JAVASCRIPT"] = "JavaScript";
-  TypeSystem["FLOW"] = "Flow";
-  TypeSystem["TYPESCRIPT"] = "TypeScript";
-  TypeSystem["UNKNOWN"] = "Unknown";
-})(TypeSystem || (exports.TypeSystem = TypeSystem = {}));

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

@@ -1,16 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.isDefaultValueBlacklisted = isDefaultValueBlacklisted;
-
-require("core-js/modules/es.object.to-string.js");
-
-var BLACKLIST = ['null', 'undefined'];
-
-function isDefaultValueBlacklisted(value) {
-  return BLACKLIST.some(function (x) {
-    return x === value;
-  });
-}

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

@@ -1,34 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.getDocgenDescription = getDocgenDescription;
-exports.getDocgenSection = getDocgenSection;
-exports.hasDocgen = hasDocgen;
-exports.isValidDocgenSection = isValidDocgenSection;
-
-require("core-js/modules/es.object.keys.js");
-
-require("core-js/modules/es.symbol.js");
-
-require("core-js/modules/es.symbol.description.js");
-
-var _string = require("./string");
-
-/* eslint-disable no-underscore-dangle */
-function hasDocgen(component) {
-  return !!component.__docgenInfo;
-}
-
-function isValidDocgenSection(docgenSection) {
-  return docgenSection != null && Object.keys(docgenSection).length > 0;
-}
-
-function getDocgenSection(component, section) {
-  return hasDocgen(component) ? component.__docgenInfo[section] : null;
-}
-
-function getDocgenDescription(component) {
-  return hasDocgen(component) && (0, _string.str)(component.__docgenInfo.description);
-}

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

@@ -1,50 +0,0 @@
-"use strict";
-
-require("core-js/modules/es.object.to-string.js");
-
-require("core-js/modules/web.dom-collections.for-each.js");
-
-require("core-js/modules/es.object.keys.js");
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-
-var _defaultValue = require("./defaultValue");
-
-Object.keys(_defaultValue).forEach(function (key) {
-  if (key === "default" || key === "__esModule") return;
-  if (key in exports && exports[key] === _defaultValue[key]) return;
-  Object.defineProperty(exports, key, {
-    enumerable: true,
-    get: function get() {
-      return _defaultValue[key];
-    }
-  });
-});
-
-var _string = require("./string");
-
-Object.keys(_string).forEach(function (key) {
-  if (key === "default" || key === "__esModule") return;
-  if (key in exports && exports[key] === _string[key]) return;
-  Object.defineProperty(exports, key, {
-    enumerable: true,
-    get: function get() {
-      return _string[key];
-    }
-  });
-});
-
-var _docgenInfo = require("./docgenInfo");
-
-Object.keys(_docgenInfo).forEach(function (key) {
-  if (key === "default" || key === "__esModule") return;
-  if (key in exports && exports[key] === _docgenInfo[key]) return;
-  Object.defineProperty(exports, key, {
-    enumerable: true,
-    get: function get() {
-      return _docgenInfo[key];
-    }
-  });
-});

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

@@ -1,20 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.str = void 0;
-
-var str = function str(obj) {
-  if (!obj) {
-    return '';
-  }
-
-  if (typeof obj === 'string') {
-    return obj;
-  }
-
-  throw new Error("Description: expected string, got: ".concat(JSON.stringify(obj)));
-};
-
-exports.str = str;

package/dist/cjs/lib/index.js

@@ -1,24 +0,0 @@
-"use strict";
-
-require("core-js/modules/es.object.to-string.js");
-
-require("core-js/modules/web.dom-collections.for-each.js");
-
-require("core-js/modules/es.object.keys.js");
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-
-var _utils = require("./utils");
-
-Object.keys(_utils).forEach(function (key) {
-  if (key === "default" || key === "__esModule") return;
-  if (key in exports && exports[key] === _utils[key]) return;
-  Object.defineProperty(exports, key, {
-    enumerable: true,
-    get: function get() {
-      return _utils[key];
-    }
-  });
-});

package/dist/cjs/lib/jsdocParser.js

@@ -1,229 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.parseJsDoc = void 0;
-
-require("core-js/modules/es.array.includes.js");
-
-require("core-js/modules/es.string.includes.js");
-
-require("core-js/modules/es.symbol.js");
-
-require("core-js/modules/es.symbol.description.js");
-
-require("core-js/modules/es.function.name.js");
-
-require("core-js/modules/es.regexp.exec.js");
-
-require("core-js/modules/es.string.replace.js");
-
-require("core-js/modules/es.array.map.js");
-
-require("core-js/modules/es.array.concat.js");
-
-require("core-js/modules/es.array.join.js");
-
-var _doctrine = _interopRequireDefault(require("doctrine"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-function containsJsDoc(value) {
-  return value != null && value.includes('@');
-}
-
-function parse(content, tags) {
-  var ast;
-
-  try {
-    ast = _doctrine.default.parse(content, {
-      tags: tags,
-      sloppy: true
-    });
-  } catch (e) {
-    // eslint-disable-next-line no-console
-    console.error(e);
-    throw new Error('Cannot parse JSDoc tags.');
-  }
-
-  return ast;
-}
-
-var DEFAULT_OPTIONS = {
-  tags: ['param', 'arg', 'argument', 'returns', 'ignore']
-};
-
-var parseJsDoc = function parseJsDoc(value) {
-  var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : DEFAULT_OPTIONS;
-
-  if (!containsJsDoc(value)) {
-    return {
-      includesJsDoc: false,
-      ignore: false
-    };
-  }
-
-  var jsDocAst = parse(value, options.tags);
-  var extractedTags = extractJsDocTags(jsDocAst);
-
-  if (extractedTags.ignore) {
-    // There is no point in doing other stuff since this prop will not be rendered.
-    return {
-      includesJsDoc: true,
-      ignore: true
-    };
-  }
-
-  return {
-    includesJsDoc: true,
-    ignore: false,
-    // Always use the parsed description to ensure JSDoc is removed from the description.
-    description: jsDocAst.description,
-    extractedTags: extractedTags
-  };
-};
-
-exports.parseJsDoc = parseJsDoc;
-
-function extractJsDocTags(ast) {
-  var extractedTags = {
-    params: null,
-    returns: null,
-    ignore: false
-  };
-
-  for (var i = 0; i < ast.tags.length; i += 1) {
-    var tag = ast.tags[i];
-
-    if (tag.title === 'ignore') {
-      extractedTags.ignore = true; // Once we reach an @ignore tag, there is no point in parsing the other tags since we will not render the prop.
-
-      break;
-    } else {
-      switch (tag.title) {
-        // arg & argument are aliases for param.
-        case 'param':
-        case 'arg':
-        case 'argument':
-          {
-            var paramTag = extractParam(tag);
-
-            if (paramTag != null) {
-              if (extractedTags.params == null) {
-                extractedTags.params = [];
-              }
-
-              extractedTags.params.push(paramTag);
-            }
-
-            break;
-          }
-
-        case 'returns':
-          {
-            var returnsTag = extractReturns(tag);
-
-            if (returnsTag != null) {
-              extractedTags.returns = returnsTag;
-            }
-
-            break;
-          }
-
-        default:
-          break;
-      }
-    }
-  }
-
-  return extractedTags;
-}
-
-function extractParam(tag) {
-  var paramName = tag.name; // When the @param doesn't have a name but have a type and a description, "null-null" is returned.
-
-  if (paramName != null && paramName !== 'null-null') {
-    return {
-      name: tag.name,
-      type: tag.type,
-      description: tag.description,
-      getPrettyName: function getPrettyName() {
-        if (paramName.includes('null')) {
-          // There is a few cases in which the returned param name contains "null".
-          // - @param {SyntheticEvent} event- Original SyntheticEvent
-          // - @param {SyntheticEvent} event.\n@returns {string}
-          return paramName.replace('-null', '').replace('.null', '');
-        }
-
-        return tag.name;
-      },
-      getTypeName: function getTypeName() {
-        return tag.type != null ? extractTypeName(tag.type) : null;
-      }
-    };
-  }
-
-  return null;
-}
-
-function extractReturns(tag) {
-  if (tag.type != null) {
-    return {
-      type: tag.type,
-      description: tag.description,
-      getTypeName: function getTypeName() {
-        return extractTypeName(tag.type);
-      }
-    };
-  }
-
-  return null;
-}
-
-function extractTypeName(type) {
-  if (type.type === 'NameExpression') {
-    return type.name;
-  }
-
-  if (type.type === 'RecordType') {
-    var recordFields = type.fields.map(function (field) {
-      if (field.value != null) {
-        var valueTypeName = extractTypeName(field.value);
-        return "".concat(field.key, ": ").concat(valueTypeName);
-      }
-
-      return field.key;
-    });
-    return "({".concat(recordFields.join(', '), "})");
-  }
-
-  if (type.type === 'UnionType') {
-    var unionElements = type.elements.map(extractTypeName);
-    return "(".concat(unionElements.join('|'), ")");
-  } // Only support untyped array: []. Might add more support later if required.
-
-
-  if (type.type === 'ArrayType') {
-    return '[]';
-  }
-
-  if (type.type === 'TypeApplication') {
-    if (type.expression != null) {
-      if (type.expression.name === 'Array') {
-        var arrayType = extractTypeName(type.applications[0]);
-        return "".concat(arrayType, "[]");
-      }
-    }
-  }
-
-  if (type.type === 'NullableType' || type.type === 'NonNullableType' || type.type === 'OptionalType') {
-    return extractTypeName(type.expression);
-  }
-
-  if (type.type === 'AllLiteral') {
-    return 'any';
-  }
-
-  return null;
-}

package/dist/cjs/lib/utils.js

@@ -1,46 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.MAX_TYPE_SUMMARY_LENGTH = exports.MAX_DEFAULT_VALUE_SUMMARY_LENGTH = void 0;
-exports.createSummaryValue = createSummaryValue;
-exports.isTooLongForDefaultValueSummary = isTooLongForDefaultValueSummary;
-exports.isTooLongForTypeSummary = isTooLongForTypeSummary;
-exports.normalizeNewlines = void 0;
-
-require("core-js/modules/es.regexp.exec.js");
-
-require("core-js/modules/es.string.replace.js");
-
-var MAX_TYPE_SUMMARY_LENGTH = 90;
-exports.MAX_TYPE_SUMMARY_LENGTH = MAX_TYPE_SUMMARY_LENGTH;
-var MAX_DEFAULT_VALUE_SUMMARY_LENGTH = 50;
-exports.MAX_DEFAULT_VALUE_SUMMARY_LENGTH = MAX_DEFAULT_VALUE_SUMMARY_LENGTH;
-
-function isTooLongForTypeSummary(value) {
-  return value.length > MAX_TYPE_SUMMARY_LENGTH;
-}
-
-function isTooLongForDefaultValueSummary(value) {
-  return value.length > MAX_DEFAULT_VALUE_SUMMARY_LENGTH;
-}
-
-function createSummaryValue(summary, detail) {
-  if (summary === detail) {
-    return {
-      summary: summary
-    };
-  }
-
-  return {
-    summary: summary,
-    detail: detail
-  };
-}
-
-var normalizeNewlines = function normalizeNewlines(string) {
-  return string.replace(/\\r\\n/g, '\\n');
-};
-
-exports.normalizeNewlines = normalizeNewlines;