upstream-twenty/packages/twenty-docs/scripts/ui/check-story-embeds.mts

import { createProcessor } from '@mdx-js/mdx';
import remarkFrontmatter from 'remark-frontmatter';
import { isNonEmptyString } from '@sniptt/guards';
import { visit } from 'unist-util-visit';

export const checkStoryEmbeds = ({
  content,
  storyIds,
}: {
  content: string;
  storyIds: Set<string>;
}): string[] => {
  const errors: string[] = [];
  const tree = createProcessor({
    remarkPlugins: [remarkFrontmatter],
  }).parse(content);
  const embedNames = new Set(['StoryEmbed']);

  visit(tree, 'mdxjsEsm', (node) => {
    for (const statement of node.data?.estree?.body ?? []) {
      if (
        statement.type !== 'ImportDeclaration' ||
        statement.source.value !== '/snippets/ui/StoryEmbed.mdx'
      ) {
        continue;
      }

      for (const specifier of statement.specifiers) {
        const isNamedEmbed =
          specifier.type === 'ImportSpecifier' &&
          specifier.imported.type === 'Identifier' &&
          specifier.imported.name === 'StoryEmbed';

        if (specifier.type === 'ImportDefaultSpecifier' || isNamedEmbed) {
          embedNames.add(specifier.local.name);
        }
      }
    }
  });

  visit(tree, ['mdxJsxFlowElement', 'mdxJsxTextElement'], (node) => {
    if (
      (node.type !== 'mdxJsxFlowElement' &&
        node.type !== 'mdxJsxTextElement') ||
      !embedNames.has(node.name ?? '')
    ) {
      return;
    }

    const storyId = node.attributes.find(
      (attribute) =>
        attribute.type === 'mdxJsxAttribute' && attribute.name === 'storyId',
    );
    const value =
      storyId?.type === 'mdxJsxAttribute' ? storyId.value : undefined;
    const line = node.position?.start.line;

    const hasSpreadAttributes = node.attributes.some(
      (attribute) => attribute.type === 'mdxJsxExpressionAttribute',
    );

    if (!isNonEmptyString(value) || hasSpreadAttributes) {
      errors.push(`Line ${line}: StoryEmbed needs a literal storyId.`);
      return;
    }

    if (!storyIds.has(value)) {
      errors.push(`Line ${line}: Storybook story "${value}" does not exist.`);
    }
  });

  return errors;
};