-
Notifications
You must be signed in to change notification settings - Fork 29.9k
/
index.d.ts
1212 lines (1088 loc) · 43.3 KB
/
index.d.ts
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
/// <reference types="node"/>
import child = require("child_process");
import glob = require("glob");
/**
* Changes the current working directory dir for the duration of the script.
* Changes to the home directory if no argument is supplied.
*
* @param dir Directory to change to.
* @return Object with shell exit code, stderr and stdout.
*/
export function cd(dir?: string): ShellString;
/**
* Returns the current directory.
* @return The current directory.
*/
export function pwd(): ShellString;
export interface ListFunction {
/**
* Returns array of files in the given path, or in current directory if no path provided.
*
* @param options Available options:
* - `-R`: recursive
* - `-A`: all files (include files beginning with ., except for . and ..)
* - `-L`: follow symlinks
* - `-d`: list directories themselves, not their contents
* - `-l`: list objects representing each file, each with fields containing
* `ls -l` output fields. See fs.Stats for more info
* @param paths Paths to search.
* @return An array of files in the given path(s).
*/
(options: string, paths: string[]): ShellArray;
(options: string, ...paths: string[]): ShellArray;
/**
* Returns array of files in the given path, or in current directory if no path provided.
*
* @param paths Paths to search.
* @return An array of files in the given path(s).
*/
(paths: string[]): ShellArray;
(...paths: string[]): ShellArray;
}
/**
* Returns array of files in the given path, or in current directory if no path provided.
*
* @param options Available options:
* - `-R`: recursive
* - `-A`: all files (include files beginning with ., except for . and ..)
* - `-L`: follow symlinks
* - `-d`: list directories themselves, not their contents
* - `-l`: list objects representing each file, each with fields containing
* `ls -l` output fields. See fs.Stats for more info
* @param paths Paths to search.
* @return An array of files in the given path(s).
*/
export const ls: ListFunction;
export interface FindFunction {
/**
* Returns array of all files (however deep) in the given paths.
*
* @param path The path(s) to search.
* @return An array of all files (however deep) in the given path(s).
*/
(path: string[]): ShellArray;
(...path: string[]): ShellArray;
}
/**
* Returns array of all files (however deep) in the given paths.
*
* @param path The path(s) to search.
* @return An array of all files (however deep) in the given path(s).
*/
export const find: FindFunction;
export interface CopyFunction {
/**
* Copies files. The wildcard `*` is accepted.
*
* @param options Available options:
* - `-f`: force (default behavior)
* - `-n`: no-clobber
* - `-u`: only copy if source is newer than dest
* - `-r`, `-R`: recursive
* - `-L`: follow symlinks
* - `-P`: don't follow symlinks
* @param source The source.
* @param dest The destination.
* @return Object with shell exit code, stderr and stdout.
*/
(options: string, source: string | string[], dest: string): ShellString;
/**
* Copies files. The wildcard `*` is accepted.
*
* @param source The source.
* @param dest The destination.
* @return Object with shell exit code, stderr and stdout.
*/
(source: string | string[], dest: string): ShellString;
}
/**
* Copies files. The wildcard `*` is accepted.
*
* @param options Available options:
* - `-f`: force (default behavior)
* - `-n`: no-clobber
* - `-u`: only copy if source is newer than dest
* - `-r`, -R: recursive
* - `-L`: follow symlinks
* - `-P`: don't follow symlinks
* @param source The source.
* @param dest The destination.
* @return Object with shell exit code, stderr and stdout.
*/
export const cp: CopyFunction;
export interface RemoveFunction {
/**
* Removes files. The wildcard `*` is accepted.
*
* @param options Available options:
* - `-f`: force
* - `-r`, `-R`: recursive
* @param files Files to remove.
* @return Object with shell exit code, stderr and stdout.
*/
(options: string, files: string[]): ShellString;
(options: string, ...files: string[]): ShellString;
/**
* Removes files. The wildcard `*` is accepted.
*
* @param files Files to remove.
* @return Object with shell exit code, stderr and stdout.
*/
(files: string[]): ShellString;
(...files: string[]): ShellString;
}
/**
* Removes files. The wildcard `*` is accepted.
*
* @param options Available options:
* - `-f` (force),
* - `-r`, `-R` (recursive)
* @param files Files to remove.
* @return Object with shell exit code, stderr and stdout.
*/
export const rm: RemoveFunction;
export interface MoveFunction {
/**
* Moves files. The wildcard `*` is accepted.
*
* @param options Available options:
* - `-f`: force (default behavior)
* - `-n`: no-clobber
* @param source The source.
* @param dest The destination.
* @return Object with shell exit code, stderr and stdout.
*/
(options: string, source: string | string[], dest: string): ShellString;
/**
* Moves files. The wildcard `*` is accepted.
*
* @param source The source.
* @param dest The destination.
* @return Object with shell exit code, stderr and stdout.
*/
(source: string | string[], dest: string): ShellString;
}
/**
* Moves files. The wildcard `*` is accepted.
*
* @param options Available options:
* - `-f`: force (default behavior)
* - `-n`: no-clobber
* @param source The source.
* @param dest The destination.
* @return Object with shell exit code, stderr and stdout.
*/
export const mv: MoveFunction;
export interface MkdirFunction {
/**
* Creates directories.
*
* @param options Available options:
* - `-p`: full paths, will create intermediate dirs if necessary
* @param dir The directories to create.
* @return Object with shell exit code, stderr and stdout.
*/
(options: string, dir: string[]): ShellString;
(options: string, ...dir: string[]): ShellString;
/**
* Creates directories.
*
* @param dir Directories to create.
* @return Object with shell exit code, stderr and stdout.
*/
(dir: string[]): ShellString;
(...dir: string[]): ShellString;
}
/**
* Creates directories.
*
* @param options Available options:
* - `-p`: full paths, will create intermediate dirs if necessary
* @param dir The directories to create.
* @return Object with shell exit code, stderr and stdout.
*/
export const mkdir: MkdirFunction;
/**
* Evaluates expression using the available primaries and returns corresponding value.
*
* @param option Valid options:
* - `-b`: true if path is a block device;
* - `-c`: true if path is a character device;
* - `-d`: true if path is a directory;
* - `-e`: true if path exists;
* - `-f`: true if path is a regular file;
* - `-L`: true if path is a symbolic link;
* - `-p`: true if path is a pipe (FIFO);
* - `-S`: true if path is a socket
* @param path The path.
* @return See option parameter.
*/
export function test(option: TestOptions, path: string): boolean;
export type TestOptions = "-b" | "-c" | "-d" | "-e" | "-f" | "-L" | "-p" | "-S";
export interface CatFunction {
/**
* Returns a string containing the given file, or a concatenated string
* containing the files if more than one file is given (a new line character
* is introduced between each file).
*
* @param files Files to use. Wildcard `*` accepted.
* @return A string containing the given file, or a concatenated string
* containing the files if more than one file is given
* (a new line character is introduced between each file).
*/
(files: string[]): ShellString;
(...files: string[]): ShellString;
}
/**
* Returns a string containing the given file, or a concatenated string
* containing the files if more than one file is given (a new line character
* is introduced between each file).
*
* @param files Files to use. Wildcard `*` accepted.
* @return A string containing the given file, or a concatenated string
* containing the files if more than one file is given
* (a new line character is introduced between each file).
*/
export const cat: CatFunction;
export interface SedFunction {
/**
* Reads an input string from file and performs a JavaScript `replace()`
* on the input using the given search regex and replacement string or function.
*
* @param options Available options:
* - `-i`: Replace contents of 'file' in-place. Note that no backups will be created!
* @param searchRegex The regular expression to use for search.
* @param replacement The replacement.
* @param files The files to process.
* @return The new string after replacement.
*/
(options: string, searchRegex: string | RegExp, replacement: string, files: string[]): ShellString;
(options: string, searchRegex: string | RegExp, replacement: string, ...files: string[]): ShellString;
/**
* Reads an input string from file and performs a JavaScript `replace()`
* on the input using the given search regex and replacement string or function.
*
* @param searchRegex The regular expression to use for search.
* @param replacement The replacement.
* @param files The files to process.
* @return The new string after replacement.
*/
(searchRegex: string | RegExp, replacement: string, files: string[]): ShellString;
(searchRegex: string | RegExp, replacement: string, ...files: string[]): ShellString;
}
/**
* Reads an input string from file and performs a JavaScript `replace()`
* on the input using the given search regex and replacement string or function.
*
* @param options Available options:
* - `-i`: Replace contents of 'file' in-place. Note that no backups will be created!
* @param searchRegex The regular expression to use for search.
* @param replacement The replacement.
* @param files The files to process.
* @return The new string after replacement.
*/
export const sed: SedFunction;
export interface GrepFunction {
/**
* Reads input string from given files and returns a string containing all lines
* of the file that match the given `regex_filter`. Wildcard `*` accepted.
*
* @param options Available options:
* - `-v`: Inverse the sense of the regex and print
* the lines not matching the criteria.
* - `-l`: Print only filenames of matching files
* @param regex_filter The regular expression to use.
* @param files The files to process.
* @return Returns a string containing all lines of the file that match the given regex_filter.
*/
(options: string, regex_filter: string | RegExp, files: string[]): ShellString;
(options: string, regex_filter: string | RegExp, ...files: string[]): ShellString;
/**
* Reads input string from given files and returns a string containing all lines
* of the file that match the given `regex_filter`. Wildcard `*` accepted.
*
* @param regex_filter The regular expression to use.
* @param files The files to process.
* @return Returns a string containing all lines of the file that match the given `regex_filter`.
*/
(regex_filter: string | RegExp, files: string[]): ShellString;
(regex_filter: string | RegExp, ...files: string[]): ShellString;
}
/**
* Reads input string from given files and returns a string containing all lines
* of the file that match the given `regex_filter`. Wildcard `*` accepted.
*
* @param options Available options:
* - `-v`: Inverse the sense of the regex and print
* the lines not matching the criteria.
* - `-l`: Print only filenames of matching files
* @param regex_filter The regular expression to use.
* @param files The files to process.
* @return Returns a string containing all lines of the file that match the given `regex_filter`.
*/
export const grep: GrepFunction;
/**
* Searches for command in the system's PATH. On Windows looks for .exe, .cmd, and .bat extensions.
*
* @param command The command to search for.
* @return Returns string containing the absolute path to the command or `null` if it couldn't be found.
*/
export function which(command: string): ShellString | null;
export interface EchoFunction {
/**
* Prints string to stdout, and returns string with additional utility methods like .to().
*
* @param options Available options:
* - `-e`: interpret backslash escapes (default)
* - `-n`: remove trailing newline from output
* @param text The text to print.
* @return Returns the string that was passed as argument.
*/
(options: string, ...text: string[]): ShellString;
/**
* Prints string to stdout, and returns string with additional utility methods like .to().
*
* @param text The text to print.
* @return Returns the string that was passed as argument.
*/
(...text: string[]): ShellString;
}
/**
* Prints string to stdout, and returns string with additional utility methods like .to().
*
* @param options Available options:
* - `-e`: interpret backslash escapes (default)
* - `-n`: remove trailing newline from output
* @param text The text to print.
* @return Returns the string that was passed as argument.
*/
export const echo: EchoFunction;
export interface PushDirFunction {
/**
* Saves the current directory on the top of the directory stack and then cd to dir.
* With no arguments, `pushd` exchanges the top two directories.
*
* @param options Available options:
* - `-n`: Suppresses the normal change of directory when adding directories
* to the stack, so that only the stack is manipulated
* - `-q`: Suppresses output to the console.
* @param dir Brings the Nth directory (counting from the left of the list printed by dirs,
* starting with zero) to the top of the list by rotating the stack.
* @return Returns an array of paths in the stack.
*/
(options: string, dir: "+N"): ShellArray;
/**
* Saves the current directory on the top of the directory stack and then cd to dir.
* With no arguments, `pushd` exchanges the top two directories.
*
* @param options Available options:
* - `-n`: Suppresses the normal change of directory when adding directories
* to the stack, so that only the stack is manipulated
* - `-q`: Suppresses output to the console.
* @param dir Brings the Nth directory (counting from the right of the list printed by dirs,
* starting with zero) to the top of the list by rotating the stack.
* @return Returns an array of paths in the stack.
*/
(options: string, dir: "-N"): ShellArray;
/**
* Saves the current directory on the top of the directory stack and then cd to dir.
* With no arguments, `pushd` exchanges the top two directories.
*
* @param options Available options:
* - `-n`: Suppresses the normal change of directory when adding directories
* to the stack, so that only the stack is manipulated
* - `-q`: Suppresses output to the console.
* @param dir Makes the current working directory be the top of the stack,
* and then executes the equivalent of `cd dir`.
* @return Returns an array of paths in the stack.
*/
(options: string, dir: string): ShellArray;
/**
* Saves the current directory on the top of the directory stack and then cd to dir.
* With no arguments, `pushd` exchanges the top two directories.
*
* @param dir Brings the Nth directory (counting from the left of the list printed by dirs,
* starting with zero) to the top of the list by rotating the stack.
* @return Returns an array of paths in the stack.
*/
(dir: "+N"): ShellArray;
/**
* Saves the current directory on the top of the directory stack and then cd to dir.
* With no arguments, `pushd` exchanges the top two directories.
*
* @param dir Brings the Nth directory (counting from the right of the list printed by dirs,
* starting with zero) to the top of the list by rotating the stack.
* @return Returns an array of paths in the stack.
*/
(dir: "-N"): ShellArray;
/**
* Saves the current directory on the top of the directory stack and then cd to dir.
* With no arguments, `pushd` exchanges the top two directories.
*
* @param dir Makes the current working directory be the top of the stack,
* and then executes the equivalent of cd dir.
* @return Returns an array of paths in the stack.
*/
(dir: string): ShellArray;
/**
* Saves the current directory on the top of the directory stack and then cd to dir.
* With no arguments, `pushd` exchanges the top two directories.
*
* @return Returns an array of paths in the stack.
*/
(): ShellArray;
}
/**
* Saves the current directory on the top of the directory stack and then cd to dir.
* With no arguments, `pushd` exchanges the top two directories.
*
* @param options Available options:
* - `-n`: Suppresses the normal change of directory when adding directories
* to the stack, so that only the stack is manipulated
* - `-q`: Suppresses output to the console.
* @param dir Makes the current working directory be the top of the stack,
* and then executes the equivalent of `cd dir`.
* @return Returns an array of paths in the stack.
*/
export const pushd: PushDirFunction;
export interface PopDirFunction {
/**
* When no arguments are given, popd removes the top directory from the stack
* and performs a `cd` to the new top directory.
*
* The elements are numbered from 0 starting at the first directory listed with dirs;
* i.e., `popd` is equivalent to `popd +0`. Returns an array of paths in the stack.
*
* @param options Available options:
* - `-n`: Suppresses the normal change of directory when removing directories
* from the stack, so that only the stack is manipulated
* - `-q`: Suppresses output to the console.
* @param dir Removes the Nth directory (counting from the left of the list printed by dirs), starting with zero.
* @return Returns an array of paths in the stack.
*/
(options: string, dir: "+N"): ShellArray;
/**
* When no arguments are given, popd removes the top directory from the stack
* and performs a `cd` to the new top directory.
*
* The elements are numbered from 0 starting at the first directory listed with dirs;
* i.e., `popd` is equivalent to `popd +0`. Returns an array of paths in the stack.
*
* @param options Available options:
* - `-n`: Suppresses the normal change of directory when removing directories
* from the stack, so that only the stack is manipulated
* - `-q`: Suppresses output to the console.
* @param dir Removes the Nth directory (counting from the right of the list printed by dirs), starting with zero.
* @return Returns an array of paths in the stack.
*/
(options: string, dir: "-N"): ShellArray;
/**
* When no arguments are given, popd removes the top directory from the stack
* and performs a `cd` to the new top directory.
*
* The elements are numbered from 0 starting at the first directory listed with dirs;
* i.e., `popd` is equivalent to `popd +0`. Returns an array of paths in the stack.
*
* @param options Available options:
* - `-n`: Suppresses the normal change of directory when removing directories
* from the stack, so that only the stack is manipulated
* - `-q`: Suppresses output to the console.
* @param dir You can only use -N and +N.
* @return Returns an array of paths in the stack.
*/
(options: string, dir: string): ShellArray;
/**
* When no arguments are given, popd removes the top directory from the stack
* and performs a `cd` to the new top directory.
*
* The elements are numbered from 0 starting at the first directory listed with dirs;
* i.e., popd is equivalent to popd +0. Returns an array of paths in the stack.
*
* @param dir Removes the Nth directory (counting from the left of the list printed by dirs), starting with zero.
* @return Returns an array of paths in the stack.
*/
(dir: "+N"): ShellArray;
/**
* When no arguments are given, popd removes the top directory from the stack
* and performs a `cd` to the new top directory.
*
* The elements are numbered from 0 starting at the first directory listed with dirs;
* i.e., `popd` is equivalent to `popd +0`. Returns an array of paths in the stack.
*
* @param dir Removes the Nth directory (counting from the right of the list printed by dirs), starting with zero.
* @return Returns an array of paths in the stack.
*/
(dir: "-N"): ShellArray;
/**
* When no arguments are given, popd removes the top directory from the stack
* and performs a `cd` to the new top directory.
*
* The elements are numbered from 0 starting at the first directory listed with dirs;
* i.e., `popd` is equivalent to `popd +0`. Returns an array of paths in the stack.
*
* @param dir You can only use -N and +N.
* @return Returns an array of paths in the stack.
*/
(dir: string): ShellArray;
/**
* When no arguments are given, popd removes the top directory from the stack
* and performs a `cd` to the new top directory.
*
* The elements are numbered from 0 starting at the first directory listed with dirs;
* i.e., `popd` is equivalent to `popd +0`. Returns an array of paths in the stack.
*
* @return Returns an array of paths in the stack.
*/
(): ShellArray;
}
/**
* When no arguments are given, popd removes the top directory from the stack
* and performs a `cd` to the new top directory.
*
* The elements are numbered from 0 starting at the first directory listed with dirs;
* i.e., `popd` is equivalent to `popd +0`. Returns an array of paths in the stack.
*
* @param options Available options:
* - `-n`: Suppresses the normal change of directory when removing directories
* from the stack, so that only the stack is manipulated
* - `-q`: Suppresses output to the console.
* @param dir You can only use -N and +N.
* @return Returns an array of paths in the stack.
*/
export const popd: PopDirFunction;
export interface DirsFunction {
/**
* Clears the directory stack by deleting all of the elements.
*
* @param options Clears the directory stack by deleting all of the elements.
* @return Returns an array of paths in the stack, or a single path if +N or -N was specified.
*/
(options: "-c"): ShellArray;
/**
* Displays the list of currently remembered directories.
*
* @param options Displays the Nth directory (counting from the left of the list
* printed by dirs when invoked without options), starting with zero.
* @return Returns an array of paths in the stack, or a single path if +N or -N was specified.
*/
(options: "+N"): ShellString;
/**
* Displays the list of currently remembered directories.
*
* @param options Displays the Nth directory (counting from the right of the list
* printed by dirs when invoked without options), starting with zero.
* @return Returns an array of paths in the stack, or a single path if +N or -N was specified.
*/
(options: "-N"): ShellString;
/**
* Displays the list of currently remembered directories.
*
* @param options Available options:
* - `-c`: Clears the directory stack by deleting all of the elements.
* - `-N`: Displays the Nth directory (counting from the right of the list
* printed by dirs when invoked without options), starting with zero.
* - `+N`: Displays the Nth directory (counting from the left of the list
* printed by dirs when invoked without options), starting with zero.
* @return Returns an array of paths in the stack, or a single path if +N or -N was specified.
*/
(options: string): ShellArray | ShellString;
}
/**
* Displays the list of currently remembered directories.
*
* @param options Available options:
* - `-c`: Clears the directory stack by deleting all of the elements.
* - `-N`: Displays the Nth directory (counting from the right of the list
* printed by dirs when invoked without options), starting with zero.
* - `+N`: Displays the Nth directory (counting from the left of the list
* printed by dirs when invoked without options), starting with zero.
* @return Returns an array of paths in the stack, or a single path if +N or -N was specified.
*/
export const dirs: DirsFunction;
export interface LinkFunction {
/**
* Links source to dest. Use `-f` to force the link, should dest already exist.
*
* @param options Available options:
* - `-s`: Create a symbolic link, defaults to a hardlink
* - `-f`: Force creation
* @param source The source.
* @param dest The destination.
* @return Object with shell exit code, stderr and stdout.
*/
(options: string, source: string, dest: string): ShellString;
/**
* Links source to dest. Use `-f` to force the link, should dest already exist.
*
* @param source The source.
* @param dest The destination.
* @return Object with shell exit code, stderr and stdout.
*/
(source: string, dest: string): ShellString;
}
/**
* Links source to dest. Use `-f` to force the link, should dest already exist.
*
* @param options Available options:
* - `-s`: Create a symbolic link, defaults to a hardlink
* - `-f`: Force creation
* @param source The source.
* @param dest The destination.
* @return Object with shell exit code, stderr and stdout.
*/
export const ln: LinkFunction;
/**
* Exits the current process with the given exit code.
*
* Equivalent to calling `process.exit(code)`.
*
* @param code The exit code.
*/
export function exit(code?: number): never;
/**
* Object containing environment variables (both getter and setter). Shortcut to `process.env`.
*/
export const env: NodeJS.ProcessEnv;
export interface ExecFunction {
/**
* Executes the given command synchronously.
*
* @param command The command to execute.
* @return Returns an object containing the return code and output as string.
*/
(command: string): ShellString;
/**
* Executes the given command synchronously.
*
* @param command The command to execute.
* @param options Silence and synchronous options.
* @return Returns an object containing the return code and output as string,
* or if `{async: true}` was passed, a `ChildProcess`.
*/
(command: string, options: ExecOptions & { async?: false | undefined }): ShellString;
/**
* Executes the given command asynchronously.
*
* @param command The command to execute.
* @param options Silence and synchronous options.
* @return Returns an object containing the return code and output as string,
* or if `{async: true}` was passed, a `ChildProcess`.
*/
(command: string, options: ExecOptions & { async: true }): child.ChildProcess;
/**
* Executes the given command.
*
* @param command The command to execute.
* @param options Silence and synchronous options.
* @return Returns an object containing the return code and output as string,
* or if `{async: true}` was passed, a `ChildProcess`.
*/
(command: string, options: ExecOptions): ShellString | child.ChildProcess;
/**
* Executes the given command synchronously.
*
* @param command The command to execute.
* @param options Silence and synchronous options.
* @param callback Receives code and output asynchronously.
*/
(command: string, options: ExecOptions, callback: ExecCallback): child.ChildProcess;
/**
* Executes the given command synchronously.
*
* @param command The command to execute.
* @param callback Receives code and output asynchronously.
*/
(command: string, callback: ExecCallback): child.ChildProcess;
}
/**
* Executes the given command.
*
* @param command The command to execute.
* @param options Silence and synchronous options.
* @param [callback] Receives code and output asynchronously.
* @return Returns an object containing the return code and output as string,
* or if `{async: true}` or a `callback` was passed, a `ChildProcess`.
*/
export const exec: ExecFunction;
export type ExecCallback = (
/** The process exit code. */
code: number,
/** The process standard output. */
stdout: string,
/** The process standard error output. */
stderr: string,
) => any;
export interface ExecOptions extends child.ExecOptions {
/**
* Do not echo program output to the console.
*
* @default false
*/
silent?: boolean | undefined;
/**
* Exit when command return code is non-zero.
*
* @default false
*/
fatal?: boolean | undefined;
/**
* Asynchronous execution.
*
* If a callback is provided, it will be set to `true`, regardless of the passed value.
*
* @default false
*/
async?: boolean | undefined;
/**
* Character encoding to use.
*
* Affects the values returned by `stdout` and `stderr`,
* and what is written to `stdout` and `stderr` when not in silent mode
*
* @default "utf8"
*/
encoding?: string | undefined;
}
export interface ExecOutputReturnValue {
/** The process exit code. */
code: number;
/** The process standard output. */
stdout: string;
/** The process standard error output. */
stderr: string;
}
export interface ShellReturnValue extends ExecOutputReturnValue {
/**
* Analogous to the redirection operator `>` in Unix, but works with JavaScript strings
* (such as those returned by `cat`, `grep`, etc).
*
* Like Unix redirections, `to()` will overwrite any existing file!
*
* @param file The file to use.
*/
to(file: string): void;
/**
* Analogous to the redirect-and-append operator `>>` in Unix, but works with JavaScript strings
* (such as those returned by `cat`, `grep`, etc).
*
* @param file The file to append to.
*/
toEnd(file: string): void;
/**
* Returns a string containing the given pipeline, or a concatenated string
* containing the pipelines if more than one input stream is given
* (a new line character is introduced between each input).
*
* @return A string containing the given pipeline, or a concatenated string
* containing the pipelines if more than one input stream is given
* (a new line character is introduced between each input).
*/
cat: CatFunction;
/**
* Executes the given command.
*
* @param command The command to execute.
* @param options Silence and synchronous options.
* @param [callback] Receives code and output asynchronously.
* @return Returns an object containing the return code and output as string,
* or if `{async: true}` or a `callback` was passed, a `ChildProcess`.
*/
exec: ExecFunction;
/**
* Read the start of a pipeline input.
*/
head: HeadFunction;
/**
* Reads input string from given files and returns a string containing all lines
* of the file that match the given `regex_filter`. Wildcard `*` accepted.
*
* @param options Available options:
* - `-v`: Inverse the sense of the regex and print
* the lines not matching the criteria.
* - `-l`: Print only filenames of matching files
* @param regex_filter The regular expression to use.
* @return Returns a string containing all lines of the file that match the given `regex_filter`.
*/
grep: GrepFunction;
/**
* Reads an input string from pipeline and performs a JavaScript `replace()`
* on the input using the given search regex and replacement string or function.
*
* @param options Available options:
* - `-i`: Replace contents of 'file' in-place. Note that no backups will be created!
* @param searchRegex The regular expression to use for search.
* @param replacement The replacement.
* @return The new string after replacement.
*/
sed: SedFunction;
/**
* Return the contents of the pipeline, sorted line-by-line.
*
* @param options Available options:
* - `-r`: Reverse the results
* - `-n`: Compare according to numerical value
*/
sort: SortFunction;
/**
* Read the end of a pipeline input.
*/
tail: TailFunction;
/**
* Filter adjacent matching lines from input.
*
* @param options Available options:
* - `-i`: Ignore case while comparing
* - `-c`: Prefix lines by the number of occurrences
* - `-d`: Only print duplicate lines, one for each group of identical lines
*/
uniq: UniqFunction;
}
export type ShellString = string & ShellReturnValue;
export type ShellArray = string[] & ShellReturnValue;
export interface ShellStringConstructor {
/**
* Wraps a string (or array) value. This has all the string (or array) methods,
* but also exposes extra methods: `.to()`, `.toEnd()`, and all the pipe-able
* methods (ex. `.cat()`, `.grep()`, etc.).
*
* This can be easily converted into a string by calling `.toString()`.
*
* This type also exposes the corresponding command's stdout, stderr, and return status
* code via the `.stdout` (string), `.stderr` (string), and `.code` (number) properties
* respectively.
*
* Construct signature allows for:
*
* var foo = new ShellString('hello world');
*
* as per example in shelljs docs:
* https://github.com/shelljs/shelljs#shellstringstr
*
* @param value The string value to wrap.
* @return A string-like object with special methods.
*/
new(value: string): ShellString;
new(value: string[]): ShellArray;
/**
* Wraps a string (or array) value. This has all the string (or array) methods,
* but also exposes extra methods: `.to()`, `.toEnd()`, and all the pipe-able
* methods (ex. `.cat()`, `.grep()`, etc.).
*
* This can be easily converted into a string by calling `.toString()`.
*
* This type also exposes the corresponding command's stdout, stderr, and return status
* code via the `.stdout` (string), `.stderr` (string), and `.code` (number) properties
* respectively.
*
* @param value The string value to wrap.
* @return A string-like object with special methods.
*/
(value: string): ShellString;
(value: string[]): ShellArray;
}
export const ShellString: ShellStringConstructor;
export interface ChmodFunction {
/**
* Alters the permissions of a file or directory by either specifying the absolute
* permissions in octal form or expressing the changes in symbols.
*
* This command tries to mimic the POSIX behavior as much as possible.
*
* Notable exceptions:
* - In symbolic modes, 'a-r' and '-r' are identical. No consideration is given to the umask.
* - There is no "quiet" option since default behavior is to run silent.
*
* @param options Available options:
* - `-v`: output a diagnostic for every file processed
* - `-c`: like -v but report only when a change is made
* - `-R`: change files and directories recursively
* @param mode The access mode. Can be an octal string or a symbolic mode string.
* @param file The file to use.
* @return Object with shell exit code, stderr and stdout.
*/
(options: string, mode: string | number, file: string): ShellString;
/**
* Alters the permissions of a file or directory by either specifying the absolute
* permissions in octal form or expressing the changes in symbols.
*
* This command tries to mimic the POSIX behavior as much as possible.