Tiny-LR 使用手册

Tiny-LR 使用手册

tiny-lrtiny livereload项目地址:https://gitcode.com/gh_mirrors/ti/tiny-lr

一、项目目录结构及介绍

Tiny-LR 是一个轻量级的 Livereload 服务器，它结合了静态文件服务器（仅脚本形式）和 WebSocket 功能，旨在简化前端开发中的页面自动刷新流程。以下是其典型的项目目录结构概览：

• bin: 包含可执行文件，如 tinylrs 的命令行入口。
• lib: 源代码库，存放核心功能实现，包括服务器逻辑等。
• test: 单元测试相关文件，用于确保软件质量。
• gitignore: 版本控制忽略文件列表。
• npmignore: 当发布到npm时，指定哪些文件或目录不需要被打包进去。
• travis.yml: 用于CI/CD流程的Travis CI配置文件。
• LICENSE: 许可证文件，说明该项目遵循的开放源代码许可协议。
• CHANGELOG.md: 更新日志，记录了项目的各个版本更新信息。
• index.js: 主入口文件，运行Tiny-LR服务器的核心逻辑。
• package.json: 项目配置文件，定义了项目的依赖、脚本命令和其他元数据。
• README.md: 项目快速入门指南，我们正在编写的文档将基于此提供更详细的信息。

二、项目的启动文件介绍

在Tiny-LR中，主要通过命令行工具来启动服务器。虽然实际的启动逻辑分散在lib目录下的多个文件中，但最终用户与之交互的是项目根目录下的bin/tinylrs这个脚本。用户无需直接操作这些内部文件，而是通过npm全局安装后的命令行指令进行操作，例如：

$ npm install -g tinylrs
$ tinylrs ' /your/watch/directory/**/* *'

这里的tinylrs就是启动命令，后面跟着监控目录的路径模式。这使得开发者能够轻松地开始监视指定目录下文件的变化，进而实现在浏览器中自动刷新的功能。

三、项目的配置文件介绍

Tiny-LR的配置主要是通过命令行参数进行设置的，它不直接使用一个独立的配置文件。这意味着配置是在启动服务时动态指定的。以下是一些关键配置项及其如何通过命令行指定：

• 监控目录 (-d, --dirs): 指定要监视更改的目录路径，可以是多个路径数组。

  tinylrs -d ' /dist/**/* js /dist/**/* css'
  

• 服务器端口 (-p, --port): 设置WebSocket服务器和静态文件服务器监听的端口号。

  tinylrs -d ' /your/watch/directory/**/* *' -p 35279
  

• Livereload脚本文件路径 (-l, --lrfile): 虽然默认提供了内置的LiveReload JS文件路径，但是可以通过此选项自定义。

  tinylrs --lrfile /path/to/custom/livereload.js
  

对于那些希望在自动化脚本或项目构建过程中集成Tiny-LR的人来说，可以在package.json的scripts部分定义命令，以达到更加便捷的集成目的。

通过这种方式，Tiny-LR提供了灵活且简洁的配置方法，无需额外的配置文件维护，使其易于上手和整合到现有工作流程中。

tiny-lrtiny livereload项目地址:https://gitcode.com/gh_mirrors/ti/tiny-lr