npm 包 `watch-server` 使用教程

阅读时长 4 分钟读完

简介

watch-server 是一个基于 Node.js 平台开发的 npm 包,可以监听本地文件的变动并启动一个 HTTP 服务器实时展示指定目录下的文件内容,适用于开发阶段的文件调试与展示。

安装

在安装之前,请先确保您已经安装了 Node.js 环境,如果没有安装,可以前往 官网 下载最新版本并进行安装。

安装 watch-server 的方式非常简单,只需要打开终端并输入以下命令即可:

命令说明:

  • -g 表示全局安装,可以在任意目录下使用 watch-server 命令。

使用说明

基本命令

安装完成后,使用 watch-server 命令即可启动 HTTP 服务器,例如:

此时,会默认监听 8080 端口,如果您需要使用其他端口,请使用 -p 参数指定,例如:

此时会监听 8888 端口。如果您只需要监听文件的变动,不需要启动 HTTP 服务器,可以使用 -w 参数,例如:

此时只会监听文件的变动,不会启动 HTTP 服务器。

高级命令

除了基本命令之外,watch-server 还提供了一些高级命令,可以更加灵活地控制文件的监听与展示。

指定监听目录

默认情况下,watch-server 会监听当前目录下的所有文件,包括子目录。如果您需要指定监听的目录,可以使用 -d 参数,例如:

此时 watch-server 会监听 /path/to/dir 目录下的所有文件。

指定展示的文件类型

默认情况下,watch-server 会展示监听目录下的所有文件,包括文件夹。如果您只需要展示某些特定类型的文件,可以使用 -t 参数,例如:

此时 watch-server 会展示监听目录下所有的 .js, .html.css 文件,其他文件将不会展示。

指定不监听的文件类型

-t 参数相反,watch-server 还提供了 -x 参数,可以指定不需要监听的文件类型,例如:

此时 watch-server 不会监听监听目录下所有的 .log, .tmp.bak 文件,其他文件将会监听。

指定忽略的文件或目录

如果您需要忽略某些文件或目录,可以使用 -i 参数,例如:

此时 watch-server 不会监听目录下的 node_moduleslog 文件夹,其他文件夹将会监听。

指定展示的文件数量

默认情况下,watch-server 会展示监听目录下的所有文件,如果您需要指定展示文件的数量,可以使用 -n 参数,例如:

此时 watch-server 会展示监听目录下的前 10 个文件,如果文件数量不足 10 个,则展示全部文件。

指定展示文件的顺序

默认情况下,watch-server 会按照文件名的字母顺序展示文件,如果您需要指定展示文件的顺序,可以使用 -o 参数,例如:

此时 watch-server 会按照文件名的字母顺序倒序展示文件,如果需要按照添加时间排序,可以使用 -o atime 参数。

示例代码

在使用 watch-server 的过程中,您还可以通过配置文件来控制文件的监听与展示。配置文件默认为当前目录下的 watch-server.json,如果需要自定义配置文件名,可以使用 -c 参数。

下面是示例配置文件的内容:

-- -------------------- ---- -------
-
  ------- -----
  -------- -----
  ------ ---------------
  ------- -
    -----
    -------
    -----
  --
  ---------- -
    ---------------
    -----
  --
  -------- ---
  -------- ------
-

以上是 watch-server 的使用说明,希望对您有所帮助。如果您有其他疑问,可以前往官方文档查看更多资料。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60056d1881e8991b448e6e4b

纠错
反馈