Enforce test and test.describe to have descriptions that begin with a lowercase letter. This provides more readable test failures. This rule is not enabled by default.

The following pattern is considered a warning:

test('Adds 1 + 2 to equal 3', () => {
  expect(sum(1, 2)).toBe(3)
})

The following pattern is not considered a warning:

test('adds 1 + 2 to equal 3', () => {
  expect(sum(1, 2)).toBe(3)
})

{
  "playwright/prefer-lowercase-title": [
    "error",
    {
      "allowedPrefixes": ["GET", "POST"],
      "ignore": ["test.describe", "test"],
      "ignoreTopLevelDescribe": true
    }
  ]
}

This array option controls which Playwright functions are checked by this rule. There are two possible values:

• "test.describe"
• "test"

By default, none of these options are enabled (the equivalent of { "ignore": [] }).

Example of correct code for the { "ignore": ["test.describe"] } option:

test.describe('Uppercase description')

Example of correct code for the { "ignore": ["test"] } option:

test('Uppercase description')

This array option allows specifying prefixes, which contain capitals that titles can start with. This can be useful when writing tests for API endpoints, where you'd like to prefix with the HTTP method.

By default, nothing is allowed (the equivalent of { "allowedPrefixes": [] }).

Example of correct code for the { "allowedPrefixes": ["GET"] } option:

test.describe('GET /live')

This option can be set to allow only the top-level test.describe blocks to have a title starting with an upper-case letter.

Example of correct code for the { "ignoreTopLevelDescribe": true } option:

test.describe('MyClass', () => {
  test.describe('#myMethod', () => {
    test('does things', () => {})
  })
})