前端工程师在开发过程中常常需要一个本地静态服务器,用于测试页面及各种功能。现在介绍一款非常好用的 NPM 包:local-static-server,它是一个本地静态服务器,提供了许多功能和配置项,非常易用。
安装
使用 npm 安装即可:
npm install -g local-static-server
启动服务
安装后,在命令行中执行以下命令即可启动服务:
local-static-server
默认情况下,它会监听本地的 3000 端口。
配置项
local-static-server 有很多配置项,可以通过命令行参数或配置文件进行设置。
端口
通过 -p
参数指定端口号,如下设置监听 8080 端口:
local-static-server -p 8080
静态文件目录
在多数情况下,默认的当前目录即是网站根目录。但是,如果你想指定其它目录作为网站根目录,可以使用 -r
参数。例如:
local-static-server -r /home/user/my-website
自定义主页
local-static-server 默认的主页是 index.html
。如果你想使用其它文件作为主页,可以使用 -i
参数。例如:
local-static-server -i my-home.html
GZip 压缩
local-static-server 支持 GZip 压缩,只需在命令行中增加 -g
参数即可开启该功能:
local-static-server -g
MIME 类型
local-static-server 支持多种 MIME 类型。如果你想增加或修改 MIME 类型,可以使用 -m
参数并指定配置文件的路径。
如果你使用本地目录下的 mime.json
文件来设置 MIME 类型,可以这样设置:
local-static-server -m './mime.json'
mime.json 的格式如下:
-- -------------------- ---- ------- - ------ ------------- ------- ------------ ----- ------------------ ------ ----------- ------- ------------------- ------ ------------ ------ ------------- ------ ----------- -
示例代码
以下是一段示例代码,展示了如何在 Node.js 中使用 local-static-server:
-- -------------------- ---- ------- ----- ----------------- - ------------------------------- ----- ------ - ------------------- ----- ----- ----- ----------- ------ ------------- ----- ---- --- --------------- -- - ------------------- ------- -- ------------------------ ---
我们可以传入一个配置对象,包含了上述的所有配置项。最后,调用 start
方法来启动服务。当然,在这里你还可以添加更多额外的配置项。
结束语
local-static-server 的作者提供了非常详细的文档,我们可以在项目的 GitHub 主页中找到。这个工具非常实用,如果你常常需要搭建本地的测试服务器,建议使用它。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/6005608c81e8991b448debf0