在前端开发中，我们经常需要在命令行执行一些任务，如编译 CSS、JS、压缩文件或启动本地服务器等。npm 包 n-run 是一个非常实用的命令行工具，它可以简化我们的工作流，并提高开发效率。本文将详细介绍 n-run 的使用方法，并提供示例代码，让读者轻松掌握它的使用技巧。
什么是 n-run
n-run 是一个基于 Node.js 的命令行工具，可以帮助我们快速执行前端开发中的常见任务。它提供了一些内置任务，如文件复制、压缩、重命名、删除等，同时也支持我们自定义任务，让我们可以根据实际需求定制任务流程。
安装 n-run
在开始之前，我们需要先安装 n-run。打开终端并输入以下命令即可：
npm install -g n-run
安装完成后，我们就可以在命令行中使用 n-run 了。
n-run 的使用
n-run 的使用非常简单，我们只需要编写一个 YAML 配置文件，指定要执行的任务即可。
示例
以下是一个示例的 n-run 配置文件（n-run.yml）：
-- -------------------- ---- ------- ------ - ---- --------------- --------------- - ------ ------------ ------ -------------- -------- ---- ------ ----- - ------ -------------- -------- ------------------ ------ - ----- --------------- -- ------ ------ - ----- ------------- -- ------ ------ ------ - ----------- -- ---- ---- - ----- ----- - - ----- -----
上述配置文件定义了 4 个任务：build、watch、serve 和 dev。它们分别对应了不同的命令，并定义了命令需要执行的具体操作。
build：编译 Sass、打包 JS 并压缩代码。
watch：监听 src 目录下的 Sass 和 JS 文件，并在文件更新时自动执行 build 任务。
serve：启动一个本地服务器，监听 8080 端口并服务于 dist 目录内容。
dev：同时执行 watch 和 serve 任务，实现开发环境下的自动化构建和本地服务器启动。
执行任务
使用 n-run 执行任务非常简单，我们只需要在终端中输入以下命令：
n-run <task>
其中，<task> 是任务的名称。例如，要执行上述示例配置中的 build 任务，我们可以输入以下命令：
n-run build
n-run 会自动解析配置文件，并执行 build 任务中定义的所有命令。执行结束后，我们就可以在 dist 目录中看到编译和打包后的代码文件了。
自定义参数
有些任务可能需要根据不同的环境和情况传入不同的参数，例如压缩命令 terser 可以接受一些额外的参数来定制压缩行为。可以在 YAML 文件中定义参数，代码中通过 $params 获取。
以下是一个使用自定义参数的示例：
compress: - tar -czf $params.output $params.input - gzip $params.output
执行命令时可以传入参数，例如：
n-run compress --input data.txt --output data.tar.gz
这样就会自动将 data.txt 压缩并生成 data.tar.gz 文件。
查看任务列表
当我们定义了多个任务时，可以使用以下命令查看所有可用任务：
n-run list
n-run 会输出所有可用的任务列表，包括任务名称和任务描述。这可以帮助我们快速了解和调用需要执行的任务。
总结
n-run 是一个非常实用的前端开发工具，可以帮助我们简化工作流，提高开发效率。通过本文的介绍，读者可以快速学习并掌握 n-run 的使用方法，并结合自身需求和实践，灵活地定制和调整任务流程，让前端开发更加高效和快捷。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/67298