@storybook/addon-svelte-csf/dist/compiler/post-transform/story/insert-description.js

Allows to write stories in Svelte syntax

import dedent from 'dedent';
import { findASTPropertyIndex, findPropertyDescriptionIndex, findPropertyDocsIndex, findPropertyParametersIndex, getParametersPropertyValue, getDocsPropertyValue, getDescriptionPropertyValue, } from '../shared/parameters.js';
import { createASTObjectExpression, createASTProperty } from '../../../parser/ast.js';
import { getStoryPropsObjectExpression } from '../../../parser/extract/compiled/story.js';
/**
 * Attempt to insert HTML comment above the `<Story />` component as a description **into the compiled code**.
 * If the user did explicitly set `parameters.docs.description.story` and the HTML comment exists, then it will log a warning.
 */
export function insertStoryHTMLCommentAsDescription(params) {
    const { nodes, filename } = params;
    const { svelte, compiled } = nodes;
    const { comment, component } = svelte;
    if (!comment) {
        return;
    }
    const storyPropsObjectExpression = getStoryPropsObjectExpression({
        node: compiled,
        filename,
    });
    if (findPropertyParametersIndex({
        filename,
        component,
        node: storyPropsObjectExpression,
    }) === -1) {
        storyPropsObjectExpression.properties.push(createASTProperty('parameters', createASTObjectExpression()));
    }
    if (findPropertyDocsIndex({
        filename,
        component,
        node: storyPropsObjectExpression,
    }) === -1) {
        getParametersPropertyValue({
            filename,
            component,
            node: storyPropsObjectExpression,
        }).properties.push(createASTProperty('docs', createASTObjectExpression()));
    }
    if (findPropertyDescriptionIndex({
        filename,
        component,
        node: storyPropsObjectExpression,
    }) === -1) {
        getDocsPropertyValue({
            filename,
            component,
            node: storyPropsObjectExpression,
        }).properties.push(createASTProperty('description', createASTObjectExpression()));
    }
    if (findASTPropertyIndex({
        filename,
        component,
        name: 'story',
        node: getDescriptionPropertyValue({
            filename,
            component,
            node: storyPropsObjectExpression,
        }),
    }) !== -1) {
        const propertyName = storyPropsObjectExpression.properties.find((p) => p.type === 'Property' && p.key.type === 'Literal' && p.key.value === 'name');
        const name = propertyName.value.value;
        console.warn(dedent `
        Svelte CSF:
          Description was already set in parameters.docs.description.story
          in the story: <Story name="${name}" />.
          ignoring JSDoc comment above.
          in:
          ${filename}`);
        return;
    }
    getDescriptionPropertyValue({
        filename,
        component,
        node: storyPropsObjectExpression,
    }).properties.push(createASTProperty('story', {
        type: 'Literal',
        value: dedent(comment.data),
    }));
    if (compiled.type === 'CallExpression') {
        compiled.arguments[1] = storyPropsObjectExpression;
    }
    else if (compiled.type === 'ExpressionStatement' &&
        compiled.expression.type === 'CallExpression') {
        compiled.expression.arguments[1] = storyPropsObjectExpression;
    }
}