shelljs库使用js达到linux命令操作

基本语法

    //引入shelljs
    var shell = require('shelljs')
     
    //检查控制台是否以运行`git `开头的命令
    if (!shell.which('git')) {
      //在控制台输出内容
      shell.echo('Sorry, this script requires git');
      shell.exit(1);
    }
     
    shell.rm('-rf','out/Release');//强制递归删除`out/Release目录`
    shell.cp('-R','stuff/','out/Release');//将`stuff/`中所有内容拷贝至`out/Release`目录
     
    shell.cd('lib');//进入`lib`目录
    //找出所有的扩展名为js的文件，并遍历进行操作
    shell.ls('*.js').forEach(function (file) {
      /* 这是第一个难点：sed流编辑器,建议专题学习，-i表示直接作用源文件 */
      //将build_version字段替换为'v0.1.2'
      shell.sed('-i', 'BUILD_VERSION', 'v0.1.2', file);
      //将包含`REMOVE_THIS_LINE`字符串的行删除
      shell.sed('-i', /^.*REMOVE_THIS_LINE.*$/, '', file);
      //将包含`REPLACE_LINE_WITH_MACRO`字符串的行替换为`macro.js`中的内容
      shell.sed('-i', /.*REPLACE_LINE_WITH_MACRO.*\n/, shell.cat('macro.js'), file);
    });
     
    //返回上一级目录
    shell.cd('..');
     
    //run external tool synchronously
    //即同步运行外部工具
    if (shell.exec('git commit -am "Auto-commit"').code !== 0){
        shell.echo('Error: Git commit failed');
        shell.exit(1);
    }
    复制代码

示例解释
    shell.which(command)

在环境变量PATH中寻找指定命令的地址，判断该命令是否可执行，返回该命令的绝对地址

    echo

    在控制台输出指定内容
    .to(index.txt)写入文件

    exit(code)
    以退出码为code退出当前进程

    rm（[options，] file [，file ...]）

    删除一个目录中一个或多个文件或目录，一旦删除，无法恢复。

    常用参数：
        -f:强制删除文件;
        -i:删除之前先询问用户;
        -r:递归处理目录;
        -v:显示处理过程;

        shell.rm('-rf', staticSplash);
        复制代码

    cp([options,] source_array, dest) cp('-R','index.txt', '~/newCopy/') cp('-R',['index.txt', 'old.txt'], '~/newCopy/')

    用来将一个或多个源文件或目录复制到指定的文件或目录。

    常用参数：
        -f:force (default behavior)
        -L: follow symlinks
        -r,-R: recursive
        -n: no-clobber
        -u: only copy if source is newer than dest
        -P: don't follow symlinks

    cd

    切换工作目录至指定的相对路径或绝对路径。cd..为返回上一级，cd-回到前一目录。

    ls

    用来显示目标列表。

    常用参数：
        -a:显示所有文件;
        -C:多列显示查询结果;
        -l:单列长格式显示查询结果(与-C相反);
        -R:递归处理目录;
        -A：所有文件（包括开头的文件.，除了.和..）
        -d：列出目录本身，而不是其内容

        ls(path.join('bundle', 'css/')).forEach(cssName => {
          ***
        })
        复制代码

    sed([options,] search_regex, replacement, file_array

    将file_array中符合search_regex的内容替换为replacement，支持正则的捕获组自引用。一次处理一行内容，处理完成后把缓冲区内容送往屏幕，然后处理下一行，循环直至结束。

    常用参数：
        -i:直接作用源文件

    cat([options,] file [, file ...])

    将一个或多个文件内容读入，指定一个文件时读入该文件，指定多个文件时将内容连接在一起读入。

    可用选项：
    -n: number all output lines

    exec(command [, options] [, callback])

    执行所传入的命令
        async:是否异步执行,默认false，传入callback时自动开启
        slient:不输出信息到console,默认false
        encoding:默认utf8
        除非另有说明，否则command 同步执行给定的给定。在同步 模式下，它返回一个ShellString（与ShellJS v0.6.x兼容，返回 表单的对象{ code:..., stdout:... , stderr:... }）。否则，这将返回子进程 对象，并callback获取参数(code, stdout, stderr)。
        注意：对于长期存在的进程，最好以exec()异步方式运行

    chmod

    设置文件调用权限
        -c：output a diagnostic for every file processed
        -v: like verbose, but report only when a change is made
        -R: change files and directories recursively

    u表示该文件拥有者，g表示同一群体者，o表示其他，a表示所有
    +表示增加权限，-表示取消权限，=表示唯一设定权限
    r表示可读，w表示可写，x表示可执行，X表示当该文件是个子目录

        chmod(755, '/Users/brandon');
        chmod('755', '/Users/brandon'); // same as above
        chmod('u+x', '/Users/brandon');
        chmod('-R', 'a-w', '/Users/brandon');
        复制代码

    pushd（[options，] [dir |'-N'|'+ N']）

    可用选项
    -n：在向堆栈添加目录时禁止正常更改目录，以便仅操作堆栈

    参数
        dir：使当前工作目录成为堆栈的顶部，然后执行等效的cd dir
        +N：通过旋转堆栈将第N个目录（从dirs打印的列表的左侧开始，从零开始）到列表的顶部
        -N：通过旋转堆栈将第N个目录（从dirs打印的列表右侧开始，从零开始计数）到列表顶部

        echo(process.cwd());  // 当前文件父路径 /Users...
        pushd('/etc') // /private/etc /Users...
        pushd('+1') // users... /private/etc  
        复制代码

    将当前目录保存在目录堆栈的顶部，然后cd到dir。没有参数，pushd交换前两个目录。返回堆栈中的路径数组。

    popd（[options，] [' - N'|'+ N']）

    可用选项：
    -n：从堆栈中删除目录时禁止正常更改目录，以便仅操作堆栈

    参数：
        +N：删除第N个目录（从dirs打印的列表左侧开始计算），从零开始
        -N：删除第N个目录（从dirs打印的列表右侧开始计算），从零开始。

        echo(process.cwd()); // '/usr'
        pushd('/etc');       // '/etc /usr'
        echo(process.cwd()); // '/etc'
        popd();              // '/usr'
        echo(process.cwd()); // '/usr'
        复制代码

    如果没有给出参数，popd将从堆栈中删除顶级目录并执行cd到新的顶级目录。从dirs列出的第一个目录开始，元素从0开始编号; 即，popd相当于popd +0。返回堆栈中的路径数组

    dirs（[options |'+ N'|'-N']

    可用选项：
    -c：通过删除所有元素清除目录堆栈

    参数：
        +N：显示第N个目录（从没有选项调用时由dirs打印的列表左侧开始计数），从零开始
        -N：显示第N个目录（从没有选项调用时由dirs打印的列表右侧开始计数），从零开始

    显示当前记住的目录列表。返回堆栈中的路径数组，如果指定了+ N或-N，则返回单个路径。

    find（path [，path ...]）

    查找文件

        console.log(find('../Config/application.js'))
        复制代码

    返回path_array

    grep（[options，] regex_filter，file [，file ...]）

    不同于fing查找文件，grep用于查找内容

    可用选项：
        -v：反转正则表达式的意义并打印不符合条件的行
        -l：仅打印匹配文件的文件名

        grep('-v', 'GLOBAL_VARIABLE', '*.js');
        grep('GLOBAL_VARIABLE', '*.js');
        复制代码

    从给定文件中读取输入字符串，并返回一个字符串，其中包含 与给定文件匹配的文件的所有行regex_filter

    head（[{' - n'：}，] file [，file ...]）

    读取文件的开头

    可用选项：
    -n ：显示文件的第一行

        console.log(head('bundle.js'))  
        console.log(head({'-n':1},'bundle.js'))  // 获取第一行
        复制代码

    tail（[{' - n'：}，] file [，file ...]）

    读取文件的结尾

    可用选项： -n ：显示文件的最后几行

        var str = tail({'-n': 1}, 'file*.txt');
        var str = tail('file1', 'file2');
        var str = tail(['file1', 'file2']); // same as above
        复制代码

    ln（[options，] source，dest）

    创建链接

        ln('file', 'newlink');  // /Users.../newlink
        ln('-sf', 'file', 'newlink');  //如果newlink存在，则强制链接?
        复制代码

    mkdir（[options，] dir [，dir ...]）

    创建文件夹

    可用选项：
    -p：完整路径（如有必要，将创建中间目录

        shell.mkdir('bundle')
        shell.mkdir('-p', ['bundle', 'js'])
        复制代码

    touch（[options，] file [，file ...]）

    不同于mkdir创建文件夹，touch创建文件

    可用选项：
        -a：仅更改访问时间
        -c：不要创建任何文件
        -m：仅更改修改时间
        -d DATE:指定时间
        -r FILE:用FILE的时间替代新文件时间

    mv（[options，] source [，source ...]，dest'）

    移动

    可用选项：
        -f：force（默认行为）
        -n：no-clobber

        mv('move', 'target');  // 将move文件移动到target文件夹
        复制代码

    PWD（）

    查看当前目录

    set（选项）

    设置全局配置变量

    可用选项：
        +/-e：出错时退出（config.fatal）
        +/-v：verbose：show all commands（config.verbose）
        +/-f：禁用文件名扩展（globbing）

        set('-e'); // exit upon first error
        set('+e'); // this undoes a "set('-e')"
        复制代码

    sort（[options，] file [，file ...]）

    内容排序

    可用选项：
        -r：反转比较结果
        -n：根据数值比较

        sort('foo.txt', 'bar.txt');
        sort('-r', 'foo.txt');
        复制代码

    返回文件的内容，逐行排序。排序多个

    test（）

    文件类型判断

    可用选项：
    '-b', 'path'：如果path是块设备，则为true
    '-c', 'path'：如果path是字符设备，则为true
    '-d', 'path'：如果path是目录，则为true
    '-e', 'path'：如果路径存在，则为true
    '-f', 'path'：如果path是常规文件，则为true
    '-L', 'path'：如果path是符号链接，则为true
    '-p', 'path'：如果path是管道（FIFO），则为true
    '-S', 'path'：如果path是套接字，则为true

        if (!test('-f', path)) continue;
        复制代码

    uniq（[options，] [input，[output]]）

    可用选项：
        -i：比较时忽略大小写
        -c：按出现次数排列前缀
        -d：仅打印重复的行，每行对应一行

    ShellString()

    构造器，将一个字符串转化为Shell字符串,转化后的字符串支持链式调用特殊的shell命令

        ShellString('hello world')
        复制代码

    ShellString.Prototype.to()

    将shellString输出至指定文件,相当于脚本语言中的>

    ShellString.Prototype.toEnd()

    将shellString追加至指定文件,相当于脚本语言中的>>

    env['VAR_NAME']

    指向process.env

    Pipes链式调用支持

    sed,grep,cat,exec,to,toEnd均支持链式调用

    Configuration
        config.silent sh.config.silent
        config.fatal config.fatal
        config.verbose config.verbose
        config.globOptions config.globOptions
        config.reset()重置全局 shell.config.reset()

参考链接

shelljs官网文档

转载于:https://juejin.im/post/5cdb76166fb9a032196ef1ff