Skip to content

docs(valid-title): add documentation for ignoreTypeOfTestName option #1842

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
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs(valid-title): add documentation for ignoreTypeOfTestName option #1842

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ec722fb
Add missing documentation of ignoreTypeOfTestName option
edg2s Nov 3, 2025
acfc2c2
Merge blocks, run prettier
edg2s Nov 4, 2025
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
8 changes: 8 additions & 0 deletions docs/rules/valid-title.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Enforce valid titles (`valid-title`)

💼 This rule is enabled in the ✅ `recommended`
Expand Down Expand Up @@ -175,6 +175,7 @@
interface Options {
ignoreSpaces?: boolean;
ignoreTypeOfDescribeName?: boolean;
ignoreTypeOfTestName?: boolean;
disallowedWords?: string[];
mustNotMatch?: Partial<Record<'describe' | 'test' | 'it', string>> | string;
mustMatch?: Partial<Record<'describe' | 'test' | 'it', string>> | string;
Expand All @@ -194,6 +195,13 @@
When enabled, the type of the first argument to `describe` blocks won't be
checked.

#### `ignoreTypeOfTestName`
Copy link
Collaborator

@G-Rath G-Rath Nov 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if we're going to add a section for this, we might as well use it for ignoreTypeOfDescribeName too, like mustMatch and mustNotMatch below


Default: `false`

When enabled, the type of the first argument to `it` blocks won't be
checked.

#### `disallowedWords`

Default: `[]`
Expand Down
Loading