Skip to content

refactor(eslint-plugin-internal): require-story-params → require-story-meta-annotations [AR-55121] #326

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
StyleShit wants to merge 2 commits into
base: main
Choose a base branch
from
Open

refactor(eslint-plugin-internal): require-story-params → require-story-meta-annotations [AR-55121] #326

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2a0878f
refactor(eslint-plugin-internal): rename `require-story-params` to `r…
StyleShit Mar 29, 2026
ead04c4
Merge branch 'main' into refactor/AR-55121-require-story-meta-annotat…
StyleShit Mar 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/design-system/src/stories/colors/colors.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: {
Expand Down
2 changes: 1 addition & 1 deletion packages/design-system/src/stories/scrollbars/scrollbars.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: {
Expand Down
6 changes: 3 additions & 3 deletions packages/eslint-plugin-internal/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: {
Expand All @@ -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: {
Expand Down Expand Up @@ -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',
},
},

Expand Down
4 changes: 2 additions & 2 deletions ...es/__tests__/require-story-params.test.ts → ...__/require-story-meta-annotations.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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',
Expand Down
4 changes: 2 additions & 2 deletions ...nternal/src/rules/require-story-params.ts → ...c/rules/require-story-meta-annotations.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: {
Expand Down
Loading