WireSpy 使用教程

WireSpy 使用教程

wire-spy WireSpy—a sleek new debug bar for Livewire 项目地址: https://gitcode.com/gh_mirrors/wi/wire-spy

1. 项目的目录结构及介绍

WireSpy 是一个为 Laravel 的 Livewire 开发者设计的调试工具。以下是项目的目录结构及其简要介绍：

wire-spy/
├── .github/               # GitHub 相关配置
├── config/                # 配置文件
├── resources/             # 资源文件，如样式表和脚本
├── src/                   # 核心代码目录
├── .gitignore             # Git 忽略文件
├── LICENSE.md             # 许可证文件
├── README.md              # 项目描述文件
├── build.js               # 构建脚本
├── composer.json          # Composer 配置文件
├── package-lock.json      # 包版本锁定文件
├── package.json           # npm 配置文件
├── postcss.config.js      # PostCSS 配置文件
└── tailwind.config.js     # Tailwind CSS 配置文件

• .github/: 包含 GitHub 工作流和其他 GitHub 相关配置。
• config/: 包含 WireSpy 的配置文件。
• resources/: 包含样式表（CSS）和脚本（JavaScript）等资源文件。
• src/: 包含 WireSpy 的核心代码。
• .gitignore: 指定 Git 忽略的文件和目录。
• LICENSE.md: 项目使用的 MIT 许可证。
• README.md: 项目的基本信息和说明。
• build.js: 用于构建项目资源的脚本。
• composer.json: 定义项目的依赖和 Composer 相关配置。
• package-lock.json: 确保安装的依赖版本一致。
• package.json: 定义项目的 npm 依赖和脚本。
• postcss.config.js: PostCSS 的配置文件。
• tailwind.config.js: Tailwind CSS 的配置文件。

2. 项目的启动文件介绍

WireSpy 的启动主要依赖于 Composer。在项目根目录下，运行以下命令来安装依赖：

composer install

安装完成后，你需要在 Laravel 项目中注册 WireSpy 服务提供者和路由。通常，这可以在 config/app.php 文件中完成：

'providers' => [
    // 其他服务提供者...
    WireElements\WireSpy\WireSpyServiceProvider::class,
],

'aliases' => [
    // 其他别名...
    'WireSpy' => WireElements\WireSpy\Facades\WireSpy::class,
],

接下来，发布配置文件和资源文件：

php artisan vendor:publish --provider="WireElements\WireSpy\WireSpyServiceProvider" --tag="config"

3. 项目的配置文件介绍

WireSpy 的配置文件位于 config/wire-spy.php。以下是配置文件的一些基本选项：

return [
    // 是否启用 WireSpy
    'enabled' => env('WIRE_SPY_ENABLED', true),

    // 用于切换 WireSpy 的快捷键，默认为 CMD+L 或 CTRL+L
    'toggleHotKey' => '<cmd+l>',

    // 是否启用热重载功能
    'hotReload' => true,
];

• 'enabled': 控制 WireSpy 是否启用。可以通过环境变量 WIRE_SPY_ENABLED 来覆盖此设置。
• 'toggleHotKey': 设置切换 WireSpy 的快捷键。
• 'hotReload': 控制是否启用热重载功能，这将自动刷新页面以反映组件文件的更改。

确保配置符合你的需求后，就可以开始使用 WireSpy 进行Livewire 应用的调试工作了。

wire-spy WireSpy—a sleek new debug bar for Livewire 项目地址: https://gitcode.com/gh_mirrors/wi/wire-spy