开发

贡献指南

了解如何为 Nuxt DevTools 做贡献。

嗨!我们很高兴你对为 Nuxt DevTools 做贡献感兴趣!在提交你的贡献之前,请仔细阅读以下指南。

单仓库

Nuxt DevTools 仓库是一个使用 pnpm 工作区的单仓库。用于安装和链接依赖项的包管理器必须是 pnpm.

克隆仓库后,在根目录下运行。

pnpm i
pnpm run build
Nuxt DevTools 使用 pnpm v8。如果您正在处理多个使用不同版本 pnpm 的项目,建议您通过运行 corepack enable 启用 Corepack.

此仓库包含以下包

  • @nuxt/devtools: Nuxt DevTools 模块
  • @nuxt/devtools-ui-kit: Nuxt DevTools 使用的 UI 工具包,以及模块作者构建用于 DevTools 交互的 UI

DevTools

大多数脚本都转发到根目录下的 package.json。您可以在根目录中运行 pnpm dev 以启动开发服务器(Nuxt DevTools 在它自己的客户端 UI 之上)。

或者,您可以 cd packages/devtools 并运行 pnpm dev 以启动开发服务器。

UI 工具包

通常,当您开发 Nuxt DevTools 时,UI 工具包中的组件已经获得了 HMR 功能。但是,如果您想开发 UI 工具包本身,您可以运行 cd packages/devtools-ui-kit 并运行 pnpm dev 以启动 UI 工具包的游乐场。

尝试本地更改

如果您想在其他 Nuxt 项目中尝试您的本地更改,可以使用根目录下的 local.ts 模块。

在您任何 Nuxt 项目中将 @nuxt/devtools 更改为该模块的绝对路径,允许您直接从源代码本地尝试 Nuxt DevTools。HMR 支持前端客户端。

例如,如果您将此仓库克隆到 /users/me/nuxt-devtools,更新您的 nuxt.config.ts

nuxt.config.ts
export default defineNuxtConfig({
  modules: [
-   '@nuxt/devtools',
+   '/users/me/nuxt-devtools/local',
  ]
})

在模块代码中,直接使用源 TypeScript 文件,因此您不需要每次都构建。但是,由于 Node.js 模块缓存,您需要重新启动应用程序才能看到模块端的变化。