Socket
Socket
Sign inDemoInstall

@storybook/docs-tools

Package Overview
Dependencies
Maintainers
29
Versions
861
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@storybook/docs-tools - npm Package Compare versions

Comparing version 6.5.7 to 7.0.0-alpha.0

dist/types/argTypes/convert/flow/convert.d.ts

40

dist/esm/argTypes/convert/flow/convert.js

@@ -1,19 +0,7 @@

import "core-js/modules/es.function.name.js";
import "core-js/modules/es.regexp.exec.js";
import "core-js/modules/es.string.replace.js";
import "core-js/modules/es.object.to-string.js";
import "core-js/modules/web.dom-collections.for-each.js";
import "core-js/modules/es.object.assign.js";
import "core-js/modules/es.array.map.js";
/* eslint-disable no-case-declarations */
var isLiteral = function isLiteral(type) {
return type.name === 'literal';
};
const isLiteral = type => type.name === 'literal';
var toEnumOption = function toEnumOption(element) {
return element.value.replace(/['|"]/g, '');
};
const toEnumOption = element => element.value.replace(/['|"]/g, '');
var convertSig = function convertSig(type) {
const convertSig = type => {
switch (type.type) {

@@ -26,4 +14,4 @@ case 'function':

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

@@ -37,10 +25,12 @@ });

default:
throw new Error("Unknown: ".concat(type));
throw new Error(`Unknown: ${type}`);
}
};
export var convert = function convert(type) {
var name = type.name,
raw = type.raw;
var base = {};
export const convert = type => {
const {
name,
raw
} = type;
const base = {};
if (typeof raw !== 'undefined') base.raw = raw;

@@ -61,3 +51,3 @@

return Object.assign({}, base, {
name: name
name
});

@@ -86,3 +76,3 @@ }

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

@@ -93,3 +83,3 @@ });

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

@@ -96,0 +86,0 @@ });

import { convert as tsConvert } from './typescript';
import { convert as flowConvert } from './flow';
import { convert as propTypesConvert } from './proptypes';
export var convert = function convert(docgenInfo) {
var type = docgenInfo.type,
tsType = docgenInfo.tsType,
flowType = docgenInfo.flowType;
export const convert = docgenInfo => {
const {
type,
tsType,
flowType
} = docgenInfo;
if (type != null) return propTypesConvert(type);

@@ -9,0 +11,0 @@ if (tsType != null) return tsConvert(tsType);

@@ -1,20 +0,13 @@

import "core-js/modules/es.function.name.js";
import "core-js/modules/es.array.map.js";
import "core-js/modules/es.number.is-nan.js";
import "core-js/modules/es.number.constructor.js";
import "core-js/modules/es.object.assign.js";
import "core-js/modules/es.regexp.exec.js";
import "core-js/modules/es.string.split.js";
import "core-js/modules/es.array.concat.js";
/* eslint-disable no-case-declarations */
import mapValues from 'lodash/mapValues';
import { includesQuotes, trimQuotes } from '../utils';
var SIGNATURE_REGEXP = /^\(.*\) => /;
export var convert = function convert(type) {
var name = type.name,
raw = type.raw,
computed = type.computed,
value = type.value;
var base = {};
const SIGNATURE_REGEXP = /^\(.*\) => /;
export const convert = type => {
const {
name,
raw,
computed,
value
} = type;
const base = {};
if (typeof raw !== 'undefined') base.raw = raw;

@@ -25,10 +18,9 @@

{
var _values = computed ? value : value.map(function (v) {
var trimmedValue = trimQuotes(v.value);
const values = computed ? value : value.map(v => {
const trimmedValue = trimQuotes(v.value);
return includesQuotes(v.value) || Number.isNaN(Number(trimmedValue)) ? trimmedValue : Number(trimmedValue);
});
return Object.assign({}, base, {
name: name,
value: _values
name,
value: values
});

@@ -41,3 +33,3 @@ }

return Object.assign({}, base, {
name: name
name
});

@@ -65,3 +57,3 @@

return Object.assign({}, base, {
name: name
name
});

@@ -71,3 +63,3 @@

return Object.assign({}, base, {
name: name,
name,
value: convert(value)

@@ -78,5 +70,3 @@ });

case 'exact':
var values = mapValues(value, function (field) {
return convert(field);
});
const values = mapValues(value, field => convert(field));
return Object.assign({}, base, {

@@ -90,5 +80,3 @@ name: 'object',

name: 'union',
value: value.map(function (v) {
return convert(v);
})
value: value.map(v => convert(v))
});

@@ -101,3 +89,3 @@

{
if ((name === null || name === void 0 ? void 0 : name.indexOf('|')) > 0) {
if (name?.indexOf('|') > 0) {
// react-docgen-typescript-plugin doesn't always produce enum-like unions

@@ -107,5 +95,3 @@ // (like if a user has turned off shouldExtractValuesFromUnion) so here we

try {
var literalValues = name.split('|').map(function (v) {
return JSON.parse(v);
});
const literalValues = name.split('|').map(v => JSON.parse(v));
return Object.assign({}, base, {

@@ -119,4 +105,4 @@ name: 'enum',

var otherVal = value ? "".concat(name, "(").concat(value, ")") : name;
var otherName = SIGNATURE_REGEXP.test(name) ? 'function' : 'other';
const otherVal = value ? `${name}(${value})` : name;
const otherName = SIGNATURE_REGEXP.test(name) ? 'function' : 'other';
return Object.assign({}, base, {

@@ -123,0 +109,0 @@ name: otherName,

@@ -1,9 +0,3 @@

import "core-js/modules/es.object.to-string.js";
import "core-js/modules/web.dom-collections.for-each.js";
import "core-js/modules/es.function.name.js";
import "core-js/modules/es.object.assign.js";
import "core-js/modules/es.array.map.js";
/* eslint-disable no-case-declarations */
var convertSig = function convertSig(type) {
const convertSig = type => {
switch (type.type) {

@@ -16,4 +10,4 @@ case 'function':

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

@@ -27,10 +21,12 @@ });

default:
throw new Error("Unknown: ".concat(type));
throw new Error(`Unknown: ${type}`);
}
};
export var convert = function convert(type) {
var name = type.name,
raw = type.raw;
var base = {};
export const convert = type => {
const {
name,
raw
} = type;
const base = {};
if (typeof raw !== 'undefined') base.raw = raw;

@@ -45,3 +41,3 @@

return Object.assign({}, base, {
name: name
name
});

@@ -64,3 +60,3 @@ }

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

@@ -67,0 +63,0 @@ });

@@ -1,9 +0,3 @@

import "core-js/modules/es.regexp.exec.js";
import "core-js/modules/es.string.replace.js";
var QUOTE_REGEX = /^['"]|['"]$/g;
export var trimQuotes = function trimQuotes(str) {
return str.replace(QUOTE_REGEX, '');
};
export var includesQuotes = function includesQuotes(str) {
return QUOTE_REGEX.test(str);
};
const QUOTE_REGEX = /^['"]|['"]$/g;
export const trimQuotes = str => str.replace(QUOTE_REGEX, '');
export const includesQuotes = str => QUOTE_REGEX.test(str);

@@ -1,6 +0,1 @@

import "core-js/modules/es.function.name.js";
import "core-js/modules/es.object.to-string.js";
import "core-js/modules/es.symbol.js";
import "core-js/modules/es.symbol.description.js";
import "core-js/modules/es.array.map.js";
import { TypeSystem } from './types';

@@ -20,4 +15,6 @@ import { createSummaryValue } from '../utils';

function isReactDocgenTypescript(defaultValue) {
var computed = defaultValue.computed,
func = defaultValue.func;
const {
computed,
func
} = defaultValue;
return typeof computed === 'undefined' && typeof func === 'undefined';

@@ -36,6 +33,5 @@ }

if (type.name === 'enum') {
return Array.isArray(type.value) && type.value.every(function (_ref) {
var tv = _ref.value;
return typeof tv === 'string' && tv[0] === '"' && tv[tv.length - 1] === '"';
});
return Array.isArray(type.value) && type.value.every(({
value: tv
}) => typeof tv === 'string' && tv[0] === '"' && tv[tv.length - 1] === '"');
}

@@ -48,3 +44,5 @@

if (defaultValue != null) {
var value = defaultValue.value;
const {
value
} = defaultValue;

@@ -66,10 +64,12 @@ if (!isDefaultValueBlacklisted(value)) {

function createBasicPropDef(name, type, docgenInfo) {
var description = docgenInfo.description,
required = docgenInfo.required,
defaultValue = docgenInfo.defaultValue;
const {
description,
required,
defaultValue
} = docgenInfo;
return {
name: name,
name,
type: createType(type),
required: required,
description: description,
required,
description,
defaultValue: createDefaultValue(defaultValue, type)

@@ -81,4 +81,6 @@ };

if (jsDocParsingResult.includesJsDoc) {
var description = jsDocParsingResult.description,
extractedTags = jsDocParsingResult.extractedTags;
const {
description,
extractedTags
} = jsDocParsingResult;

@@ -90,4 +92,4 @@ if (description != null) {

var hasParams = extractedTags.params != null;
var hasReturns = extractedTags.returns != null && extractedTags.returns.type != null;
const hasParams = extractedTags.params != null;
const hasReturns = extractedTags.returns != null && extractedTags.returns.type != null;

@@ -97,8 +99,6 @@ if (hasParams || hasReturns) {

propDef.jsDocTags = {
params: hasParams && extractedTags.params.map(function (x) {
return {
name: x.getPrettyName(),
description: x.description
};
}),
params: hasParams && extractedTags.params.map(x => ({
name: x.getPrettyName(),
description: x.description
})),
returns: hasReturns && {

@@ -114,19 +114,19 @@ description: extractedTags.returns.description

export var javaScriptFactory = function javaScriptFactory(propName, docgenInfo, jsDocParsingResult) {
var propDef = createBasicPropDef(propName, docgenInfo.type, docgenInfo);
export const javaScriptFactory = (propName, docgenInfo, jsDocParsingResult) => {
const propDef = createBasicPropDef(propName, docgenInfo.type, docgenInfo);
propDef.sbType = convert(docgenInfo);
return applyJsDocResult(propDef, jsDocParsingResult);
};
export var tsFactory = function tsFactory(propName, docgenInfo, jsDocParsingResult) {
var propDef = createTsPropDef(propName, docgenInfo);
export const tsFactory = (propName, docgenInfo, jsDocParsingResult) => {
const propDef = createTsPropDef(propName, docgenInfo);
propDef.sbType = convert(docgenInfo);
return applyJsDocResult(propDef, jsDocParsingResult);
};
export var flowFactory = function flowFactory(propName, docgenInfo, jsDocParsingResult) {
var propDef = createFlowPropDef(propName, docgenInfo);
export const flowFactory = (propName, docgenInfo, jsDocParsingResult) => {
const propDef = createFlowPropDef(propName, docgenInfo);
propDef.sbType = convert(docgenInfo);
return applyJsDocResult(propDef, jsDocParsingResult);
};
export var unknownFactory = function unknownFactory(propName, docgenInfo, jsDocParsingResult) {
var propDef = createBasicPropDef(propName, {
export const unknownFactory = (propName, docgenInfo, jsDocParsingResult) => {
const propDef = createBasicPropDef(propName, {
name: 'unknown'

@@ -136,3 +136,3 @@ }, docgenInfo);

};
export var getPropDefFactory = function getPropDefFactory(typeSystem) {
export const getPropDefFactory = typeSystem => {
switch (typeSystem) {

@@ -139,0 +139,0 @@ case TypeSystem.JAVASCRIPT:

@@ -1,9 +0,1 @@

import "core-js/modules/es.array.map.js";
import "core-js/modules/es.object.assign.js";
import "core-js/modules/es.function.name.js";
import "core-js/modules/es.object.keys.js";
import "core-js/modules/es.array.filter.js";
import "core-js/modules/es.object.to-string.js";
import "core-js/modules/es.symbol.js";
import "core-js/modules/es.symbol.description.js";
import { parseJsDoc } from '../jsdocParser';

@@ -14,3 +6,3 @@ import { TypeSystem } from './types';

var getTypeSystem = function getTypeSystem(docgenInfo) {
const getTypeSystem = docgenInfo => {
if (docgenInfo.type != null) {

@@ -31,11 +23,9 @@ return TypeSystem.JAVASCRIPT;

export var extractComponentSectionArray = function extractComponentSectionArray(docgenSection) {
var typeSystem = getTypeSystem(docgenSection[0]);
var createPropDef = getPropDefFactory(typeSystem);
return docgenSection.map(function (item) {
var _item$type;
export const extractComponentSectionArray = docgenSection => {
const typeSystem = getTypeSystem(docgenSection[0]);
const createPropDef = getPropDefFactory(typeSystem);
return docgenSection.map(item => {
let sanitizedItem = item;
var sanitizedItem = item;
if ((_item$type = item.type) !== null && _item$type !== void 0 && _item$type.elements) {
if (item.type?.elements) {
sanitizedItem = Object.assign({}, item, {

@@ -51,13 +41,13 @@ type: Object.assign({}, item.type, {

};
export var extractComponentSectionObject = function extractComponentSectionObject(docgenSection) {
var docgenPropsKeys = Object.keys(docgenSection);
var typeSystem = getTypeSystem(docgenSection[docgenPropsKeys[0]]);
var createPropDef = getPropDefFactory(typeSystem);
return docgenPropsKeys.map(function (propName) {
var docgenInfo = docgenSection[propName];
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 var extractComponentProps = function extractComponentProps(component, section) {
var docgenSection = getDocgenSection(component, section);
export const extractComponentProps = (component, section) => {
const docgenSection = getDocgenSection(component, section);

@@ -73,12 +63,12 @@ if (!isValidDocgenSection(docgenSection)) {

function extractProp(propName, docgenInfo, typeSystem, createPropDef) {
var jsDocParsingResult = parseJsDoc(docgenInfo.description);
var isIgnored = jsDocParsingResult.includesJsDoc && jsDocParsingResult.ignore;
const jsDocParsingResult = parseJsDoc(docgenInfo.description);
const isIgnored = jsDocParsingResult.includesJsDoc && jsDocParsingResult.ignore;
if (!isIgnored) {
var propDef = createPropDef(propName, docgenInfo, jsDocParsingResult);
const propDef = createPropDef(propName, docgenInfo, jsDocParsingResult);
return {
propDef: propDef,
propDef,
jsDocTags: jsDocParsingResult.extractedTags,
docgenInfo: docgenInfo,
typeSystem: typeSystem
docgenInfo,
typeSystem
};

@@ -85,0 +75,0 @@ }

@@ -1,2 +0,1 @@

import "core-js/modules/es.function.name.js";
import { createSummaryValue, isTooLongForDefaultValueSummary } from '../../utils';

@@ -6,3 +5,5 @@ import { isDefaultValueBlacklisted } from '../utils/defaultValue';

if (defaultValue != null) {
var value = defaultValue.value;
const {
value
} = defaultValue;

@@ -9,0 +10,0 @@ if (!isDefaultValueBlacklisted(value)) {

@@ -1,17 +0,17 @@

import "core-js/modules/es.symbol.js";
import "core-js/modules/es.symbol.description.js";
import { createType } from './createType';
import { createDefaultValue } from './createDefaultValue';
export var createFlowPropDef = function createFlowPropDef(propName, docgenInfo) {
var flowType = docgenInfo.flowType,
description = docgenInfo.description,
required = docgenInfo.required,
defaultValue = docgenInfo.defaultValue;
export const createFlowPropDef = (propName, docgenInfo) => {
const {
flowType,
description,
required,
defaultValue
} = docgenInfo;
return {
name: propName,
type: createType(flowType),
required: required,
description: description,
required,
description,
defaultValue: createDefaultValue(defaultValue, flowType)
};
};

@@ -1,6 +0,1 @@

import "core-js/modules/es.function.name.js";
import "core-js/modules/es.array.join.js";
import "core-js/modules/es.array.map.js";
import "core-js/modules/es.regexp.exec.js";
import "core-js/modules/es.string.replace.js";
import { createSummaryValue, isTooLongForTypeSummary } from '../../utils';

@@ -14,8 +9,8 @@ var FlowTypesType;

function generateUnionElement(_ref) {
var name = _ref.name,
value = _ref.value,
elements = _ref.elements,
raw = _ref.raw;
function generateUnionElement({
name,
value,
elements,
raw
}) {
if (value != null) {

@@ -36,7 +31,7 @@ return value;

function generateUnion(_ref2) {
var name = _ref2.name,
raw = _ref2.raw,
elements = _ref2.elements;
function generateUnion({
name,
raw,
elements
}) {
if (elements != null) {

@@ -54,6 +49,6 @@ return createSummaryValue(elements.map(generateUnionElement).join(' | '));

function generateFuncSignature(_ref3) {
var type = _ref3.type,
raw = _ref3.raw;
function generateFuncSignature({
type,
raw
}) {
if (raw != null) {

@@ -66,6 +61,6 @@ return createSummaryValue(raw);

function generateObjectSignature(_ref4) {
var type = _ref4.type,
raw = _ref4.raw;
function generateObjectSignature({
type,
raw
}) {
if (raw != null) {

@@ -79,10 +74,12 @@ return !isTooLongForTypeSummary(raw) ? createSummaryValue(raw) : createSummaryValue(type, raw);

function generateSignature(flowType) {
var type = flowType.type;
const {
type
} = flowType;
return type === 'object' ? generateObjectSignature(flowType) : generateFuncSignature(flowType);
}
function generateDefault(_ref5) {
var name = _ref5.name,
raw = _ref5.raw;
function generateDefault({
name,
raw
}) {
if (raw != null) {

@@ -89,0 +86,0 @@ return !isTooLongForTypeSummary(raw) ? createSummaryValue(raw) : createSummaryValue(name, raw);

// eslint-disable-next-line @typescript-eslint/no-empty-interface
// export type DocgenType = DocgenPropType | DocgenFlowType | DocgenTypeScriptType;
export var TypeSystem;
export let TypeSystem;

@@ -5,0 +5,0 @@ (function (TypeSystem) {

import { createSummaryValue } from '../../utils';
import { isDefaultValueBlacklisted } from '../utils/defaultValue';
export function createDefaultValue(_ref) {
var defaultValue = _ref.defaultValue;
export function createDefaultValue({
defaultValue
}) {
if (defaultValue != null) {
var value = defaultValue.value;
const {
value
} = defaultValue;

@@ -9,0 +11,0 @@ if (!isDefaultValueBlacklisted(value)) {

@@ -1,15 +0,15 @@

import "core-js/modules/es.symbol.js";
import "core-js/modules/es.symbol.description.js";
import { createType } from './createType';
import { createDefaultValue } from './createDefaultValue';
export var createTsPropDef = function createTsPropDef(propName, docgenInfo) {
var description = docgenInfo.description,
required = docgenInfo.required;
export const createTsPropDef = (propName, docgenInfo) => {
const {
description,
required
} = docgenInfo;
return {
name: propName,
type: createType(docgenInfo),
required: required,
description: description,
required,
description,
defaultValue: createDefaultValue(docgenInfo)
};
};

@@ -1,9 +0,6 @@

import "core-js/modules/es.regexp.exec.js";
import "core-js/modules/es.string.replace.js";
import "core-js/modules/es.function.name.js";
import { createSummaryValue } from '../../utils';
export function createType(_ref) {
var tsType = _ref.tsType,
required = _ref.required;
export function createType({
tsType,
required
}) {
// A type could be null if a defaultProp has been provided without a type definition.

@@ -10,0 +7,0 @@ if (tsType == null) {

@@ -1,7 +0,4 @@

import "core-js/modules/es.object.to-string.js";
var BLACKLIST = ['null', 'undefined'];
const BLACKLIST = ['null', 'undefined'];
export function isDefaultValueBlacklisted(value) {
return BLACKLIST.some(function (x) {
return x === value;
});
return BLACKLIST.some(x => x === value);
}

@@ -1,5 +0,1 @@

import "core-js/modules/es.object.keys.js";
import "core-js/modules/es.symbol.js";
import "core-js/modules/es.symbol.description.js";
/* eslint-disable no-underscore-dangle */

@@ -6,0 +2,0 @@ import { str } from './string';

@@ -1,2 +0,2 @@

export var str = function str(obj) {
export const str = obj => {
if (!obj) {

@@ -10,3 +10,3 @@ return '';

throw new Error("Description: expected string, got: ".concat(JSON.stringify(obj)));
throw new Error(`Description: expected string, got: ${JSON.stringify(obj)}`);
};
import { combineParameters } from '@storybook/store';
export var enhanceArgTypes = function enhanceArgTypes(context) {
var component = context.component,
userArgTypes = context.argTypes,
_context$parameters$d = context.parameters.docs,
docs = _context$parameters$d === void 0 ? {} : _context$parameters$d;
var extractArgTypes = docs.extractArgTypes;
var extractedArgTypes = extractArgTypes && component ? extractArgTypes(component) : {};
var withExtractedTypes = extractedArgTypes ? combineParameters(extractedArgTypes, userArgTypes) : userArgTypes;
export const enhanceArgTypes = context => {
const {
component,
argTypes: userArgTypes,
parameters: {
docs = {}
}
} = context;
const {
extractArgTypes
} = docs;
const extractedArgTypes = extractArgTypes && component ? extractArgTypes(component) : {};
const withExtractedTypes = extractedArgTypes ? combineParameters(extractedArgTypes, userArgTypes) : userArgTypes;
return withExtractedTypes;
};

@@ -1,11 +0,1 @@

import "core-js/modules/es.array.includes.js";
import "core-js/modules/es.string.includes.js";
import "core-js/modules/es.symbol.js";
import "core-js/modules/es.symbol.description.js";
import "core-js/modules/es.function.name.js";
import "core-js/modules/es.regexp.exec.js";
import "core-js/modules/es.string.replace.js";
import "core-js/modules/es.array.map.js";
import "core-js/modules/es.array.concat.js";
import "core-js/modules/es.array.join.js";
import doctrine from 'doctrine';

@@ -18,7 +8,7 @@

function parse(content, tags) {
var ast;
let ast;
try {
ast = doctrine.parse(content, {
tags: tags,
tags,
sloppy: true

@@ -35,8 +25,6 @@ });

var DEFAULT_OPTIONS = {
const DEFAULT_OPTIONS = {
tags: ['param', 'arg', 'argument', 'returns', 'ignore']
};
export var parseJsDoc = function parseJsDoc(value) {
var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : DEFAULT_OPTIONS;
export const parseJsDoc = (value, options = DEFAULT_OPTIONS) => {
if (!containsJsDoc(value)) {

@@ -49,4 +37,4 @@ return {

var jsDocAst = parse(value, options.tags);
var extractedTags = extractJsDocTags(jsDocAst);
const jsDocAst = parse(value, options.tags);
const extractedTags = extractJsDocTags(jsDocAst);

@@ -66,3 +54,3 @@ if (extractedTags.ignore) {

description: jsDocAst.description,
extractedTags: extractedTags
extractedTags
};

@@ -72,3 +60,3 @@ };

function extractJsDocTags(ast) {
var extractedTags = {
const extractedTags = {
params: null,

@@ -79,4 +67,4 @@ returns: null,

for (var i = 0; i < ast.tags.length; i += 1) {
var tag = ast.tags[i];
for (let i = 0; i < ast.tags.length; i += 1) {
const tag = ast.tags[i];

@@ -94,3 +82,3 @@ if (tag.title === 'ignore') {

{
var paramTag = extractParam(tag);
const paramTag = extractParam(tag);

@@ -110,3 +98,3 @@ if (paramTag != null) {

{
var returnsTag = extractReturns(tag);
const returnsTag = extractReturns(tag);

@@ -130,3 +118,3 @@ if (returnsTag != null) {

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.
const paramName = tag.name; // When the @param doesn't have a name but have a type and a description, "null-null" is returned.

@@ -138,3 +126,3 @@ if (paramName != null && paramName !== 'null-null') {

description: tag.description,
getPrettyName: function getPrettyName() {
getPrettyName: () => {
if (paramName.includes('null')) {

@@ -149,3 +137,3 @@ // There is a few cases in which the returned param name contains "null".

},
getTypeName: function getTypeName() {
getTypeName: () => {
return tag.type != null ? extractTypeName(tag.type) : null;

@@ -164,3 +152,3 @@ }

description: tag.description,
getTypeName: function getTypeName() {
getTypeName: () => {
return extractTypeName(tag.type);

@@ -180,6 +168,6 @@ }

if (type.type === 'RecordType') {
var recordFields = type.fields.map(function (field) {
const recordFields = type.fields.map(field => {
if (field.value != null) {
var valueTypeName = extractTypeName(field.value);
return "".concat(field.key, ": ").concat(valueTypeName);
const valueTypeName = extractTypeName(field.value);
return `${field.key}: ${valueTypeName}`;
}

@@ -189,8 +177,8 @@

});
return "({".concat(recordFields.join(', '), "})");
return `({${recordFields.join(', ')}})`;
}
if (type.type === 'UnionType') {
var unionElements = type.elements.map(extractTypeName);
return "(".concat(unionElements.join('|'), ")");
const unionElements = type.elements.map(extractTypeName);
return `(${unionElements.join('|')})`;
} // Only support untyped array: []. Might add more support later if required.

@@ -206,4 +194,4 @@

if (type.expression.name === 'Array') {
var arrayType = extractTypeName(type.applications[0]);
return "".concat(arrayType, "[]");
const arrayType = extractTypeName(type.applications[0]);
return `${arrayType}[]`;
}

@@ -210,0 +198,0 @@ }

@@ -1,5 +0,3 @@

import "core-js/modules/es.regexp.exec.js";
import "core-js/modules/es.string.replace.js";
export var MAX_TYPE_SUMMARY_LENGTH = 90;
export var MAX_DEFAULT_VALUE_SUMMARY_LENGTH = 50;
export const MAX_TYPE_SUMMARY_LENGTH = 90;
export const MAX_DEFAULT_VALUE_SUMMARY_LENGTH = 50;
export function isTooLongForTypeSummary(value) {

@@ -14,3 +12,3 @@ return value.length > MAX_TYPE_SUMMARY_LENGTH;

return {
summary: summary
summary
};

@@ -20,8 +18,6 @@ }

return {
summary: summary,
detail: detail
summary,
detail
};
}
export var normalizeNewlines = function normalizeNewlines(string) {
return string.replace(/\\r\\n/g, '\\n');
};
export const normalizeNewlines = string => string.replace(/\\r\\n/g, '\\n');

@@ -1,12 +0,3 @@

import "core-js/modules/es.object.to-string.js";
import "core-js/modules/es.regexp.exec.js";
import "core-js/modules/es.function.name.js";
// `addons/x` is for the monorepo, `addon-x` is for normal usage
var packageRe = /(addons\/|addon-)(docs|controls)/;
export var hasDocsOrControls = function hasDocsOrControls(options) {
var _options$presetsList;
return (_options$presetsList = options.presetsList) === null || _options$presetsList === void 0 ? void 0 : _options$presetsList.some(function (preset) {
return packageRe.test(preset.name);
});
};
const packageRe = /(addons\/|addon-)(docs|controls)/;
export const hasDocsOrControls = options => options.presetsList?.some(preset => packageRe.test(preset.name));

@@ -1,6 +0,6 @@

export var ADDON_ID = 'storybook/docs';
export var PANEL_ID = "".concat(ADDON_ID, "/panel");
export var PARAM_KEY = "docs";
export var SNIPPET_RENDERED = "".concat(ADDON_ID, "/snippet-rendered");
export var SourceType;
export const ADDON_ID = 'storybook/docs';
export const PANEL_ID = `${ADDON_ID}/panel`;
export const PARAM_KEY = `docs`;
export const SNIPPET_RENDERED = `${ADDON_ID}/snippet-rendered`;
export let SourceType;

@@ -7,0 +7,0 @@ (function (SourceType) {

{
"name": "@storybook/docs-tools",
"version": "6.5.7",
"version": "7.0.0-alpha.0",
"description": "Shared utility functions for frameworks to implement docs",

@@ -25,10 +25,3 @@ "keywords": [

"module": "dist/esm/index.js",
"types": "dist/ts3.9/index.d.ts",
"typesVersions": {
"<3.8": {
"dist/ts3.9/*": [
"dist/ts3.4/*"
]
}
},
"types": "dist/types/index.d.ts",
"files": [

@@ -46,3 +39,3 @@ "dist/**/*",

"@storybook/csf": "0.0.2--canary.4566f4d.1",
"@storybook/store": "6.5.7",
"@storybook/store": "7.0.0-alpha.0",
"core-js": "^3.8.2",

@@ -60,4 +53,3 @@ "doctrine": "^3.0.0",

},
"gitHead": "7e19d3e734efa14e7cffba146295ca0d3467a8c6",
"sbmodern": "dist/modern/index.js"
"gitHead": "c82d897ea765da8cf4fbbcc2af1f28c808a93e23"
}
SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc