eslint-plugin

stories-export-meta.js

/**
 * @fileoverview The default export should include type checking using `satisfy Meta`
 * @author Sergey Kozlov
 */
"use strict";

module.exports = {
  /**
     * @type { import('eslint').Rule.RuleMetaData }
     */
  meta: {
    type: "suggestion",
    docs: {
      description: "The default export should include type checking using `satisfy Meta`",
      recommended: false,
    },
    messages: {
      exportDefaultTypeCheck: "`export default` should be `satisfies Meta<typeof T>`",
    },
    schema: [],
  },

  /**
     * @param { import('eslint').Rule.RuleContext } context
     * @return { import('eslint').Rule.RuleListener }
     */
  create: function (context) {
    return {
      ExportDefaultDeclaration: (node) => {
        const hasSatisfies = node.declaration.type === 'TSSatisfiesExpression';
        const isMeta = node.declaration?.typeAnnotation?.typeName?.name === 'Meta';
        const isMetaWithParameter = Boolean(node.declaration?.typeAnnotation?.typeParameters);
        if (!hasSatisfies || !isMeta || !isMetaWithParameter) {
          context.report({
            node: node.declaration.typeAnnotation ?? node.declaration,
            messageId: "exportDefaultTypeCheck"
          });
        }
      },
    };
  },
};

stories-export-typed.js

/**
 * @fileoverview Stories exports should include type checking using `Story` or `StoryObj`
 * @author Sergey Kozlov
 */
"use strict";

const validStoryNames = ['Story', 'StoryObj'];
const validStoryNamesString = validStoryNames.map(name => `\`${name}\``).join(' or ');

module.exports = {
  /**
     * @type { import('eslint').Rule.RuleMetaData }
     */
  meta: {
    type: "suggestion",
    docs: {
      description: `Stories exports should include type checking using ${validStoryNamesString}`,
      recommended: false,
    },
    messages: {
      exportStoryType: `stories \`export\` should be typed as ${validStoryNamesString}`,
    },
    schema: [],
  },

  /**
     * @param { import('eslint').Rule.RuleContext } context
     * @return { import('eslint').Rule.RuleListener }
     */
  create: function (context) {
    return {
      ExportNamedDeclaration: (node) => {
        const nodeStoryId = node.declaration.declarations[0].id;

        if (nodeStoryId) {
          if (validStoryNames.includes(nodeStoryId.typeAnnotation?.typeAnnotation?.typeName?.name)) {
            return;
          }
          context.report({
            node: nodeStoryId?.typeAnnotation ?? nodeStoryId,
            messageId: "exportStoryType"
          });
        }
      },
    };
  },
};