From 2a0878fb634831f572f207de9c950b9fd985a984 Mon Sep 17 00:00:00 2001 From: StyleShit <32631382+StyleShit@users.noreply.github.com> Date: Sun, 29 Mar 2026 10:15:23 +0300 Subject: [PATCH] refactor(eslint-plugin-internal): rename `require-story-params` to `require-story-meta-annotations` [AR-55121] --- .../design-system/src/stories/colors/colors.stories.tsx | 2 +- .../src/stories/scrollbars/scrollbars.stories.tsx | 2 +- packages/eslint-plugin-internal/src/index.ts | 6 +++--- ...arams.test.ts => require-story-meta-annotations.test.ts} | 4 ++-- ...re-story-params.ts => require-story-meta-annotations.ts} | 4 ++-- 5 files changed, 9 insertions(+), 9 deletions(-) rename packages/eslint-plugin-internal/src/rules/__tests__/{require-story-params.test.ts => require-story-meta-annotations.test.ts} (96%) rename packages/eslint-plugin-internal/src/rules/{require-story-params.ts => require-story-meta-annotations.ts} (89%) diff --git a/packages/design-system/src/stories/colors/colors.stories.tsx b/packages/design-system/src/stories/colors/colors.stories.tsx index 4bd1883ee..fff1e1974 100644 --- a/packages/design-system/src/stories/colors/colors.stories.tsx +++ b/packages/design-system/src/stories/colors/colors.stories.tsx @@ -2,7 +2,7 @@ import type { Meta, StoryObj } from '@storybook/react-vite'; import { useState } from 'react'; import styles from './colors.stories.module.scss'; -// eslint-disable-next-line @drivenets/ds-internal/require-story-params -- component prop is not required here. +// eslint-disable-next-line @drivenets/ds-internal/require-story-meta-annotations -- component prop is not required here. const meta: Meta = { title: 'Design System/Colors', parameters: { diff --git a/packages/design-system/src/stories/scrollbars/scrollbars.stories.tsx b/packages/design-system/src/stories/scrollbars/scrollbars.stories.tsx index 53612fb49..5f53e178c 100644 --- a/packages/design-system/src/stories/scrollbars/scrollbars.stories.tsx +++ b/packages/design-system/src/stories/scrollbars/scrollbars.stories.tsx @@ -3,7 +3,7 @@ import { Fragment } from 'react'; import classNames from 'classnames'; import styles from './scrollbars.stories.module.scss'; -// eslint-disable-next-line @drivenets/ds-internal/require-story-params -- component prop is not required here. +// eslint-disable-next-line @drivenets/ds-internal/require-story-meta-annotations -- component prop is not required here. const meta: Meta = { title: 'Design System/Scrollbars', parameters: { diff --git a/packages/eslint-plugin-internal/src/index.ts b/packages/eslint-plugin-internal/src/index.ts index 814cd2d88..42f1775b4 100644 --- a/packages/eslint-plugin-internal/src/index.ts +++ b/packages/eslint-plugin-internal/src/index.ts @@ -10,7 +10,7 @@ import { noUselessStoryAnnotations } from './rules/no-useless-story-annotations' import { noUselessTsxExtension } from './rules/no-useless-tsx-extension'; import { noVitestBrowserReact } from './rules/no-vitest-browser-react'; import { noVitestInStories } from './rules/no-vitest-in-stories'; -import { requireStoryParams } from './rules/require-story-params'; +import { requireStoryMetaAnnotations } from './rules/require-story-meta-annotations'; const plugin = { meta: { @@ -28,7 +28,7 @@ const plugin = { 'no-useless-tsx-extension': noUselessTsxExtension, 'no-vitest-browser-react': noVitestBrowserReact, 'no-vitest-in-stories': noVitestInStories, - 'require-story-params': requireStoryParams, + 'require-story-meta-annotations': requireStoryMetaAnnotations, }, configs: { @@ -66,7 +66,7 @@ Object.assign(plugin.configs, { 'storybook/no-redundant-story-name': 'off', // turn off conflicting rule '@drivenets/ds-internal/no-vitest-in-stories': 'error', - '@drivenets/ds-internal/require-story-params': 'error', + '@drivenets/ds-internal/require-story-meta-annotations': 'error', }, }, diff --git a/packages/eslint-plugin-internal/src/rules/__tests__/require-story-params.test.ts b/packages/eslint-plugin-internal/src/rules/__tests__/require-story-meta-annotations.test.ts similarity index 96% rename from packages/eslint-plugin-internal/src/rules/__tests__/require-story-params.test.ts rename to packages/eslint-plugin-internal/src/rules/__tests__/require-story-meta-annotations.test.ts index dd731abed..923b643cb 100644 --- a/packages/eslint-plugin-internal/src/rules/__tests__/require-story-params.test.ts +++ b/packages/eslint-plugin-internal/src/rules/__tests__/require-story-meta-annotations.test.ts @@ -1,9 +1,9 @@ import { RuleTester } from '@typescript-eslint/rule-tester'; -import { requireStoryParams } from '../require-story-params'; +import { requireStoryMetaAnnotations } from '../require-story-meta-annotations'; const ruleTester = new RuleTester(); -ruleTester.run('require-story-params', requireStoryParams, { +ruleTester.run('require-story-meta-annotations', requireStoryMetaAnnotations, { valid: [ { name: 'meta with all required properties', diff --git a/packages/eslint-plugin-internal/src/rules/require-story-params.ts b/packages/eslint-plugin-internal/src/rules/require-story-meta-annotations.ts similarity index 89% rename from packages/eslint-plugin-internal/src/rules/require-story-params.ts rename to packages/eslint-plugin-internal/src/rules/require-story-meta-annotations.ts index 8eb669f1a..0ea3de9fc 100644 --- a/packages/eslint-plugin-internal/src/rules/require-story-params.ts +++ b/packages/eslint-plugin-internal/src/rules/require-story-meta-annotations.ts @@ -6,8 +6,8 @@ type MessageId = 'missing'; const requiredProperties = ['title', 'component']; -export const requireStoryParams = createRule<[], MessageId>({ - name: 'require-story-params', +export const requireStoryMetaAnnotations = createRule<[], MessageId>({ + name: 'require-story-meta-annotations', meta: { type: 'problem', docs: {