Socket
Socket
Sign inDemoInstall

@types/shelljs

Package Overview
Dependencies
Maintainers
1
Versions
43
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@types/shelljs - npm Package Compare versions

Comparing version 0.8.3 to 0.8.4

1359

shelljs/index.d.ts

@@ -8,2 +8,3 @@ // Type definitions for ShellJS 0.8

// Alexander Futász <https://github.com/aldafu>
// ExE Boss <https://github.com/ExE-Boss>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

@@ -17,4 +18,6 @@

/**
* Changes to directory dir for the duration of the script. Changes to home directory if no argument is supplied.
* @param dir Directory to change in.
* 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.

@@ -30,67 +33,169 @@ */

/**
* 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).
*/
export function ls(...paths: Array<string | string[]>): ShellArray;
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).
*
* @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 function ls(options: string, ...paths: Array<string | string[]>): ShellArray;
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).
*
* @param path The path(s) to search.
* @return An array of all files (however deep) in the given path(s).
*/
export function find(...path: Array<string | string[]>): ShellArray;
export const find: FindFunction;
/**
* Copies files. The wildcard * is accepted.
* @param source The source.
* @param dest The destination.
* @return Object with shell exit code, stderr and stdout.
*/
export function cp(source: string | string[], dest: string): ShellString;
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.
* 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 function cp(options: string, source: string | string[], dest: string): ShellString;
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 ...files Files to remove.
* 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 function rm(...files: Array<string | string[]>): ShellString;
export const rm: 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.
*/
export function rm(options: string, ...files: Array<string | string[]>): ShellString;
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.
*/
export function mv(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
* Moves files. The wildcard `*` is accepted.
*
* @param options Available options:
* - `-f`: force (default behavior)
* - `-n`: no-clobber
* @param source The source.

@@ -100,23 +205,49 @@ * @param dest The destination.

*/
export function mv(options: string, source: string | string[], dest: string): ShellString;
export const mv: MoveFunction;
/**
* Creates directories.
* @param ...dir Directories to create.
* @return Object with shell exit code, stderr and stdout.
*/
export function mkdir(...dir: Array<string | string[]>): ShellString;
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.
*
* @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 function mkdir(options: string, ...dir: Array<string | string[]>): ShellString;
export const mkdir: MkdirFunction;
/**
* Evaluates expression using the available primaries and returns corresponding value.
* @param option '-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 symboilc link; '-p': true if path is a pipe (FIFO); '-S': true if path is a socket
* @param path The path.
*
* @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.

@@ -128,202 +259,470 @@ */

/**
* 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). Wildcard * accepted.
* @param ...files Files to use.
* @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 function cat(...files: Array<string | string[]>): ShellString;
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;
}
/**
* Reads an input string from file and performs a JavaScript replace() on the input using the given search regex and replacement string or function. Returns the new string after replacement.
* @param searchRegex The regular expression to use for search.
* @param replacement The replacement.
* @param file The file to process.
* @return The new string after replacement.
* 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 function sed(searchRegex: string | RegExp, replacement: string, file: string): ShellString;
export const cat: CatFunction;
/**
* Reads an input string from file and performs a JavaScript replace() on the input using the given search regex and replacement string or function. Returns the new string after replacement.
* @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 file The file to process.
* @return The new string after replacement.
*/
export function sed(options: string, searchRegex: string | RegExp, replacement: string, file: string): ShellString;
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 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.
* 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 function grep(regex_filter: string | RegExp, ...files: Array<string | string[]>): ShellString;
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.
* 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 function grep(options: string, regex_filter: string | RegExp, ...files: Array<string | string[]>): ShellString;
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.
*
* @param command The command to search for.
* @return Returns string containing the absolute path to the command.
*/
export function which(command: 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.
*/
export function echo(...text: string[]): ShellString;
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.
*
* @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 function echo(options: string, ...text: string[]): ShellString;
export const echo: EchoFunction;
/**
* Save the current directory on the top of the directory stack and then cd to dir. With no arguments, pushd exchanges the top two directories. Returns an array of paths in the stack.
* @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.
*/
export function pushd(dir: "+N"): ShellArray;
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;
/**
* Save the current directory on the top of the directory stack and then cd to dir. With no arguments, pushd exchanges the top two directories. Returns an array of paths in the stack.
* @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.
*/
export function pushd(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;
/**
* Save the current directory on the top of the directory stack and then cd to dir. With no arguments, pushd exchanges the top two directories. Returns an array of paths in the stack.
* @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 function pushd(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 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;
/**
* Save the current directory on the top of the directory stack and then cd to dir. With no arguments, pushd exchanges the top two directories. Returns an array of paths in the stack.
* @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: Supresses 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.
*/
export function pushd(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 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;
/**
* Save the current directory on the top of the directory stack and then cd to dir. With no arguments, pushd exchanges the top two directories. Returns an array of paths in the stack.
* @param options Available options: -n (Suppresses the normal change of directory when adding directories to the stack, so that only the stack is manipulated)
* @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.
*/
export function pushd(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 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;
/**
* Save the current directory on the top of the directory stack and then cd to dir. With no arguments, pushd exchanges the top two directories. Returns an array of paths in the stack.
* @param options Available options: -n (Suppresses the normal change of directory when adding directories to the stack, so that only the stack is manipulated)
* @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 function pushd(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 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;
/**
* 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.
*/
export function popd(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.
*
* @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.
* @return Returns an array of paths in the stack.
* 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 function popd(): ShellArray;
export const pushd: PushDirFunction;
/**
* 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.
*/
export function popd(dir: "-N"): ShellArray;
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 dir You can only use -N and +N.
* @return Returns an array of paths in the stack.
*/
export function popd(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 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: Supresses 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.
*/
export function popd(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 options Available options: -n (Suppresses the normal change of directory when removing directories from the stack, so that only the stack is manipulated) -q: Supresses 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.
*/
export function popd(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 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 options Available options: -n (Suppresses the normal change of directory when removing directories from the stack, so that only the stack is manipulated) -q: Supresses output to the console.
* @param dir You can only use -N and +N.
* @return Returns an array of paths in the stack.
*/
export function popd(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 right of the list printed by dirs), starting with zero.
* @return Returns an array of paths in the stack.
*/
(dir: "-N"): ShellArray;
/**
* 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.
*/
export function dirs(options: "-c"): 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;
/**
* Display the list of currently remembered directories. Returns an array of paths in the stack, or a single path if +N or -N was specified.
* @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.
*/
export function dirs(options: "+N"): ShellString;
/**
* 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;
}
/**
* Display the list of currently remembered directories. Returns an array of paths in the stack, or a single path if +N or -N was specified.
* @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.
* 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 function dirs(options: "-N"): ShellString;
export const popd: PopDirFunction;
/**
* Display the list of currently remembered directories. Returns an array of paths in the stack, or a single path if +N or -N was specified.
* @param options Available options: -c, -N, +N. You can only use those.
* @return Returns an array of paths in the stack, or a single path if +N or -N was specified.
*/
export function dirs(options: string): any;
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;
}
/**
* 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.
* 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 function ln(source: string, dest: string): ShellString;
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 (symlink), f (force)
* 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.

@@ -333,77 +732,237 @@ * @param dest The destination.

*/
export function ln(options: string, source: string, dest: string): ShellString;
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): void;
export function exit(code?: number): never;
/**
* Object containing environment variables (both getter and setter). Shortcut to process.env.
* Object containing environment variables (both getter and setter). Shortcut to `process.env`.
*/
export const env: { [key: string]: string };
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 }): 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 synchronously.
* @param command The command to execute.
* @return Returns an object containing the return code and output as string.
* 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 function exec(command: string): ExecOutputReturnValue;
/**
* 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.
*/
export function exec(command: string, options: ExecOptions): ExecOutputReturnValue | 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.
*/
export function exec(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.
*/
export function exec(command: string, callback: ExecCallback): child.ChildProcess;
export const exec: ExecFunction;
export type ExecCallback = (code: number, stdout: string, stderr: string) => any;
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 console (default: false). */
silent?: boolean;
/** Asynchronous execution. If a callback is provided, it will be set to true, regardless of the passed value (default: false). */
async?: boolean;
/** Character encoding to use. Affects the values returned to stdout and stderr, and what is written to stdout and stderr when not in silent mode (default: 'utf8'). */
encoding?: string;
/**
* Do not echo program output to the console.
*
* @default false
*/
silent?: boolean;
/**
* Asynchronous execution.
*
* If a callback is provided, it will be set to `true`, regardless of the passed value.
*
* @default false
*/
async?: boolean;
/**
* 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;
}
export interface ExecOutputReturnValue {
code: number;
stdout: string;
stderr: string;
/** 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 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;
/**
* 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;
cat(...files: string[]): ShellString;
exec(callback: ExecCallback): child.ChildProcess;
exec(): ExecOutputReturnValue;
grep(...files: Array<string | string[]>): ShellString;
sed(replacement: string, file: string): ShellString;
/**
* 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;
}

@@ -415,48 +974,66 @@

/**
* 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 octalMode The access mode. Octal.
* @param file The file to use.
* @return Object with shell exit code, stderr and stdout.
*/
export function chmod(octalMode: number, file: string): ShellString;
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. 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 octalMode The access mode. Octal.
* @param file The file to use.
* @return Object with shell exit code, stderr and stdout.
*/
export function chmod(options: string, octalMode: 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.
*
* 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 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.
*/
(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. Notable exceptions:
* 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 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.
*
* @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.
*/
export function chmod(mode: string, file: string): ShellString;
export const chmod: 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.
*/
export function chmod(options: string, mode: string, file: string): ShellString;
// Non-Unix commands
/**
* Searches and returns string containing a writeable, platform-dependent temporary directory. Follows Python's tempfile algorithm.
* Searches and returns string containing a writeable, platform-dependent temporary directory.
* Follows Python's tempfile algorithm.
*
* @return The temp file path.

@@ -468,2 +1045,3 @@ */

* Tests if error occurred in the last command.
*
* @return Returns null if no error occurred, otherwise returns string explaining the error

@@ -475,59 +1053,126 @@ */

/**
* Update the access and modification times of each FILE to the current time. A FILE argument that does not exist is created empty, unless -c is supplied
*/
export interface TouchOptionsArray {
'-d'?: string;
'-r'?: string;
"-d"?: string;
"-r"?: string;
}
export function touch(...files: string[]): ShellString;
export function touch(files: string[]): ShellString;
export function touch(options: TouchOptionsLiteral, ...files: Array<string | string[]>): ShellString;
export function touch(options: TouchOptionsArray, ...files: Array<string | string[]>): ShellString;
export interface TouchFunction {
(
options: TouchOptionsLiteral | TouchOptionsArray,
files: string[]
): ShellString;
(
options: TouchOptionsLiteral | TouchOptionsArray,
...files: string[]
): ShellString;
(files: string[]): ShellString;
(...files: string[]): ShellString;
}
/**
* Update the access and modification times of each FILE to the current time.
* A FILE argument that does not exist is created empty, unless `-c` is supplied
*/
export const touch: TouchFunction;
export interface HeadOptions {
/** Show the first <num> lines of the files. */
'-n': number;
/** Show the first <num> lines of the files. */
"-n": number;
}
/** Read the start of a file. */
export function head(...files: Array<string | string[]>): ShellString;
/** Read the start of a file. */
export function head(options: HeadOptions, ...files: Array<string | string[]>): ShellString;
export interface HeadFunction {
(options: HeadOptions, files: string[]): ShellString;
(options: HeadOptions, ...files: string[]): ShellString;
(files: string[]): ShellString;
(...files: string[]): ShellString;
}
/**
* Return the contents of the files, sorted line-by-line. Sorting multiple files mixes their content (just as unix sort does).
* Read the start of a file.
*/
export function sort(...files: Array<string | string[]>): ShellString;
export const head: HeadFunction;
export interface SortFunction {
/**
* Return the contents of the files, sorted line-by-line.
* Sorting multiple files mixes their content (just as unix sort does).
*
* @param options Available options:
* - `-r`: Reverse the results
* - `-n`: Compare according to numerical value
*/
(options: string, files: string[]): ShellString;
(options: string, ...files: string[]): ShellString;
/**
* Return the contents of the files, sorted line-by-line.
* Sorting multiple files mixes their content (just as unix sort does).
*/
(files: string[]): ShellString;
(...files: string[]): ShellString;
}
/**
* Return the contents of the files, sorted line-by-line. Sorting multiple files mixes their content (just as unix sort does).
* @param options Available options: -r: Reverse the results -n: Compare according to numerical value
* Return the contents of the files, sorted line-by-line.
* Sorting multiple files mixes their content (just as unix sort does).
*
* @param options Available options:
* - `-r`: Reverse the results
* - `-n`: Compare according to numerical value
*/
export function sort(options: string, ...files: Array<string | string[]>): ShellString;
export const sort: SortFunction;
export interface TailOptions {
/** Show the last <num> lines of files. */
'-n': number;
/** Show the last <num> lines of files. */
"-n": number;
}
/** Read the end of a file. */
export function tail(...files: Array<string | string[]>): ShellString;
/** Read the end of a file. */
export function tail(options: TailOptions, ...files: Array<string | string[]>): ShellString;
export interface TailFunction {
(options: TailOptions, files: string[]): ShellString;
(options: TailOptions, ...files: string[]): ShellString;
(files: string[]): ShellString;
(...files: string[]): ShellString;
}
/**
* Filter adjacent matching lines from input.
* Read the end of a file.
*/
export function uniq(input: string, output?: string): ShellString;
export const tail: TailFunction;
export interface UniqFunction {
/**
* 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
*/
(options: string, input: string, output?: string): ShellString;
/**
* Filter adjacent matching lines from input.
*/
(input: string, output?: string): ShellString;
}
/**
* 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
*
* @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
*/
export function uniq(options: string, input: string, output?: string): ShellString;
export const uniq: UniqFunction;
/**
* Sets global configuration variables
* @param options Available options: `+/-e`: exit upon error (`config.fatal`), `+/-v`: verbose: show all commands (`config.verbose`), `+/-f`: disable filename expansion (globbing)
* @param options Available options:
* - `+/-e`: exit upon error (`config.fatal`),
* - `+/-v`: verbose: show all commands (`config.verbose`),
* - `+/-f`: disable filename expansion (globbing)
*/

@@ -539,31 +1184,31 @@ export function set(options: string): void;

export interface ShellConfig {
/**
* Suppresses all command output if true, except for echo() calls. Default is false.
*/
silent: boolean;
/**
* Suppresses all command output if true, except for echo() calls. Default is false.
*/
silent: boolean;
/**
* If true the script will die on errors. Default is false.
*/
fatal: boolean;
/**
* If true the script will die on errors. Default is false.
*/
fatal: boolean;
/**
* Will print each executed command to the screen. Default is true.
*/
verbose: boolean;
/**
* Will print each executed command to the screen. Default is true.
*/
verbose: boolean;
/**
* Passed to glob.sync() instead of the default options ({}).
*/
globOptions: glob.IOptions;
/**
* Passed to glob.sync() instead of the default options ({}).
*/
globOptions: glob.IOptions;
/**
* Absolute path of the Node binary. Default is null (inferred).
*/
execPath: string | null;
/**
* Absolute path of the Node binary. Default is null (inferred).
*/
execPath: string | null;
/**
* Reset shell.config to the defaults.
*/
reset(): void;
/**
* Reset shell.config to the defaults.
*/
reset(): void;
}

@@ -570,0 +1215,0 @@

79

shelljs/make.d.ts

@@ -1,41 +0,42 @@

import * as shelljs from './';
import shelljs = require('./index');
declare global {
interface Target {
(...args: any[]): void;
result?: any;
done?: boolean;
}
const target: {
all?: Target;
[s: string]: Target;
};
const cd: typeof shelljs.cd;
const pwd: typeof shelljs.pwd;
const ls: typeof shelljs.ls;
const find: typeof shelljs.find;
const cp: typeof shelljs.cp;
const rm: typeof shelljs.rm;
const mv: typeof shelljs.mv;
const mkdir: typeof shelljs.mkdir;
const cat: typeof shelljs.cat;
const sed: typeof shelljs.sed;
const grep: typeof shelljs.grep;
const echo: typeof shelljs.echo;
const pushd: typeof shelljs.pushd;
const popd: typeof shelljs.popd;
const dirs: typeof shelljs.dirs;
const ln: typeof shelljs.ln;
const exit: typeof shelljs.exit;
const env: typeof shelljs.env;
const exec: typeof shelljs.exec;
const chmod: typeof shelljs.chmod;
const tempdir: typeof shelljs.tempdir;
const error: typeof shelljs.error;
const touch: typeof shelljs.touch;
const head: typeof shelljs.head;
const sort: typeof shelljs.sort;
const tail: typeof shelljs.tail;
const uniq: typeof shelljs.uniq;
const set: typeof shelljs.set;
const config: typeof shelljs.config;
interface Target {
(...args: any[]): void;
result?: any;
done?: boolean;
}
const target: {
all?: Target;
[s: string]: Target;
};
const cat: typeof shelljs.cat;
const cd: typeof shelljs.cd;
const chmod: typeof shelljs.chmod;
const config: typeof shelljs.config;
const cp: typeof shelljs.cp;
const dirs: typeof shelljs.dirs;
const echo: typeof shelljs.echo;
const env: typeof shelljs.env;
const error: typeof shelljs.error;
const exec: typeof shelljs.exec;
const exit: typeof shelljs.exit;
const find: typeof shelljs.find;
const grep: typeof shelljs.grep;
const head: typeof shelljs.head;
const ln: typeof shelljs.ln;
const ls: typeof shelljs.ls;
const mkdir: typeof shelljs.mkdir;
const mv: typeof shelljs.mv;
const popd: typeof shelljs.popd;
const pushd: typeof shelljs.pushd;
const pwd: typeof shelljs.pwd;
const rm: typeof shelljs.rm;
const sed: typeof shelljs.sed;
const set: typeof shelljs.set;
const sort: typeof shelljs.sort;
const tail: typeof shelljs.tail;
const tempdir: typeof shelljs.tempdir;
const touch: typeof shelljs.touch;
const uniq: typeof shelljs.uniq;
}

12

shelljs/package.json
{
"name": "@types/shelljs",
"version": "0.8.3",
"version": "0.8.4",
"description": "TypeScript definitions for ShellJS",

@@ -31,2 +31,7 @@ "license": "MIT",

"githubUsername": "aldafu"
},
{
"name": "ExE Boss",
"url": "https://github.com/ExE-Boss",
"githubUsername": "ExE-Boss"
}

@@ -38,3 +43,4 @@ ],

"type": "git",
"url": "https://github.com/DefinitelyTyped/DefinitelyTyped.git"
"url": "https://github.com/DefinitelyTyped/DefinitelyTyped.git",
"directory": "types/shelljs"
},

@@ -46,4 +52,4 @@ "scripts": {},

},
"typesPublisherContentHash": "e799be24722d411ebd9499934067fb1afbd40c87400fa5a502557b5bec7f021c",
"typesPublisherContentHash": "6c78de6ad50a8081d0265b32115501992f9425cc5b24aa9411b111311d385190",
"typeScriptVersion": "2.0"
}

4

shelljs/README.md

@@ -11,3 +11,3 @@ # Installation

Additional Details
* Last updated: Wed, 13 Feb 2019 21:06:21 GMT
* Last updated: Mon, 01 Apr 2019 20:39:57 GMT
* Dependencies: @types/glob, @types/node

@@ -17,2 +17,2 @@ * Global values: none

# Credits
These definitions were written by Niklas Mollenhauer <https://github.com/nikeee>, Vojtech Jasny <https://github.com/voy>, George Kalpakas <https://github.com/gkalpak>, Paul Huynh <https://github.com/pheromonez>, Alexander Futász <https://github.com/aldafu>.
These definitions were written by Niklas Mollenhauer <https://github.com/nikeee>, Vojtech Jasny <https://github.com/voy>, George Kalpakas <https://github.com/gkalpak>, Paul Huynh <https://github.com/pheromonez>, Alexander Futász <https://github.com/aldafu>, ExE Boss <https://github.com/ExE-Boss>.
SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

About

Packages

npm

Go

Maven

PyPI

Rubygems

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc