globalFunctionSignatures static method

Map<String, String> globalFunctionSignatures()

Returns a map of global function names to their display signatures.

Implementation

static Map<String, String> globalFunctionSignatures() {
  return {
    'cat': 'void cat(String path, {LineAction stdout = print})',
    'copy': 'void copy(String from, String to, {bool overwrite = false})',
    'copyTree':
        'void copyTree(String from, String to, {bool overwrite = false, bool includeHidden = false, bool includeEmpty = true, bool includeLinks = true, bool recursive = true, bool Function(String file) filter = _allowAll})',
    'createDir': 'String createDir(String path, {bool recursive = false})',
    'withTempDirAsync':
        'Future<R> withTempDirAsync(Future<R> Function(String tempDir) action, {bool keep = false, String? pathToTempDir})',
    'createTempDir': 'String createTempDir()',
    'deleteDir': 'void deleteDir(String path, {bool recursive = true})',
    'isOnPATH': 'bool isOnPATH(String path)',
    'withEnvironmentAsync':
        'Future<R> withEnvironmentAsync(Future<R> Function() callback, {required Map<String, String> environment})',
    'isFile': 'bool isFile(String path)',
    'isDirectory': 'bool isDirectory(String path)',
    'isLink': 'bool isLink(String path)',
    'exists': 'bool exists(String path, {bool followLinks = true})',
    'isEmpty': 'bool isEmpty(String pathToDirectory)',
    'move': 'void move(String from, String to, {bool overwrite = false})',
    'moveDir': 'void moveDir(String from, String to)',
    'moveTree':
        'void moveTree(String from, String to, {bool overwrite = false, bool includeHidden = false, bool Function(String file) filter = _allowAll})',
    'touch': 'String touch(String path, {bool create = false})',
    'verbose': 'void verbose(String Function() callback)',
    'devNull': 'void devNull(String? line)',
    'createTempFilename':
        'String createTempFilename({String? suffix, String? pathToTempDir})',
    'createTempFile': 'String createTempFile({String? suffix})',
    'truepath':
        'String truepath(String part1, [String? part2, String? part3, String? part4, String? part5, String? part6, String? part7])',
    'privatePath':
        'String privatePath(String part1, [String? part2, String? part3, String? part4, String? part5, String? part6, String? part7])',
    'red':
        'String red(String text, {AnsiColor background = AnsiColor.none, bool bold = true})',
    'black':
        'String black(String text, {AnsiColor background = AnsiColor.white, bool bold = true})',
    'green':
        'String green(String text, {AnsiColor background = AnsiColor.none, bool bold = true})',
    'blue':
        'String blue(String text, {AnsiColor background = AnsiColor.none, bool bold = true})',
    'yellow':
        'String yellow(String text, {AnsiColor background = AnsiColor.none, bool bold = true})',
    'magenta':
        'String magenta(String text, {AnsiColor background = AnsiColor.none, bool bold = true})',
    'cyan':
        'String cyan(String text, {AnsiColor background = AnsiColor.none, bool bold = true})',
    'white':
        'String white(String text, {AnsiColor background = AnsiColor.none, bool bold = true})',
    'orange':
        'String orange(String text, {AnsiColor background = AnsiColor.none, bool bold = true})',
    'grey':
        'String grey(String text, {double level = 0.5, AnsiColor background = AnsiColor.none, bool bold = true})',
    'ask':
        'String ask(String prompt, {bool toLower = false, bool hidden = false, bool required = true, String? defaultValue, CustomAskPrompt customPrompt = Ask.defaultPrompt, AskValidator validator = Ask.dontCare, String? customErrorMessage})',
    'backupFile':
        'void backupFile(String pathToFile, {bool ignoreMissing = false})',
    'restoreFile':
        'void restoreFile(String pathToFile, {bool ignoreMissing = false})',
    'withFileProtectionAsync':
        'Future<R> withFileProtectionAsync(List<String> protected, Future<R> Function() action, {String? workingDirectory})',
    'confirm':
        'bool confirm(String prompt, {bool? defaultValue, CustomConfirmPrompt customPrompt = Confirm.defaultPrompt})',
    'delete': 'void delete(String path, {bool ask = false})',
    'echo': 'void echo(String text, {bool newline = false})',
    'fetch':
        'Future<void> fetch({required String url, required String saveToPath, FetchMethod method = FetchMethod.get, Map<String, String>? headers, OnFetchProgress fetchProgress = _devNull, FetchData? data})',
    'fetchMultiple':
        'Future<void> fetchMultiple({required List<FetchUrl> urls})',
    'find':
        'FindProgress find(String pattern, {bool caseSensitive = false, bool recursive = true, bool includeHidden = false, String workingDirectory = \'.\', Progress? progress, List<FileSystemEntityType> types = const [Find.file]})',
    'head': 'HeadProgress head(String path, int lines)',
    'isWritable': 'bool isWritable(String path)',
    'isReadable': 'bool isReadable(String path)',
    'isExecutable': 'bool isExecutable(String path)',
    'isMemberOfGroup': 'bool isMemberOfGroup(String group)',
    'menu':
        'T menu(String prompt, {required List<T> options, T? defaultOption, CustomMenuPrompt customPrompt = Menu.defaultPrompt, int? limit, String Function(T)? format, bool fromStart = true})',
    'read': 'Progress read(String path, {String delim = \'\\n\'})',
    'readStdin': 'Progress readStdin()',
    'replace':
        'int replace(String path, Pattern existing, String replacement, {bool all = false})',
    'run':
        'int? run(String commandLine, {bool runInShell = false, bool nothrow = false, bool privileged = false, String? workingDirectory, bool extensionSearch = true, Encoding encoding = utf8})',
    'startFromArgs':
        'Progress startFromArgs(String command, List<String> args, {Progress? progress, bool runInShell = false, bool detached = false, bool terminal = false, bool privileged = false, bool nothrow = false, String? workingDirectory, bool extensionSearch = true, bool includeParentEnvironment = true, Encoding encoding = utf8})',
    'start':
        'Progress start(String commandLine, {Progress? progress, bool runInShell = false, bool detached = false, bool terminal = false, bool nothrow = false, bool privileged = false, String? workingDirectory, bool extensionSearch = true, bool includeParentEnvironment = true, Encoding encoding = utf8})',
    'sleep':
        'void sleep(int duration, {Interval interval = Interval.seconds})',
    'sleepAsync':
        'Future<void> sleepAsync(int duration, {Interval interval = Interval.seconds})',
    'tail': 'TailProgress tail(String path, int lines)',
    'which':
        'Which which(String appname, {bool first = true, bool verbose = false, bool extensionSearch = true, Sink<String>? progress})',
    'addUnitTestOverrides': 'void addUnitTestOverrides(String pathToProject)',
    'capture':
        'Future<Progress> capture(Future<R> Function() action, {Progress? progress})',
    'showEditor': 'void showEditor(String path)',
    'withOpenFile':
        'R withOpenFile(String pathToFile, R Function(FileSync) action, {FileMode fileMode = FileMode.writeOnlyAppend})',
    'createSymLink':
        'void createSymLink({required String targetPath, required String linkPath})',
    'deleteSymlink': 'void deleteSymlink(String linkPath)',
    'resolveSymLink': 'String resolveSymLink(String pathToLink)',
    'stat': 'FileStat stat(String path)',
    'fileLength': 'int fileLength(String pathToFile)',
    'calculateHash': 'Digest calculateHash(String path)',
    'printerr': 'void printerr(Object? object)',
  };
}