Skip to content

npm scripts

Awesome npm Scripts Awesome

> 使用 npm 作为构建工具的一切都很棒.

你可能还喜欢 awesome-npm.

注意:我目前太忙了,无法积极扩展此列表; 因此,我决定把它做成 OPEN Open Source Project . 做出重大和有价值贡献的个人将获得对项目的承诺访问权,以便在他们认为合适的时候做出贡献.

Articles

Videos/Talks

Task Runners

用于并行或顺序运行多个命令或 npm 脚本的工具.

  • script-runner - 具有简洁语法的简单任务运行器.
  • npm-run-all - 功能齐全的任务运行器.
  • redrun - 扩展 package.json 中的脚本以提高执行速度.

File Watchers

用于监视源文件并在任何文件更改时运行构建命令的工具.

  • onchange -onchange<glob> --<command>.
  • watch -手表<command><directory>.

Dev Servers

  • http-server - 简单的零配置命令行 http 服务器.
  • live-server - 具有实时重新加载功能的简单开发 HTTP 服务器.

Cross-platform Utilities

执行常见命令行任务的实用程序,无需担心跨平台兼容性.

  • rimraf - 删除文件或目录; 像 rm -rf 一样.
  • del-cli - 更安全的文件和文件夹删除.
  • mkdirp - 创建一个目录,如果需要创建父目录; 像mkdir -p.
  • cpr - cp -r 用于 Node.js.
  • cpy-cli - 文件/目录复制/重命名.
  • copyfiles - 将文件列表复制到目录中.
  • sync-files - 类似 rsync 的目录与监视模式同步.
  • echo-cli - 支持 JS 转义序列的跨平台“echo”.
  • clear-cli - 清除终端.
  • cross-env - 为脚本设置环境变量,unix 风格.
  • cross-os - 运行特定于平台的 npm 脚本.
  • ntee - 从标准输入读取并写入标准输出和文件的实用程序; 像 Unix tee.
  • catw - 将文件打印到标准输出,可选监视模式; 有点像 Unix cat.

Utility Packs

  • shx - 在 Node.js 中实现的常见 Unix 实用程序的集合; 用法示例:shx rm somefile.

Other Utilities

  • hashmark - 获取文件内容并输出为名称中带有哈希值的新文件.
  • gzip-size-cli - 获取文件或标准输入的压缩大小.
  • opn-cli - 使用用户首选的应用程序打开网站、文件、可执行文件等.
  • headr - 将标题/横幅信息添加到文件中.
  • Bower files CLI - 在命令行上获取主要的 bower 文件.
  • cli-error-notifier - 当 npm 脚本失败时发送本机桌面通知.

Miscellaneous

  • screwy - npm 脚本 GUI.
  • Forrest - npm 脚本桌面客户端.
  • run-npm - 运行本地安装的节点模块可执行文件. 用于调试 npm 脚本.
  • npm-quick-run - 无需输入全名即可通过前缀快速运行 npm 脚本.
  • edit-script - 从命令行编辑 npm 脚本,无需担心 JSON 转义.
  • ntl - 用于列出和运行 npm 脚本的交互式 cli 菜单.

Cross-platform Shell Reference

在 Unix 和 Windows 上工作相同的 shell 操作符和命令的快速参考.

  • 使用 &amp;&amp; 按顺序运行命令. 如果命令失败,脚本将退出.
  • 使用“|”将一个命令的标准输出通过管道传输到下一个命令的标准输入. (做某事 | 别的事
  • 使用 &gt; 将命令的标准输出写入文件. (做某事 &gt; 文件
  • 使用 &lt; 将文件的内容发送到命令的标准输入. (命令 &lt; 文件
  • 使用cd<dir> 将当前工作目录更改为 <dir>. 请注意,cd 在 windows 上单独打印当前工作目录,但在 *nix 上将工作目录更改为 ~.

npm run Reference

您可以使用 npm run-scriptnpm run; 他们都做同样的事情,但 npm run 更短.

  • 只运行 npm run 来打印脚本列表.
  • 运行 npm run script(其中 script 是脚本的名称)将运行 prescriptscriptpostscript; 以该顺序.
  • 你不能嵌套 prepost 钩子(即 preprescript 不起作用).
  • 您可以通过将 -- 传递给 npm run 来将参数传递给您的脚本,然后是参数. 示例:给定脚本 &quot;mocha&quot;: &quot;mocha&quot;,您可以运行 npm run mocha -- --reporter xunit. 这有效地运行了 mocha --reporter xunit .
  • 运行 npm test 与运行 npm run test 相同. 这同样适用于 npm startnpm stop.
  • 你可以运行npm run<script> -s to silence the default npm output (useful for calling a script within another script).

Contributing

See CONTRIBUTING.md.