lm-live-server

一个轻量级的本地开发服务器，支持文件监听和自动刷新功能。

特性

• 🚀 快速启动本地开发服务器
• 🔄 自动检测文件变化并刷新浏览器
• 📡 基于 WebSocket 实现实时通信
• 📁 支持自定义端口和监听目录
• 🎯 轻量级，无复杂配置

安装

方式1: 使用 npx（推荐，无需安装）

无需安装，直接使用：

# 使用默认配置
npx lm-live-server

# 指定端口
npx lm-live-server -p 8080

# 指定端口和目录
npx lm-live-server --port 8080 --root ./dist

方式2: 全局安装

npm install -g lm-live-server

安装后可以直接使用命令：

lm-live-server
# 或使用别名
limin-ols

方式3: 本地项目安装

npm install lm-live-server

然后在项目的 package.json 中添加 scripts：

{
  "scripts": {
    "dev": "lm-live-server",
    "dev:8080": "lm-live-server -p 8080",
    "dev:dist": "lm-live-server --root ./dist"
  }
}

然后使用：

npm run dev
npm run dev:8080
npm run dev:dist

使用方法

命令行使用

# 使用默认配置启动（端口6060，监听./public目录）
lm-live-server

# 或者使用别名
limin-ols

# 使用 npx（无需安装）
npx lm-live-server

# 指定端口
lm-live-server -p 8080
npx lm-live-server -p 8080

# 指定端口和监听目录
lm-live-server --port 8080 --root ./dist
npx lm-live-server --port 8080 --root ./dist

# 查看帮助
lm-live-server --help
npx lm-live-server --help

# 查看版本
lm-live-server --version
npx lm-live-server --version

命令行选项

• -p, --port <端口>: 指定服务器端口（默认: 6060）
• -r, --root <目录>: 指定监听目录（默认: ./public）
• -h, --help: 显示帮助信息
• -v, --version: 显示版本信息

作为模块使用

const { LiveServer, start } = require('lm-live-server');

// 方式1: 使用 start 函数
const server = start({
  port: 6060,
  root: './public'
});

// 方式2: 使用 LiveServer 类
const server = new LiveServer({
  port: 8080,
  root: './dist'
});
server.start();

// 停止服务器
server.stop();

工作原理

1. 启动一个 HTTP 服务器用于提供静态文件服务
2. 启动一个 WebSocket 服务器用于客户端通信
3. 使用 chokidar 监听文件变化
4. 当文件变化时，通过 WebSocket 通知所有连接的客户端刷新页面
5. 自动在 HTML 文件中注入 WebSocket 客户端脚本

项目结构

lm-live-server/
├── bin/
│   └── cli.js              # 命令行入口
├── lm-live-server.js       # 主模块
├── package.json
└── README.md

开发

# 克隆项目
git clone <repository-url>

# 安装依赖
npm install

# 测试本地命令
npm link

# 使用命令
lm-live-server

发布到 npm

# 登录 npm
npm login

# 发布
npm publish

# 如果是首次发布，可能需要添加 --access public
npm publish --access public

许可证

MIT

作者

LiMin