Shelljs - Unix shell commands for Node.js
Shelljs是Node.js下的脚本语言解析器,具有丰富且强大的底层操作(Windows/Linux/OS X)权限。Shelljs本质就是基于node的一层命令封装插件,让前端开发者可以不依赖linux也不依赖类似于cmder的转换工具,而是直接在我们最熟悉不过的javascript代码中编写shell命令实现功能。
-
解决问题
shell脚本对于前端都不陌生,在package.json配置里大家已经使用了,以
"build": "umi build && node zip.config.js"
为例,npm run build先会执行umi build后会执行zip.config.js的脚本,zip.config.js脚本做的事就是if无build文件夹,则生成build文件夹并借助easyzip进行压缩打包,else存在build文件夹,则生成zip压缩包或者其他公司需要的文件。
shelljs做的事就是自动化,从耗时的重复性常规动作里解放出来,提升开发效率和工作心情。 -
基本语法
//引入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 ...])
删除一个目录中一个或多个文件或目录,一旦删除,无法恢复。
常用参数: