Skip to content

Commit 9132779

Browse files
Belco90Belco90
committed
refactor(prefer-presence-queries): rename message ids
1 parent 074579a commit 9132779

File tree

2 files changed

+50
-48
lines changed

2 files changed

+50
-48
lines changed

‎lib/rules/prefer-presence-queries.ts

+6-4
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import { findClosestCallNode, isMemberExpression } from '../node-utils';
44
import { createTestingLibraryRule } from '../create-testing-library-rule';
55

66
export const RULE_NAME = 'prefer-presence-queries';
7-
export type MessageIds = 'presenceQuery' | 'absenceQuery';
7+
export type MessageIds = 'wrongPresenceQuery' | 'wrongAbsenceQuery';
88
type Options = [];
99

1010
export default createTestingLibraryRule<Options, MessageIds>({
@@ -17,9 +17,9 @@ export default createTestingLibraryRule<Options, MessageIds>({
1717
recommended: 'error',
1818
},
1919
messages: {
20-
presenceQuery:
20+
wrongPresenceQuery:
2121
'Use `getBy*` queries rather than `queryBy*` for checking element is present',
22-
absenceQuery:
22+
wrongAbsenceQuery:
2323
'Use `queryBy*` queries rather than `getBy*` for checking element is NOT present',
2424
},
2525
schema: [],
@@ -65,7 +65,9 @@ export default createTestingLibraryRule<Options, MessageIds>({
6565
? ABSENCE_MATCHERS
6666
: PRESENCE_MATCHERS;
6767

68-
const messageId = isPresenceQuery ? 'absenceQuery' : 'presenceQuery';
68+
const messageId = isPresenceQuery
69+
? 'wrongAbsenceQuery'
70+
: 'wrongPresenceQuery';
6971

7072
if (
7173
(!isNegatedMatcher && invalidMatchers.includes(matcher)) ||

‎tests/lib/rules/prefer-presence-queries.test.ts

+44-44
Original file line numberDiff line numberDiff line change
@@ -374,27 +374,27 @@ ruleTester.run(RULE_NAME, rule, {
374374
getInvalidAssertion({
375375
query: queryName,
376376
matcher: '.toBeNull()',
377-
messageId: 'absenceQuery',
377+
messageId: 'wrongAbsenceQuery',
378378
}),
379379
getInvalidAssertion({
380380
query: queryName,
381381
matcher: '.toBeFalsy()',
382-
messageId: 'absenceQuery',
382+
messageId: 'wrongAbsenceQuery',
383383
}),
384384
getInvalidAssertion({
385385
query: queryName,
386386
matcher: '.not.toBeInTheDocument()',
387-
messageId: 'absenceQuery',
387+
messageId: 'wrongAbsenceQuery',
388388
}),
389389
getInvalidAssertion({
390390
query: queryName,
391391
matcher: '.not.toBeTruthy()',
392-
messageId: 'absenceQuery',
392+
messageId: 'wrongAbsenceQuery',
393393
}),
394394
getInvalidAssertion({
395395
query: queryName,
396396
matcher: '.not.toBeDefined()',
397-
messageId: 'absenceQuery',
397+
messageId: 'wrongAbsenceQuery',
398398
}),
399399
],
400400
[]
@@ -406,31 +406,31 @@ ruleTester.run(RULE_NAME, rule, {
406406
getInvalidAssertion({
407407
query: queryName,
408408
matcher: '.toBeNull()',
409-
messageId: 'absenceQuery',
409+
messageId: 'wrongAbsenceQuery',
410410
shouldUseScreen: true,
411411
}),
412412
getInvalidAssertion({
413413
query: queryName,
414414
matcher: '.toBeFalsy()',
415-
messageId: 'absenceQuery',
415+
messageId: 'wrongAbsenceQuery',
416416
shouldUseScreen: true,
417417
}),
418418
getInvalidAssertion({
419419
query: queryName,
420420
matcher: '.not.toBeInTheDocument()',
421-
messageId: 'absenceQuery',
421+
messageId: 'wrongAbsenceQuery',
422422
shouldUseScreen: true,
423423
}),
424424
getInvalidAssertion({
425425
query: queryName,
426426
matcher: '.not.toBeTruthy()',
427-
messageId: 'absenceQuery',
427+
messageId: 'wrongAbsenceQuery',
428428
shouldUseScreen: true,
429429
}),
430430
getInvalidAssertion({
431431
query: queryName,
432432
matcher: '.not.toBeDefined()',
433-
messageId: 'absenceQuery',
433+
messageId: 'wrongAbsenceQuery',
434434
shouldUseScreen: true,
435435
}),
436436
],
@@ -443,27 +443,27 @@ ruleTester.run(RULE_NAME, rule, {
443443
getInvalidAssertion({
444444
query: queryName,
445445
matcher: '.toBeNull()',
446-
messageId: 'absenceQuery',
446+
messageId: 'wrongAbsenceQuery',
447447
}),
448448
getInvalidAssertion({
449449
query: queryName,
450450
matcher: '.toBeFalsy()',
451-
messageId: 'absenceQuery',
451+
messageId: 'wrongAbsenceQuery',
452452
}),
453453
getInvalidAssertion({
454454
query: queryName,
455455
matcher: '.not.toBeInTheDocument()',
456-
messageId: 'absenceQuery',
456+
messageId: 'wrongAbsenceQuery',
457457
}),
458458
getInvalidAssertion({
459459
query: queryName,
460460
matcher: '.not.toBeTruthy()',
461-
messageId: 'absenceQuery',
461+
messageId: 'wrongAbsenceQuery',
462462
}),
463463
getInvalidAssertion({
464464
query: queryName,
465465
matcher: '.not.toBeDefined()',
466-
messageId: 'absenceQuery',
466+
messageId: 'wrongAbsenceQuery',
467467
}),
468468
],
469469
[]
@@ -475,31 +475,31 @@ ruleTester.run(RULE_NAME, rule, {
475475
getInvalidAssertion({
476476
query: queryName,
477477
matcher: '.toBeNull()',
478-
messageId: 'absenceQuery',
478+
messageId: 'wrongAbsenceQuery',
479479
shouldUseScreen: true,
480480
}),
481481
getInvalidAssertion({
482482
query: queryName,
483483
matcher: '.toBeFalsy()',
484-
messageId: 'absenceQuery',
484+
messageId: 'wrongAbsenceQuery',
485485
shouldUseScreen: true,
486486
}),
487487
getInvalidAssertion({
488488
query: queryName,
489489
matcher: '.not.toBeInTheDocument()',
490-
messageId: 'absenceQuery',
490+
messageId: 'wrongAbsenceQuery',
491491
shouldUseScreen: true,
492492
}),
493493
getInvalidAssertion({
494494
query: queryName,
495495
matcher: '.not.toBeTruthy()',
496-
messageId: 'absenceQuery',
496+
messageId: 'wrongAbsenceQuery',
497497
shouldUseScreen: true,
498498
}),
499499
getInvalidAssertion({
500500
query: queryName,
501501
matcher: '.not.toBeDefined()',
502-
messageId: 'absenceQuery',
502+
messageId: 'wrongAbsenceQuery',
503503
shouldUseScreen: true,
504504
}),
505505
],
@@ -512,27 +512,27 @@ ruleTester.run(RULE_NAME, rule, {
512512
getInvalidAssertion({
513513
query: queryName,
514514
matcher: '.toBeTruthy()',
515-
messageId: 'presenceQuery',
515+
messageId: 'wrongPresenceQuery',
516516
}),
517517
getInvalidAssertion({
518518
query: queryName,
519519
matcher: '.toBeDefined()',
520-
messageId: 'presenceQuery',
520+
messageId: 'wrongPresenceQuery',
521521
}),
522522
getInvalidAssertion({
523523
query: queryName,
524524
matcher: '.toBeInTheDocument()',
525-
messageId: 'presenceQuery',
525+
messageId: 'wrongPresenceQuery',
526526
}),
527527
getInvalidAssertion({
528528
query: queryName,
529529
matcher: '.not.toBeFalsy()',
530-
messageId: 'presenceQuery',
530+
messageId: 'wrongPresenceQuery',
531531
}),
532532
getInvalidAssertion({
533533
query: queryName,
534534
matcher: '.not.toBeNull()',
535-
messageId: 'presenceQuery',
535+
messageId: 'wrongPresenceQuery',
536536
}),
537537
],
538538
[]
@@ -544,31 +544,31 @@ ruleTester.run(RULE_NAME, rule, {
544544
getInvalidAssertion({
545545
query: queryName,
546546
matcher: '.toBeTruthy()',
547-
messageId: 'presenceQuery',
547+
messageId: 'wrongPresenceQuery',
548548
shouldUseScreen: true,
549549
}),
550550
getInvalidAssertion({
551551
query: queryName,
552552
matcher: '.toBeDefined()',
553-
messageId: 'presenceQuery',
553+
messageId: 'wrongPresenceQuery',
554554
shouldUseScreen: true,
555555
}),
556556
getInvalidAssertion({
557557
query: queryName,
558558
matcher: '.toBeInTheDocument()',
559-
messageId: 'presenceQuery',
559+
messageId: 'wrongPresenceQuery',
560560
shouldUseScreen: true,
561561
}),
562562
getInvalidAssertion({
563563
query: queryName,
564564
matcher: '.not.toBeFalsy()',
565-
messageId: 'presenceQuery',
565+
messageId: 'wrongPresenceQuery',
566566
shouldUseScreen: true,
567567
}),
568568
getInvalidAssertion({
569569
query: queryName,
570570
matcher: '.not.toBeNull()',
571-
messageId: 'presenceQuery',
571+
messageId: 'wrongPresenceQuery',
572572
shouldUseScreen: true,
573573
}),
574574
],
@@ -581,27 +581,27 @@ ruleTester.run(RULE_NAME, rule, {
581581
getInvalidAssertion({
582582
query: queryName,
583583
matcher: '.toBeTruthy()',
584-
messageId: 'presenceQuery',
584+
messageId: 'wrongPresenceQuery',
585585
}),
586586
getInvalidAssertion({
587587
query: queryName,
588588
matcher: '.toBeDefined()',
589-
messageId: 'presenceQuery',
589+
messageId: 'wrongPresenceQuery',
590590
}),
591591
getInvalidAssertion({
592592
query: queryName,
593593
matcher: '.toBeInTheDocument()',
594-
messageId: 'presenceQuery',
594+
messageId: 'wrongPresenceQuery',
595595
}),
596596
getInvalidAssertion({
597597
query: queryName,
598598
matcher: '.not.toBeFalsy()',
599-
messageId: 'presenceQuery',
599+
messageId: 'wrongPresenceQuery',
600600
}),
601601
getInvalidAssertion({
602602
query: queryName,
603603
matcher: '.not.toBeNull()',
604-
messageId: 'presenceQuery',
604+
messageId: 'wrongPresenceQuery',
605605
}),
606606
],
607607
[]
@@ -613,57 +613,57 @@ ruleTester.run(RULE_NAME, rule, {
613613
getInvalidAssertion({
614614
query: queryName,
615615
matcher: '.toBeTruthy()',
616-
messageId: 'presenceQuery',
616+
messageId: 'wrongPresenceQuery',
617617
shouldUseScreen: true,
618618
}),
619619
getInvalidAssertion({
620620
query: queryName,
621621
matcher: '.toBeDefined()',
622-
messageId: 'presenceQuery',
622+
messageId: 'wrongPresenceQuery',
623623
shouldUseScreen: true,
624624
}),
625625
getInvalidAssertion({
626626
query: queryName,
627627
matcher: '.toBeInTheDocument()',
628-
messageId: 'presenceQuery',
628+
messageId: 'wrongPresenceQuery',
629629
shouldUseScreen: true,
630630
}),
631631
getInvalidAssertion({
632632
query: queryName,
633633
matcher: '.not.toBeFalsy()',
634-
messageId: 'presenceQuery',
634+
messageId: 'wrongPresenceQuery',
635635
shouldUseScreen: true,
636636
}),
637637
getInvalidAssertion({
638638
query: queryName,
639639
matcher: '.not.toBeNull()',
640-
messageId: 'presenceQuery',
640+
messageId: 'wrongPresenceQuery',
641641
shouldUseScreen: true,
642642
}),
643643
],
644644
[]
645645
),
646646
{
647647
code: 'expect(screen.getAllByText("button")[1]).not.toBeInTheDocument()',
648-
errors: [{ messageId: 'absenceQuery', line: 1, column: 15 }],
648+
errors: [{ messageId: 'wrongAbsenceQuery', line: 1, column: 15 }],
649649
},
650650
{
651651
code: 'expect(screen.queryAllByText("button")[1]).toBeInTheDocument()',
652-
errors: [{ messageId: 'presenceQuery', line: 1, column: 15 }],
652+
errors: [{ messageId: 'wrongPresenceQuery', line: 1, column: 15 }],
653653
},
654654
{
655655
code: `
656656
// case: asserting presence incorrectly with custom queryBy* query
657657
expect(queryByCustomQuery("button")).toBeInTheDocument()
658658
`,
659-
errors: [{ messageId: 'presenceQuery', line: 3, column: 16 }],
659+
errors: [{ messageId: 'wrongPresenceQuery', line: 3, column: 16 }],
660660
},
661661
{
662662
code: `
663663
// case: asserting absence incorrectly with custom getBy* query
664664
expect(getByCustomQuery("button")).not.toBeInTheDocument()
665665
`,
666-
errors: [{ messageId: 'absenceQuery', line: 3, column: 16 }],
666+
errors: [{ messageId: 'wrongAbsenceQuery', line: 3, column: 16 }],
667667
},
668668
// TODO: add more tests for importing custom module
669669
],

0 commit comments

Comments
 (0)