Skip to content

Commit f566d21

Browse files
Remove unnecessary 'tester' parameter on some key presses, also correct the abbreviation from 'ctl' to 'ctrl' (Resolves #35)
1 parent 6352118 commit f566d21

File tree

2 files changed

+113
-44
lines changed

2 files changed

+113
-44
lines changed

analysis_options.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,7 @@ include: package:flutter_lints/flutter.yaml
66
analyzer:
77
exclude:
88
- doc/**
9+
10+
linter:
11+
rules:
12+
always_use_package_imports: true

lib/src/keyboard.dart

Lines changed: 109 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,12 @@ extension KeyboardInput on WidgetTester {
218218
await _maybeSettleOrExtraPumps(settle: settle, extraPumps: extraPumps);
219219
}
220220

221+
@Deprecated("Use pressCtrlEnter() instead")
221222
Future<void> pressCtlEnter({bool settle = true, int extraPumps = 0}) async {
223+
await pressCtrlEnter(settle: settle, extraPumps: extraPumps);
224+
}
225+
226+
Future<void> pressCtrlEnter({bool settle = true, int extraPumps = 0}) async {
222227
await sendKeyDownEvent(LogicalKeyboardKey.control, platform: _keyEventPlatform);
223228
await sendKeyDownEvent(LogicalKeyboardKey.enter, platform: _keyEventPlatform);
224229
await sendKeyUpEvent(LogicalKeyboardKey.enter, platform: _keyEventPlatform);
@@ -328,7 +333,12 @@ extension KeyboardInput on WidgetTester {
328333
await _maybeSettleOrExtraPumps(settle: settle, extraPumps: extraPumps);
329334
}
330335

336+
@Deprecated("Use pressCtrlBackspace() instead")
331337
Future<void> pressCtlBackspace({bool settle = true, int extraPumps = 0}) async {
338+
await pressCtrlBackspace(settle: settle, extraPumps: extraPumps);
339+
}
340+
341+
Future<void> pressCtrlBackspace({bool settle = true, int extraPumps = 0}) async {
332342
await sendKeyDownEvent(LogicalKeyboardKey.control, platform: _keyEventPlatform);
333343
await sendKeyDownEvent(LogicalKeyboardKey.backspace, platform: _keyEventPlatform);
334344
await sendKeyUpEvent(LogicalKeyboardKey.backspace, platform: _keyEventPlatform);
@@ -352,7 +362,12 @@ extension KeyboardInput on WidgetTester {
352362
await _maybeSettleOrExtraPumps(settle: settle, extraPumps: extraPumps);
353363
}
354364

365+
@Deprecated("Use pressCtrlB() instead")
355366
Future<void> pressCtlB({bool settle = true, int extraPumps = 0}) async {
367+
await pressCtrlB(settle: settle, extraPumps: extraPumps);
368+
}
369+
370+
Future<void> pressCtrlB({bool settle = true, int extraPumps = 0}) async {
356371
await sendKeyDownEvent(LogicalKeyboardKey.control, platform: _keyEventPlatform);
357372
await sendKeyDownEvent(LogicalKeyboardKey.keyB, platform: _keyEventPlatform);
358373
await sendKeyUpEvent(LogicalKeyboardKey.keyB, platform: _keyEventPlatform);
@@ -370,7 +385,12 @@ extension KeyboardInput on WidgetTester {
370385
await _maybeSettleOrExtraPumps(settle: settle, extraPumps: extraPumps);
371386
}
372387

388+
@Deprecated("Use pressCtrlC() instead")
373389
Future<void> pressCtlC({bool settle = true, int extraPumps = 0}) async {
390+
await pressCtrlC(settle: settle, extraPumps: extraPumps);
391+
}
392+
393+
Future<void> pressCtrlC({bool settle = true, int extraPumps = 0}) async {
374394
await sendKeyDownEvent(LogicalKeyboardKey.control, platform: _keyEventPlatform);
375395
await sendKeyDownEvent(LogicalKeyboardKey.keyC, platform: _keyEventPlatform);
376396
await sendKeyUpEvent(LogicalKeyboardKey.keyC, platform: _keyEventPlatform);
@@ -388,7 +408,12 @@ extension KeyboardInput on WidgetTester {
388408
await _maybeSettleOrExtraPumps(settle: settle, extraPumps: extraPumps);
389409
}
390410

411+
@Deprecated("Use pressCtrlI() instead")
391412
Future<void> pressCtlI({bool settle = true, int extraPumps = 0}) async {
413+
await pressCtrlI(settle: settle, extraPumps: extraPumps);
414+
}
415+
416+
Future<void> pressCtrlI({bool settle = true, int extraPumps = 0}) async {
392417
await sendKeyDownEvent(LogicalKeyboardKey.control, platform: _keyEventPlatform);
393418
await sendKeyDownEvent(LogicalKeyboardKey.keyI, platform: _keyEventPlatform);
394419
await sendKeyUpEvent(LogicalKeyboardKey.keyI, platform: _keyEventPlatform);
@@ -406,7 +431,12 @@ extension KeyboardInput on WidgetTester {
406431
await _maybeSettleOrExtraPumps(settle: settle, extraPumps: extraPumps);
407432
}
408433

434+
@Deprecated("Use pressCtrlX() instead")
409435
Future<void> pressCtlX({bool settle = true, int extraPumps = 0}) async {
436+
await pressCtrlX(settle: settle, extraPumps: extraPumps);
437+
}
438+
439+
Future<void> pressCtrlX({bool settle = true, int extraPumps = 0}) async {
410440
await sendKeyDownEvent(LogicalKeyboardKey.control, platform: _keyEventPlatform);
411441
await sendKeyDownEvent(LogicalKeyboardKey.keyX, platform: _keyEventPlatform);
412442
await sendKeyUpEvent(LogicalKeyboardKey.keyX, platform: _keyEventPlatform);
@@ -424,7 +454,12 @@ extension KeyboardInput on WidgetTester {
424454
await _maybeSettleOrExtraPumps(settle: settle, extraPumps: extraPumps);
425455
}
426456

457+
@Deprecated("Use pressCtrlV() instead")
427458
Future<void> pressCtlV({bool settle = true, int extraPumps = 0}) async {
459+
await pressCtrlV(settle: settle, extraPumps: extraPumps);
460+
}
461+
462+
Future<void> pressCtrlV({bool settle = true, int extraPumps = 0}) async {
428463
await sendKeyDownEvent(LogicalKeyboardKey.control, platform: _keyEventPlatform);
429464
await sendKeyDownEvent(LogicalKeyboardKey.keyV, platform: _keyEventPlatform);
430465
await sendKeyUpEvent(LogicalKeyboardKey.keyV, platform: _keyEventPlatform);
@@ -442,7 +477,12 @@ extension KeyboardInput on WidgetTester {
442477
await _maybeSettleOrExtraPumps(settle: settle, extraPumps: extraPumps);
443478
}
444479

480+
@Deprecated("Use pressCtrlA() instead")
445481
Future<void> pressCtlA({bool settle = true, int extraPumps = 0}) async {
482+
await pressCtrlA(settle: settle, extraPumps: extraPumps);
483+
}
484+
485+
Future<void> pressCtrlA({bool settle = true, int extraPumps = 0}) async {
446486
await sendKeyDownEvent(LogicalKeyboardKey.control, platform: _keyEventPlatform);
447487
await sendKeyDownEvent(LogicalKeyboardKey.keyA, platform: _keyEventPlatform);
448488
await sendKeyUpEvent(LogicalKeyboardKey.keyA, platform: _keyEventPlatform);
@@ -451,7 +491,12 @@ extension KeyboardInput on WidgetTester {
451491
await _maybeSettleOrExtraPumps(settle: settle, extraPumps: extraPumps);
452492
}
453493

494+
@Deprecated("Use pressCtrlE() instead")
454495
Future<void> pressCtlE({bool settle = true, int extraPumps = 0}) async {
496+
await pressCtrlE(settle: settle, extraPumps: extraPumps);
497+
}
498+
499+
Future<void> pressCtrlE({bool settle = true, int extraPumps = 0}) async {
455500
await sendKeyDownEvent(LogicalKeyboardKey.control, platform: _keyEventPlatform);
456501
await sendKeyDownEvent(LogicalKeyboardKey.keyE, platform: _keyEventPlatform);
457502
await sendKeyUpEvent(LogicalKeyboardKey.keyE, platform: _keyEventPlatform);
@@ -509,7 +554,12 @@ extension KeyboardInput on WidgetTester {
509554
await _maybeSettleOrExtraPumps(settle: settle, extraPumps: extraPumps);
510555
}
511556

557+
@Deprecated("Use pressCtrlLeftArrow() instead")
512558
Future<void> pressCtlLeftArrow({bool settle = true, int extraPumps = 0}) async {
559+
await pressCtrlLeftArrow(settle: settle, extraPumps: extraPumps);
560+
}
561+
562+
Future<void> pressCtrlLeftArrow({bool settle = true, int extraPumps = 0}) async {
513563
await sendKeyDownEvent(LogicalKeyboardKey.control, platform: _keyEventPlatform);
514564
await sendKeyDownEvent(LogicalKeyboardKey.arrowLeft, platform: _keyEventPlatform);
515565
await sendKeyUpEvent(LogicalKeyboardKey.arrowLeft, platform: _keyEventPlatform);
@@ -518,7 +568,12 @@ extension KeyboardInput on WidgetTester {
518568
await _maybeSettleOrExtraPumps(settle: settle, extraPumps: extraPumps);
519569
}
520570

571+
@Deprecated("Use pressShiftCtrlLeftArrow() instead")
521572
Future<void> pressShiftCtlLeftArrow({bool settle = true, int extraPumps = 0}) async {
573+
await pressShiftCtrlLeftArrow(settle: settle, extraPumps: extraPumps);
574+
}
575+
576+
Future<void> pressShiftCtrlLeftArrow({bool settle = true, int extraPumps = 0}) async {
522577
await sendKeyDownEvent(LogicalKeyboardKey.shift, platform: _keyEventPlatform);
523578
await sendKeyDownEvent(LogicalKeyboardKey.control, platform: _keyEventPlatform);
524579
await sendKeyDownEvent(LogicalKeyboardKey.arrowLeft, platform: _keyEventPlatform);
@@ -584,7 +639,12 @@ extension KeyboardInput on WidgetTester {
584639
await _maybeSettleOrExtraPumps(settle: settle, extraPumps: extraPumps);
585640
}
586641

642+
@Deprecated("Use pressCtrlRightArrow() instead")
587643
Future<void> pressCtlRightArrow({bool settle = true, int extraPumps = 0}) async {
644+
await pressCtrlRightArrow(settle: settle, extraPumps: extraPumps);
645+
}
646+
647+
Future<void> pressCtrlRightArrow({bool settle = true, int extraPumps = 0}) async {
588648
await sendKeyDownEvent(LogicalKeyboardKey.control, platform: _keyEventPlatform);
589649
await sendKeyDownEvent(LogicalKeyboardKey.arrowRight, platform: _keyEventPlatform);
590650
await sendKeyUpEvent(LogicalKeyboardKey.arrowRight, platform: _keyEventPlatform);
@@ -593,7 +653,12 @@ extension KeyboardInput on WidgetTester {
593653
await _maybeSettleOrExtraPumps(settle: settle, extraPumps: extraPumps);
594654
}
595655

656+
@Deprecated("Use pressShiftCtrlRightArrow() instead")
596657
Future<void> pressShiftCtlRightArrow({bool settle = true, int extraPumps = 0}) async {
658+
await pressShiftCtrlRightArrow(settle: settle, extraPumps: extraPumps);
659+
}
660+
661+
Future<void> pressShiftCtrlRightArrow({bool settle = true, int extraPumps = 0}) async {
597662
await sendKeyDownEvent(LogicalKeyboardKey.shift, platform: _keyEventPlatform);
598663
await sendKeyDownEvent(LogicalKeyboardKey.control, platform: _keyEventPlatform);
599664
await sendKeyDownEvent(LogicalKeyboardKey.arrowRight, platform: _keyEventPlatform);
@@ -740,78 +805,78 @@ extension KeyboardInput on WidgetTester {
740805
await _maybeSettleOrExtraPumps(settle: settle, extraPumps: extraPumps);
741806
}
742807

743-
Future<void> pressCmdHome(WidgetTester tester, {bool settle = true, int extraPumps = 0}) async {
744-
await tester.sendKeyDownEvent(LogicalKeyboardKey.meta, platform: _keyEventPlatform);
745-
await tester.sendKeyDownEvent(LogicalKeyboardKey.home, platform: _keyEventPlatform);
746-
await tester.sendKeyUpEvent(LogicalKeyboardKey.meta, platform: _keyEventPlatform);
747-
await tester.sendKeyUpEvent(LogicalKeyboardKey.home, platform: _keyEventPlatform);
808+
Future<void> pressCmdHome({bool settle = true, int extraPumps = 0}) async {
809+
await sendKeyDownEvent(LogicalKeyboardKey.meta, platform: _keyEventPlatform);
810+
await sendKeyDownEvent(LogicalKeyboardKey.home, platform: _keyEventPlatform);
811+
await sendKeyUpEvent(LogicalKeyboardKey.meta, platform: _keyEventPlatform);
812+
await sendKeyUpEvent(LogicalKeyboardKey.home, platform: _keyEventPlatform);
748813

749814
await _maybeSettleOrExtraPumps(settle: settle, extraPumps: extraPumps);
750815
}
751816

752-
Future<void> pressCmdEnd(WidgetTester tester, {bool settle = true, int extraPumps = 0}) async {
753-
await tester.sendKeyDownEvent(LogicalKeyboardKey.meta, platform: _keyEventPlatform);
754-
await tester.sendKeyDownEvent(LogicalKeyboardKey.end, platform: _keyEventPlatform);
755-
await tester.sendKeyUpEvent(LogicalKeyboardKey.meta, platform: _keyEventPlatform);
756-
await tester.sendKeyUpEvent(LogicalKeyboardKey.end, platform: _keyEventPlatform);
817+
Future<void> pressCmdEnd({bool settle = true, int extraPumps = 0}) async {
818+
await sendKeyDownEvent(LogicalKeyboardKey.meta, platform: _keyEventPlatform);
819+
await sendKeyDownEvent(LogicalKeyboardKey.end, platform: _keyEventPlatform);
820+
await sendKeyUpEvent(LogicalKeyboardKey.meta, platform: _keyEventPlatform);
821+
await sendKeyUpEvent(LogicalKeyboardKey.end, platform: _keyEventPlatform);
757822

758823
await _maybeSettleOrExtraPumps(settle: settle, extraPumps: extraPumps);
759824
}
760825

761-
Future<void> pressCtrlHome(WidgetTester tester, {bool settle = true, int extraPumps = 0}) async {
762-
await tester.sendKeyDownEvent(LogicalKeyboardKey.control, platform: _keyEventPlatform);
763-
await tester.sendKeyDownEvent(LogicalKeyboardKey.home, platform: _keyEventPlatform);
764-
await tester.sendKeyUpEvent(LogicalKeyboardKey.control, platform: _keyEventPlatform);
765-
await tester.sendKeyUpEvent(LogicalKeyboardKey.home, platform: _keyEventPlatform);
826+
Future<void> pressCtrlHome({bool settle = true, int extraPumps = 0}) async {
827+
await sendKeyDownEvent(LogicalKeyboardKey.control, platform: _keyEventPlatform);
828+
await sendKeyDownEvent(LogicalKeyboardKey.home, platform: _keyEventPlatform);
829+
await sendKeyUpEvent(LogicalKeyboardKey.control, platform: _keyEventPlatform);
830+
await sendKeyUpEvent(LogicalKeyboardKey.home, platform: _keyEventPlatform);
766831

767832
await _maybeSettleOrExtraPumps(settle: settle, extraPumps: extraPumps);
768833
}
769834

770-
Future<void> pressCtrlEnd(WidgetTester tester, {bool settle = true, int extraPumps = 0}) async {
771-
await tester.sendKeyDownEvent(LogicalKeyboardKey.control, platform: _keyEventPlatform);
772-
await tester.sendKeyDownEvent(LogicalKeyboardKey.end, platform: _keyEventPlatform);
773-
await tester.sendKeyUpEvent(LogicalKeyboardKey.control, platform: _keyEventPlatform);
774-
await tester.sendKeyUpEvent(LogicalKeyboardKey.end, platform: _keyEventPlatform);
835+
Future<void> pressCtrlEnd({bool settle = true, int extraPumps = 0}) async {
836+
await sendKeyDownEvent(LogicalKeyboardKey.control, platform: _keyEventPlatform);
837+
await sendKeyDownEvent(LogicalKeyboardKey.end, platform: _keyEventPlatform);
838+
await sendKeyUpEvent(LogicalKeyboardKey.control, platform: _keyEventPlatform);
839+
await sendKeyUpEvent(LogicalKeyboardKey.end, platform: _keyEventPlatform);
775840

776841
await _maybeSettleOrExtraPumps(settle: settle, extraPumps: extraPumps);
777842
}
778843

779-
Future<void> pressCmdZ(WidgetTester tester, {bool settle = true, int extraPumps = 0}) async {
780-
await tester.sendKeyDownEvent(LogicalKeyboardKey.meta, platform: _keyEventPlatform);
781-
await tester.sendKeyDownEvent(LogicalKeyboardKey.keyZ, platform: _keyEventPlatform);
782-
await tester.sendKeyUpEvent(LogicalKeyboardKey.keyZ, platform: _keyEventPlatform);
783-
await tester.sendKeyUpEvent(LogicalKeyboardKey.meta, platform: _keyEventPlatform);
844+
Future<void> pressCmdZ({bool settle = true, int extraPumps = 0}) async {
845+
await sendKeyDownEvent(LogicalKeyboardKey.meta, platform: _keyEventPlatform);
846+
await sendKeyDownEvent(LogicalKeyboardKey.keyZ, platform: _keyEventPlatform);
847+
await sendKeyUpEvent(LogicalKeyboardKey.keyZ, platform: _keyEventPlatform);
848+
await sendKeyUpEvent(LogicalKeyboardKey.meta, platform: _keyEventPlatform);
784849

785850
await _maybeSettleOrExtraPumps(settle: settle, extraPumps: extraPumps);
786851
}
787852

788-
Future<void> pressCtrlZ(WidgetTester tester, {bool settle = true, int extraPumps = 0}) async {
789-
await tester.sendKeyDownEvent(LogicalKeyboardKey.control, platform: _keyEventPlatform);
790-
await tester.sendKeyDownEvent(LogicalKeyboardKey.keyZ, platform: _keyEventPlatform);
791-
await tester.sendKeyUpEvent(LogicalKeyboardKey.keyZ, platform: _keyEventPlatform);
792-
await tester.sendKeyUpEvent(LogicalKeyboardKey.control, platform: _keyEventPlatform);
853+
Future<void> pressCtrlZ({bool settle = true, int extraPumps = 0}) async {
854+
await sendKeyDownEvent(LogicalKeyboardKey.control, platform: _keyEventPlatform);
855+
await sendKeyDownEvent(LogicalKeyboardKey.keyZ, platform: _keyEventPlatform);
856+
await sendKeyUpEvent(LogicalKeyboardKey.keyZ, platform: _keyEventPlatform);
857+
await sendKeyUpEvent(LogicalKeyboardKey.control, platform: _keyEventPlatform);
793858

794859
await _maybeSettleOrExtraPumps(settle: settle, extraPumps: extraPumps);
795860
}
796861

797-
Future<void> pressCmdShiftZ(WidgetTester tester, {bool settle = true, int extraPumps = 0}) async {
798-
await tester.sendKeyDownEvent(LogicalKeyboardKey.meta, platform: _keyEventPlatform);
799-
await tester.sendKeyDownEvent(LogicalKeyboardKey.shift, platform: _keyEventPlatform);
800-
await tester.sendKeyDownEvent(LogicalKeyboardKey.keyZ, platform: _keyEventPlatform);
801-
await tester.sendKeyUpEvent(LogicalKeyboardKey.keyZ, platform: _keyEventPlatform);
802-
await tester.sendKeyUpEvent(LogicalKeyboardKey.shift, platform: _keyEventPlatform);
803-
await tester.sendKeyUpEvent(LogicalKeyboardKey.meta, platform: _keyEventPlatform);
862+
Future<void> pressCmdShiftZ({bool settle = true, int extraPumps = 0}) async {
863+
await sendKeyDownEvent(LogicalKeyboardKey.meta, platform: _keyEventPlatform);
864+
await sendKeyDownEvent(LogicalKeyboardKey.shift, platform: _keyEventPlatform);
865+
await sendKeyDownEvent(LogicalKeyboardKey.keyZ, platform: _keyEventPlatform);
866+
await sendKeyUpEvent(LogicalKeyboardKey.keyZ, platform: _keyEventPlatform);
867+
await sendKeyUpEvent(LogicalKeyboardKey.shift, platform: _keyEventPlatform);
868+
await sendKeyUpEvent(LogicalKeyboardKey.meta, platform: _keyEventPlatform);
804869

805870
await _maybeSettleOrExtraPumps(settle: settle, extraPumps: extraPumps);
806871
}
807872

808-
Future<void> pressCtrlShiftZ(WidgetTester tester, {bool settle = true, int extraPumps = 0}) async {
809-
await tester.sendKeyDownEvent(LogicalKeyboardKey.control, platform: _keyEventPlatform);
810-
await tester.sendKeyDownEvent(LogicalKeyboardKey.shift, platform: _keyEventPlatform);
811-
await tester.sendKeyDownEvent(LogicalKeyboardKey.keyZ, platform: _keyEventPlatform);
812-
await tester.sendKeyUpEvent(LogicalKeyboardKey.keyZ, platform: _keyEventPlatform);
813-
await tester.sendKeyUpEvent(LogicalKeyboardKey.shift, platform: _keyEventPlatform);
814-
await tester.sendKeyUpEvent(LogicalKeyboardKey.control, platform: _keyEventPlatform);
873+
Future<void> pressCtrlShiftZ({bool settle = true, int extraPumps = 0}) async {
874+
await sendKeyDownEvent(LogicalKeyboardKey.control, platform: _keyEventPlatform);
875+
await sendKeyDownEvent(LogicalKeyboardKey.shift, platform: _keyEventPlatform);
876+
await sendKeyDownEvent(LogicalKeyboardKey.keyZ, platform: _keyEventPlatform);
877+
await sendKeyUpEvent(LogicalKeyboardKey.keyZ, platform: _keyEventPlatform);
878+
await sendKeyUpEvent(LogicalKeyboardKey.shift, platform: _keyEventPlatform);
879+
await sendKeyUpEvent(LogicalKeyboardKey.control, platform: _keyEventPlatform);
815880

816881
await _maybeSettleOrExtraPumps(settle: settle, extraPumps: extraPumps);
817882
}

0 commit comments

Comments
 (0)