fix(valid-title): report emptyTitle for string-like types (#688)

* fix: report emptyTitle when type is string-like and value is empty * test: add test * docs: fix sample code

Author: y-hsgw

docs/rules/valid-title.md

@@ -40,7 +40,7 @@ Examples of **incorrect** code for this rule with the `{ "ignoreTypeOfDescribeNa
 ```js
 describe(1, () => {
  it('should be a number', () => {
-expect(1).toBeNumber()
+expect(1).toBe(1)
  })
 })
 ```
@@ -50,7 +50,7 @@ Examples of **correct** code for this rule with the `{ "ignoreTypeOfDescribeName
 ```js
 describe('1', () => {
  it('should be a number', () => {
-expect(1).toBeNumber()
+expect(1).toBe(1)
  })
 })
 ```
@@ -88,7 +88,7 @@ Examples of **incorrect** code for this rule with the `{ "disallowedWords": ["sk
 ```js
 describe('foo', () => {
  it.skip('should be skipped', () => {
-expect(1).toBeNumber()
+expect(1).toBe(1)
  })
 })
 ```
@@ -98,7 +98,7 @@ Examples of **correct** code for this rule with the `{ "disallowedWords": ["skip
 ```js
 describe('foo', () => {
  it('should be skipped', () => {
-expect(1).toBeNumber()
+expect(1).toBe(1)
  })
 })
 ```
@@ -112,7 +112,7 @@ Examples of **incorrect** code for this rule with the `{ "mustNotMatch": ["^\\s+
 ```js
 describe('foo', () => {
  it(' ', () => {
-expect(1).toBeNumber()
+expect(1).toBe(1)
  })
 })
 ```
@@ -123,7 +123,7 @@ Examples of **correct** code for this rule with the `{ "mustNotMatch": ["^\\s+$"
 
 describe('foo', () => {
  it('should be a number', () => {
-expect(1).toBeNumber()
+expect(1).toBe(1)
  })
 })
 ```
@@ -145,7 +145,7 @@ Examples of **incorrect** code for this rule with the `{ "mustMatch": ["^\\s*\\w
 ```js
 describe('foo', () => {
  it(' ', () => {
-expect(1).toBeNumber()
+expect(1).toBe(1)
  })
 })
 ```
@@ -156,7 +156,7 @@ Examples of **correct** code for this rule with the `{ "mustMatch": ["^\\s*\\w+\
 
 describe('foo', () => {
  it('should be a number', () => {
-expect(1).toBeNumber()
+expect(1).toBe(1)
  })
 })
 ```
@@ -168,7 +168,7 @@ Examples of **incorrect** code for this rule with the `{ "mustMatch": { "it": ["
 describe('foo', () => {
  // This check fails because the title does not match the regex
  it('Should be a number', () => {
- expect(1).toBeNumber()
+ expect(1).toBe(1)
  })
 })
 ```
@@ -180,7 +180,7 @@ Examples of **correct** code for this rule with the `{ "mustMatch": { "describe"
 describe('foo', () => {
  // This check succeeds because the title matches the regex
  it('should be a number.', () => {
- expect(1).toBeNumber()
+ expect(1).toBe(1)
  })
 })
 ```

src/rules/valid-title.ts

@@ -210,14 +210,33 @@ export default createEslintRule<Options, MESSAGE_IDS>({
  return
  }
 
+ const reportEmptyTitle = (node: TSESTree.CallExpression) => {
+ context.report({
+ messageId: 'emptyTitle',
+ data: {
+ functionName: vitestFnCall.type === 'describe'
+ ? DescribeAlias.describe
+ : TestCaseName.test
+ },
+ node
+ })
+ }
+
  const [argument] = node.arguments
 
  if (settings.typecheck) {
  const services = ESLintUtils.getParserServices(context)
 
  const type = services.getTypeAtLocation(argument)
 
- if (isFunctionType(type) || isClassType(type) || isStringLikeType(type)) return
+ if (isFunctionType(type) || isClassType(type)) return
+
+ if (isStringLikeType(type)) {
+ if (isStringNode(argument) && !getStringValue(argument)) {
+ reportEmptyTitle(node)
+ }
+ return
+ }
  }
 
  if (!argument || (allowArguments && argument.type === AST_NODE_TYPES.Identifier)) return
@@ -240,15 +259,7 @@ export default createEslintRule<Options, MESSAGE_IDS>({
  const title = getStringValue(argument)
 
  if (!title) {
- context.report({
- messageId: 'emptyTitle',
- data: {
- functionName: vitestFnCall.type === 'describe'
- ? DescribeAlias.describe
- : TestCaseName.test
- },
- node
- })
+ reportEmptyTitle(node)
  return
  }
 

tests/valid-title.test.ts

@@ -514,6 +514,18 @@ ruleTester.run(RULE_NAME, rule, {
  }
  ]
  },
+ {
+ code: 'it("", function () {})',
+ settings: { vitest: { typecheck: true } },
+ errors: [
+ {
+ messageId: 'emptyTitle',
+ column: 1,
+ line: 1,
+ data: { functionName: 'test' }
+ }
+ ]
+ },
  {
  code: 'it.concurrent("", function () {})',
  errors: [