-
Notifications
You must be signed in to change notification settings - Fork 1k
Expand file tree
/
Copy pathhelp.feature
More file actions
1426 lines (1248 loc) · 41.1 KB
/
help.feature
File metadata and controls
1426 lines (1248 loc) · 41.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
Feature: Get help about WP-CLI commands
Scenario: Help for internal commands
Given an empty directory
When I run `wp help`
Then STDOUT should contain:
"""
Run 'wp help <command>' to get more information on a specific command.
"""
And STDOUT should contain:
"""
https://make.wordpress.org/cli/handbook/
"""
And STDERR should be empty
When I run `wp help core`
Then STDOUT should contain:
"""
wp core
"""
And STDOUT should not contain:
"""
https://make.wordpress.org/cli/handbook/
"""
And STDERR should be empty
When I run `wp help core download`
Then STDOUT should contain:
"""
wp core download
"""
And STDERR should be empty
When I run `wp help help`
Then STDOUT should contain:
"""
wp help
"""
And STDERR should be empty
When I run `wp help help`
Then STDOUT should contain:
"""
GLOBAL PARAMETERS
"""
And STDERR should be empty
When I run `wp post list --post_type=post --posts_per_page=5 --help`
Then STDOUT should contain:
"""
wp post list
"""
And STDERR should be empty
When I run `wp post list --post_type=post --posts_per_page=5 --help --prompt`
Then STDOUT should contain:
"""
wp post list
"""
And STDERR should be empty
Scenario: Include when the command is run if a non-standard hook.
Given an empty directory
When I run `COLUMNS=80 wp help db`
Then STDOUT should contain:
"""
Unless overridden, these commands run on the 'after_wp_config_load' hook,
after wp-config.php has been loaded into scope.
"""
When I run `COLUMNS=150 wp help db check`
Then STDOUT should contain:
"""
This command runs on the 'after_wp_config_load' hook, after wp-config.php has been loaded into scope.
"""
When I run `COLUMNS=150 wp help db size`
Then STDOUT should not contain:
"""
This command runs on the
"""
Scenario: Hide Global parameters when requested
Given an empty directory
When I run `wp help`
Then STDOUT should contain:
"""
GLOBAL PARAMETERS
"""
And STDOUT should contain:
"""
--path
"""
And STDOUT should contain:
"""
Path to the WordPress files.
"""
When I run `WP_CLI_SUPPRESS_GLOBAL_PARAMS=true wp help`
Then STDOUT should not contain:
"""
GLOBAL PARAMETERS
"""
And STDOUT should not contain:
"""
--path
"""
And STDOUT should not contain:
"""
Path to the WordPress files.
"""
When I run `WP_CLI_SUPPRESS_GLOBAL_PARAMS=false wp help`
Then STDOUT should contain:
"""
GLOBAL PARAMETERS
"""
And STDOUT should contain:
"""
--path
"""
And STDOUT should contain:
"""
Path to the WordPress files.
"""
Scenario: Help for internal commands with WP
Given a WP installation
# TODO: Throwing deprecations with PHP 8.1+ and WP < 5.9
When I try `wp help`
Then STDOUT should contain:
"""
Run 'wp help <command>' to get more information on a specific command.
"""
# TODO: Throwing deprecations with PHP 8.1+ and WP < 5.9
When I try `wp help core`
Then STDOUT should contain:
"""
wp core
"""
# TODO: Throwing deprecations with PHP 8.1+ and WP < 5.9
When I try `wp help core download`
Then STDOUT should contain:
"""
wp core download
"""
# TODO: Throwing deprecations with PHP 8.1+ and WP < 5.9
When I try `wp help help`
Then STDOUT should contain:
"""
wp help
"""
# TODO: Throwing deprecations with PHP 8.1+ and WP < 5.9
When I try `wp help help`
Then STDOUT should contain:
"""
GLOBAL PARAMETERS
"""
Scenario: Help when WordPress is downloaded but not installed
Given an empty directory
When I run `wp core download`
And I run `wp help config create`
Then STDOUT should contain:
"""
wp config create
"""
And STDERR should be empty
When I run `wp config create {CORE_CONFIG_SETTINGS} --skip-check`
And I run `wp help core install`
Then STDOUT should contain:
"""
wp core install
"""
And STDERR should be empty
When I run `wp help core is-installed`
Then STDOUT should contain:
"""
wp core is-installed
"""
And STDERR should be empty
# TODO: Throwing deprecations with PHP 8.1+ and WP < 5.9
When I try `wp help core`
Then STDOUT should contain:
"""
wp core
"""
# TODO: Throwing deprecations with PHP 8.1+ and WP < 5.9
When I try `wp help config`
Then STDOUT should contain:
"""
wp config
"""
# TODO: Throwing deprecations with PHP 8.1+ and WP < 5.9
When I try `wp help db`
Then STDOUT should contain:
"""
wp db
"""
When I try `wp help non-existent-command`
Then the return code should be 1
And STDERR should contain:
"""
Error establishing a database connection
"""
And STDERR should contain:
"""
Error: 'non-existent-command' is not a registered wp command. See 'wp help' for available commands.
"""
And STDOUT should be empty
Scenario: Help for nonexistent commands
Given a WP installation
When I try `wp help non-existent-command`
Then the return code should be 1
And STDERR should contain:
"""
Error: 'non-existent-command' is not a registered wp command. See 'wp help' for available commands.
"""
And STDOUT should be empty
When I try `wp help non-existent-command --path=/nowhere`
Then the return code should be 1
And STDERR should contain:
"""
Warning: No WordPress installation found. If the command 'non-existent-command' is in a plugin or theme, pass --path=`path/to/wordpress`.
Error: 'non-existent-command' is not a registered wp command. See 'wp help' for available commands.
"""
And STDOUT should be empty
When I try `wp help non-existent-command non-existent-subcommand`
Then the return code should be 1
And STDERR should contain:
"""
Error: 'non-existent-command' is not a registered wp command. See 'wp help' for available commands.
"""
And STDOUT should be empty
When I try `wp help non-existent-command non-existent-subcommand --path=/nowhere`
Then the return code should be 1
And STDERR should contain:
"""
Warning: No WordPress installation found. If the command 'non-existent-command non-existent-subcommand' is in a plugin or theme, pass --path=`path/to/wordpress`.
Error: 'non-existent-command' is not a registered wp command. See 'wp help' for available commands.
"""
And STDOUT should be empty
Scenario: Help for nonexistent commands without a WP installation
Given an empty directory
When I try `wp help non-existent-command`
Then the return code should be 1
And STDERR should contain:
"""
Warning: No WordPress installation found. If the command 'non-existent-command' is in a plugin or theme, pass --path=`path/to/wordpress`.
Error: 'non-existent-command' is not a registered wp command. See 'wp help' for available commands.
"""
And STDOUT should be empty
Scenario: Help for specially treated commands with nonexistent subcommands
Given a WP installation
When I try `wp help config non-existent-subcommand`
Then the return code should be 1
And STDERR should contain:
"""
Error: 'non-existent-subcommand' is not a registered subcommand of 'config'. See 'wp help config' for available subcommands.
"""
And STDOUT should be empty
When I try `wp help config non-existent-subcommand --path=/nowhere`
Then the return code should be 1
And STDERR should contain:
"""
Warning: No WordPress installation found. If the command 'config non-existent-subcommand' is in a plugin or theme, pass --path=`path/to/wordpress`.
Error: 'non-existent-subcommand' is not a registered subcommand of 'config'. See 'wp help config' for available subcommands.
"""
And STDOUT should be empty
When I try `wp help core non-existent-subcommand`
Then the return code should be 1
And STDERR should contain:
"""
Error: 'non-existent-subcommand' is not a registered subcommand of 'core'. See 'wp help core' for available subcommands.
"""
And STDOUT should be empty
When I try `wp help core non-existent-subcommand --path=/nowhere`
Then the return code should be 1
And STDERR should contain:
"""
Warning: No WordPress installation found. If the command 'core non-existent-subcommand' is in a plugin or theme, pass --path=`path/to/wordpress`.
Error: 'non-existent-subcommand' is not a registered subcommand of 'core'. See 'wp help core' for available subcommands.
"""
And STDOUT should be empty
When I try `wp help db non-existent-subcommand`
Then the return code should be 1
And STDERR should contain:
"""
Error: 'non-existent-subcommand' is not a registered subcommand of 'db'. See 'wp help db' for available subcommands.
"""
And STDOUT should be empty
When I try `wp help db non-existent-subcommand --path=/nowhere`
Then the return code should be 1
And STDERR should contain:
"""
Warning: No WordPress installation found. If the command 'db non-existent-subcommand' is in a plugin or theme, pass --path=`path/to/wordpress`.
Error: 'non-existent-subcommand' is not a registered subcommand of 'db'. See 'wp help db' for available subcommands.
"""
And STDOUT should be empty
Scenario: Suggestions for command typos in help
Given an empty directory
And a session_no file:
"""
n
"""
And a session_yes file:
"""
y
"""
When I try `wp help confi < session_no`
Then STDERR should contain:
"""
Warning: 'confi' is not a registered wp command. See 'wp help' for available commands.
"""
And STDERR should not contain:
"""
Warning: No WordPress installation found. If the command 'confi' is in a plugin or theme, pass --path=`path/to/wordpress`.
"""
And STDOUT should contain:
"""
Did you mean 'config'? [y/n]
"""
And STDOUT should not contain:
"""
SYNOPSIS
"""
And the return code should be 0
When I try `wp help confi < session_yes`
Then STDERR should contain:
"""
Warning: 'confi' is not a registered wp command. See 'wp help' for available commands.
"""
And STDERR should not contain:
"""
No WordPress installation found.
"""
And STDOUT should contain:
"""
Did you mean 'config'? [y/n]
"""
And STDOUT should contain:
"""
SYNOPSIS
"""
And STDOUT should contain:
"""
wp config <command>
"""
And the return code should be 0
When I try `wp help cor < session_yes`
Then STDERR should contain:
"""
Warning: 'cor' is not a registered wp command. See 'wp help' for available commands.
"""
And STDERR should not contain:
"""
No WordPress installation found.
"""
And STDOUT should contain:
"""
Did you mean 'core'? [y/n]
"""
And STDOUT should contain:
"""
SYNOPSIS
"""
And STDOUT should contain:
"""
wp core <command>
"""
And the return code should be 0
When I try `wp help d < session_yes`
Then STDERR should contain:
"""
Warning: 'd' is not a registered wp command. See 'wp help' for available commands.
"""
And STDERR should not contain:
"""
No WordPress installation found.
"""
And STDOUT should contain:
"""
Did you mean 'db'? [y/n]
"""
And STDOUT should contain:
"""
SYNOPSIS
"""
And STDOUT should contain:
"""
wp db <command>
"""
And the return code should be 0
When I try `wp help packag < session_yes`
Then STDERR should contain:
"""
Warning: 'packag' is not a registered wp command. See 'wp help' for available commands.
"""
And STDERR should not contain:
"""
No WordPress installation found.
"""
And STDOUT should contain:
"""
Did you mean 'package'? [y/n]
"""
And STDOUT should contain:
"""
SYNOPSIS
"""
And STDOUT should contain:
"""
wp package <command>
"""
And the return code should be 0
Scenario: Suggestions for subcommand typos in help of specially treated commands
Given an empty directory
And a session_no file:
"""
n
"""
And a session_yes file:
"""
y
"""
When I try `wp help config creat < session_no`
Then STDERR should contain:
"""
Warning: 'creat' is not a registered subcommand of 'config'. See 'wp help config' for available subcommands.
"""
And STDERR should not contain:
"""
No WordPress installation found.
"""
And STDOUT should contain:
"""
Did you mean 'create'? [y/n]
"""
And STDOUT should not contain:
"""
SYNOPSIS
"""
And the return code should be 0
When I try `wp help config creat < session_yes`
Then STDERR should contain:
"""
Warning: 'creat' is not a registered subcommand of 'config'. See 'wp help config' for available subcommands.
"""
And STDERR should not contain:
"""
No WordPress installation found.
"""
And STDOUT should contain:
"""
Did you mean 'create'? [y/n]
"""
And STDOUT should contain:
"""
SYNOPSIS
"""
And STDOUT should contain:
"""
wp config create
"""
And the return code should be 0
When I try `wp help core versio < session_yes`
Then STDERR should contain:
"""
Warning: 'versio' is not a registered subcommand of 'core'. See 'wp help core' for available subcommands.
"""
And STDERR should not contain:
"""
No WordPress installation found.
"""
And STDOUT should contain:
"""
Did you mean 'version'? [y/n]
"""
And STDOUT should contain:
"""
SYNOPSIS
"""
And STDOUT should contain:
"""
wp core version
"""
And the return code should be 0
When I try `wp help core versio < session_yes`
Then STDERR should contain:
"""
Warning: 'versio' is not a registered subcommand of 'core'. See 'wp help core' for available subcommands.
"""
And STDERR should not contain:
"""
No WordPress installation found.
"""
And STDOUT should contain:
"""
Did you mean 'version'? [y/n]
"""
And STDOUT should contain:
"""
SYNOPSIS
"""
And STDOUT should contain:
"""
wp core version
"""
And the return code should be 0
When I try `wp help db chec < session_yes`
Then STDERR should contain:
"""
Warning: 'chec' is not a registered subcommand of 'db'. See 'wp help db' for available subcommands.
"""
And STDERR should not contain:
"""
No WordPress installation found.
"""
And STDOUT should contain:
"""
Did you mean 'check'? [y/n]
"""
And STDOUT should contain:
"""
SYNOPSIS
"""
And STDOUT should contain:
"""
wp db check
"""
And the return code should be 0
Scenario: Suggestions for chained command typos in help
Given a WP installation
And a session_yes_yes file:
"""
y
y
"""
When I try `wp hel post seta < session_yes_yes`
Then STDERR should contain:
"""
Warning: 'hel' is not a registered wp command. See 'wp help' for available commands.
"""
And STDOUT should contain:
"""
Did you mean 'help'? [y/n]
"""
And STDERR should contain:
"""
Warning: 'seta' is not a registered subcommand of 'post'. See 'wp help post' for available subcommands.
"""
And STDOUT should contain:
"""
Did you mean 'meta'? [y/n]
"""
And STDOUT should contain:
"""
wp post meta <command>
"""
And the return code should be 0
Scenario: No WordPress installation warning or suggestions for disabled commands
Given an empty directory
And a wp-cli.yml file:
"""
disabled_commands:
db
"""
When I try `wp help db`
Then the return code should be 1
And STDERR should be:
"""
Error: The 'db' command has been disabled from the config file.
"""
And STDOUT should be empty
When I try `wp help db chec`
Then the return code should be 1
And STDERR should be:
"""
Error: The 'db' command has been disabled from the config file.
"""
And STDOUT should be empty
Scenario: Help for third-party commands
Given a WP installation
And a wp-content/plugins/test-cli/command.php file:
"""
<?php
// Plugin Name: Test CLI Help
class Test_Help extends WP_CLI_Command {
/**
* A dummy command.
*/
function __invoke() {}
}
WP_CLI::add_command( 'test-help', 'Test_Help' );
"""
And I run `wp plugin activate test-cli`
# TODO: Throwing deprecations with PHP 8.1+ and WP < 5.9
When I try `wp help`
Then STDOUT should contain:
"""
A dummy command.
"""
# TODO: Throwing deprecations with PHP 8.1+ and WP < 5.9
When I try `wp help test-help`
Then STDOUT should contain:
"""
wp test-help
"""
Scenario: Help for incomplete commands
Given an empty directory
When I run `wp core`
Then STDOUT should contain:
"""
usage: wp core
"""
Scenario: Help for commands with magic methods
Given a WP installation
And a wp-content/plugins/test-cli/command.php file:
"""
<?php
// Plugin Name: Test CLI Help
class Test_Magic_Methods extends WP_CLI_Command {
/**
* A dummy command.
*
* @subcommand my-command
*/
function my_command() {}
/**
* Magic methods should not appear as commands
*/
function __construct() {}
function __destruct() {}
function __call( $name, $arguments ) {}
function __get( $key ) {}
function __set( $key, $value ) {}
function __isset( $key ) {}
function __unset( $key ) {}
function __sleep() {}
function __wakeup() {}
function __toString() {}
static function __set_state( $properties ) {}
function __clone() {}
function __debugInfo() {}
}
WP_CLI::add_command( 'test-magic-methods', 'Test_Magic_Methods' );
"""
And I run `wp plugin activate test-cli`
When I run `wp test-magic-methods`
Then STDOUT should contain:
"""
usage: wp test-magic-methods my-command
"""
And STDOUT should not contain:
"""
__destruct
"""
Scenario: Help for commands loaded into existing namespaces
Given a WP installation
And a wp-content/plugins/test-cli/command.php file:
"""
<?php
// Plugin Name: Test CLI Extra Site Command
class Test_CLI_Extra_Site_Command extends WP_CLI_Command {
/**
* A dummy command.
*
* @subcommand my-command
*/
function my_command() {}
}
WP_CLI::add_command( 'site test-extra', 'Test_CLI_Extra_Site_Command' );
"""
And I run `wp plugin activate test-cli`
# TODO: Throwing deprecations with PHP 8.1+ and WP < 5.9
When I try `wp help site`
Then STDOUT should contain:
"""
test-extra
"""
Given a wp-content/plugins/test-cli/command.php file:
"""
<?php
// Plugin Name: Test CLI Extra Command
class Test_CLI_Extra_Command extends WP_CLI_Command {
/**
* A dummy command.
*
* @subcommand my-command
*/
function my_command() {}
}
WP_CLI::add_command( 'config test-extra-config', 'Test_CLI_Extra_Command' );
WP_CLI::add_command( 'core test-extra-core', 'Test_CLI_Extra_Command' );
WP_CLI::add_command( 'db test-extra-db', 'Test_CLI_Extra_Command' );
"""
# TODO: Throwing deprecations with PHP 8.1+ and WP < 5.9
When I try `wp help config`
Then STDOUT should contain:
"""
test-extra-config
"""
# TODO: Throwing deprecations with PHP 8.1+ and WP < 5.9
When I try `wp help core`
Then STDOUT should contain:
"""
test-extra-core
"""
# TODO: Throwing deprecations with PHP 8.1+ and WP < 5.9
When I try `wp help db`
Then STDOUT should contain:
"""
test-extra-db
"""
Scenario: Help renders global parameters correctly
Given a WP installation
# TODO: Throwing deprecations with PHP 8.1+ and WP < 5.9
When I try `wp help core`
Then STDOUT should contain:
"""
GLOBAL PARAMETERS
"""
And STDOUT should not contain:
"""
## GLOBAL PARAMETERS
"""
# TODO: Throwing deprecations with PHP 8.1+ and WP < 5.9
When I try `wp help option get`
Then STDOUT should contain:
"""
GLOBAL PARAMETERS
"""
And STDOUT should not contain:
"""
## GLOBAL PARAMETERS
"""
# TODO: Throwing deprecations with PHP 8.1+ and WP < 5.9
When I try `wp help option`
Then STDOUT should contain:
"""
GLOBAL PARAMETERS
"""
And STDOUT should not contain:
"""
## GLOBAL PARAMETERS
"""
Scenario: Display alias in man page
Given a WP installation
When I run `wp help plugin update`
Then STDOUT should contain:
"""
ALIAS
upgrade
"""
When I run `wp help plugin install`
Then STDOUT should not contain:
"""
ALIAS
"""
Scenario: Help for commands should wordwrap well
Given a WP installation
And a wp-content/plugins/test-cli/command.php file:
"""
<?php
// Plugin Name: Test CLI Help
class Test_Wordwrap extends WP_CLI_Command {
/**
* 123456789 123456789 123456789 123456789 123456789 123456789 123456789 12345678
*
* ## OPTIONS
*
* [--skip-delete]
* : Skip deletion of the original thumbnails. If your thumbnails are linked from sources outside your control, it's likely best to leave them around. Defaults to false.
*
* [--eighty=<four initial spaces>]
* : 123456789 123456789 123456789 123456789 123456789 123456789 123456789 123456
*
* [--eighty-one=<four initial spaces>]
* : 123456789 123456789 123456789 123456789 123456789 123456789 123456789 1234567
*
* [--forty=<four initial spaces>]
* : 123456789 123456789 123456789 123456
*
* [--forty-one=<four initial spaces>]
* : 123456789 123456789 123456789 1234567
*
* ## EXAMPLES
*
* # Re-generate only the thumbnails of "large" image size for all images.
* $ wp media regenerate --image_size=large
* Do you really want to regenerate the "large" image size for all images? [y/n] y
* Found 3 images to regenerate.
* 1/3 Regenerated "large" thumbnail for "Yoogest Image Ever, Really" (ID 9999).
* 2/3 No "large" thumbnail regeneration needed for "Snowflake" (ID 9998).
* 3/3 Regenerated "large" thumbnail for "Even Yooger than the Yoogest Image Ever, Really" (ID 9997).
* Success: Regenerated 3 of 3 images.
*
* # 6 initial spaces + 74 = 80; 6 + 75 = 81
* # 123456789 123456789 123456789 123456789 123456789 123456789 123456789 1234
* # 123456789 123456789 123456789 123456789 123456789 123456789 123456789 12345
*
* # 6 initial spaces + 34 = 40; 6 + 35 = 41
* # 123456789 123456789 123456789 1234
* # 123456789 123456789 123456789 12345
*
*/
function my_command() {}
}
WP_CLI::add_command( 'test-wordwrap', 'Test_Wordwrap' );
"""
And I run `wp plugin activate test-cli`
# TODO: Throwing deprecations with PHP 8.1+ and WP < 5.9
When I try `COLUMNS=80 wp help test-wordwrap my_command`
Then STDOUT should contain:
"""
123456789 123456789 123456789 123456789 123456789 123456789 123456789 12345678
"""
And STDOUT should contain:
"""
[--skip-delete]
Skip deletion of the original thumbnails. If your thumbnails are linked from
sources outside your control, it's likely best to leave them around.
Defaults to false.
"""
And STDOUT should contain:
"""
[--eighty=<four initial spaces>]
123456789 123456789 123456789 123456789 123456789 123456789 123456789 123456
"""
And STDOUT should contain:
"""
[--eighty-one=<four initial spaces>]
123456789 123456789 123456789 123456789 123456789 123456789 123456789
1234567
"""
And STDOUT should contain:
"""
# Re-generate only the thumbnails of "large" image size for all images.
$ wp media regenerate --image_size=large
Do you really want to regenerate the "large" image size for all images?
[y/n] y
Found 3 images to regenerate.
1/3 Regenerated "large" thumbnail for "Yoogest Image Ever, Really" (ID
9999).
2/3 No "large" thumbnail regeneration needed for "Snowflake" (ID 9998).
3/3 Regenerated "large" thumbnail for "Even Yooger than the Yoogest Image
Ever, Really" (ID 9997).
Success: Regenerated 3 of 3 images.
"""
And STDOUT should contain:
"""
# 123456789 123456789 123456789 123456789 123456789 123456789 123456789 1234
# 123456789 123456789 123456789 123456789 123456789 123456789 123456789
12345
"""
And STDOUT should contain:
"""
--url=<url>
Pretend request came from given URL. In multisite, this argument is how
the target site is specified.
"""
# TODO: Throwing deprecations with PHP 8.1+ and WP < 5.9
When I try `COLUMNS=80 wp help test-wordwrap my_command | awk '{print length, $0}' | sort -nr | head -1 | cut -f1 -d" "`
Then STDOUT should be:
"""
80
"""
# TODO: Throwing deprecations with PHP 8.1+ and WP < 5.9
When I try `TERM=vt100 COLUMNS=40 wp help test-wordwrap my_command`
Then STDOUT should contain:
"""
123456789 123456789 123456789
123456789 123456789 123456789
123456789 12345678
"""
And STDOUT should contain:
"""
[--skip-delete]
Skip deletion of the original
thumbnails. If your thumbnails are
linked from sources outside your
control, it's likely best to leave
them around. Defaults to false.
"""
And STDOUT should contain:
"""
[--forty=<four initial spaces>]
123456789 123456789 123456789 123456
"""
And STDOUT should contain:
"""
[--forty-one=<four initial spaces>]
123456789 123456789 123456789
1234567
"""
And STDOUT should contain:
"""
# Re-generate only the thumbnails of