nuxt-gin-tools

nuxt-gin-tools 🧰

nuxt-gin-tools is the companion CLI for nuxt-gin-starter, built to make Nuxt + Gin development feel like one coherent workflow instead of two separate toolchains.

Quick Jump:

• English
• 中文

English

✨ Highlights

• 🚀 One command to run Nuxt dev + Go watcher together
• 🔁 Automatic Go restart on file changes with chokidar
• 📦 Build-and-pack workflow for deployment artifacts
• 🧩 nuxt-gin.config.ts support with typed config helper
• 🛡️ Config validation with warn and error feedback
• 🔧 Useful CLI switches for partial workflows like --skip-go
• 🎨 Colorful command banners and clearer terminal feedback
• 📋 Fancy end-of-command summaries that show what just changed

📦 Install

pnpm add -D nuxt-gin-tools

or

bun add -d nuxt-gin-tools

⚡ Quick Start

# optional bootstrap
nuxt-gin install

# start Nuxt + Go together
nuxt-gin dev

Common variants:

# frontend only
nuxt-gin dev --skip-go

# go watcher only
nuxt-gin dev --skip-nuxt

# skip cleanup / bootstrap checks
nuxt-gin dev --no-cleanup

🧱 Source Layout

src/
├── assets/
│   ├── go-gin-server.json
│   ├── pack-config.schema.json
│   └── server-config.schema.json
├── cli/
│   ├── commands/
│   │   ├── build.ts
│   │   ├── cleanup.ts
│   │   ├── develop.ts
│   │   ├── install.ts
│   │   └── update.ts
│   ├── options.ts
│   └── terminal-ui.ts
├── config/
│   └── package-manager.ts
├── services/
│   ├── build-service.ts
│   ├── go-dev-service.ts
│   └── pack-service.ts
├── system/
│   └── ports.ts
├── nuxt-config.ts
├── nuxt-gin.ts
└── pack.ts

Responsibility split:

• src/cli: command entrypoints, option parsing, terminal output
• src/config: CLI configuration helpers
• src/services: build, pack, and Go watcher implementation
• src/system: low-level system helpers such as port cleanup
• src/assets: JSON resources and schemas shipped in the package
• src/nuxt-config.ts, src/nuxt-gin.ts, src/pack.ts: public helper modules for consumers

🗂️ Commands

nuxt-gin dev

Runs the local development stack:

• Nuxt: npx nuxt dev --port=<nuxtPort> --host
• Go: watches files and restarts go run main.go
• prints a styled command banner before startup

Flags:

• --skip-go: start Nuxt only
• --skip-nuxt: start Go only
• --no-cleanup: skip pre-cleanup and bootstrap checks

nuxt-gin install

Bootstraps the project:

• always runs npx nuxt prepare
• if Go is available, also runs go mod download && go mod tidy
• prints a styled command banner before execution

Options:

• --skip-go: skip Go dependency bootstrap
• --skip-nuxt: skip Nuxt prepare

nuxt-gin build

Runs the build-and-pack flow.

Terminal output includes:

• a styled command banner at startup
• the final .7z archive path after packing
• the bundle directory path used to assemble the release

Flags:

• --skip-go: skip Go build
• --skip-nuxt: skip Nuxt static build
• --skip-build: skip the build step and only assemble/package existing artifacts
• --skip-zip: skip .7z creation and only prepare the bundle directory
• --binary-name <name>: override the Go binary name under .build/.server

nuxt-gin cleanup

Removes generated temp files and build output.

Also prints a styled command banner before cleanup starts.

Options:

• --dry-run: print what would be removed without deleting anything

nuxt-gin update

Updates project dependencies with a conservative default strategy:

• Node: package manager is controlled by --package-manager, default auto
• Go: go get -u=patch ./... && go mod tidy

Options:

• --package-manager <auto|bun|pnpm|yarn|npm|cnpm>: package manager selection, default auto
• --latest <true|false>: whether to use the aggressive update strategy, default false
• --skip-go: skip Go dependency updates
• --skip-node: skip Node dependency updates

Examples:

nuxt-gin update
nuxt-gin update --package-manager bun --latest true
nuxt-gin update --package-manager pnpm --latest false
nuxt-gin update --package-manager yarn --latest true
nuxt-gin update --package-manager cnpm --latest false

Also prints a styled command banner before execution.

🧩 nuxt-gin.config.ts

nuxt-gin commands can auto-load project config from the root with this priority:

1. nuxt-gin.config.ts
2. nuxt-gin.config.js
3. nuxt-gin.config.cjs
4. nuxt-gin.config.mjs
5. nuxt-gin.config.json

If multiple config files exist, the CLI prints a warn and uses the first one by priority.

Recommended TypeScript form:

import createNuxtGinConfig from 'nuxt-gin-tools/src/nuxt-gin';

export default createNuxtGinConfig({
  dev: {
    killPortBeforeDevelop: true,
  },
  goWatch: {
    include: {
      ext: ['go', 'tpl', 'html'],
    },
  },
  pack: {
    zipName: 'server.7z',
    extraFilesGlobs: ['prisma/**'],
  },
});

Legacy pack.config.* is still supported as a fallback for build, but nuxt-gin.config.* is now the primary entry.

Validation behavior:

• ❌ obvious type problems produce an error and stop packing
• ⚠️ ambiguous but survivable cases produce a warn
• 📝 example: if both zipPath and zipName are present, zipPath wins and a warning is shown

🧱 nuxt-gin.config.ts Helper

Use the helper from src/nuxt-gin.ts:

import createNuxtGinConfig from 'nuxt-gin-tools/src/nuxt-gin';

export default createNuxtGinConfig({
  dev: {
    killPortBeforeDevelop: true,
  },
  goWatch: {
    exclude: {
      dir: ['vendor', 'testdata'],
    },
  },
  pack: {
    serverPath: '.build/production/server',
    zipName: 'release.7z',
  },
});

It provides:

• NuxtGinConfig type
• createNuxtGinConfig(config) helper
• default export as createNuxtGinConfig

⚙️ Runtime Config

nuxt-gin.config.ts

dev, install, cleanup, update, and build can all read defaults from this file:

• dev: development command defaults
• goWatch: built-in Go watcher defaults
• install: bootstrap command defaults
• cleanup: cleanup command defaults
• update: dependency update defaults
• pack: build-and-pack defaults

server.config.json

server.config.json is still kept for Go runtime and packaged output:

• ginPort: Gin server port
• nuxtPort: Nuxt dev port
• baseUrl: Nuxt base URL

nuxt-gin build requires this file to exist in the project root.

Frontend Runtime Exposure

createDefaultConfig injects values into Nuxt runtimeConfig.public:

• public.ginPort: available in development, null in production
• public.isDevelopment: direct development flag

Example:

const config = useRuntimeConfig();
const ginPort = config.public.ginPort;
const isDevelopment = config.public.isDevelopment;

.go-watch.json

Go watcher defaults are built into src/services/go-dev-service.ts. You can set project-level defaults in nuxt-gin.config.ts with goWatch, and then optionally override them with .go-watch.json:

{
  "tmpDir": ".build/.server",
  "testDataDir": "testdata",
  "includeExt": ["go", "tpl", "html"],
  "includeDir": [],
  "includeFile": [],
  "excludeDir": [
    "assets",
    ".build/.server",
    "vendor",
    "testdata",
    "node_modules",
    "vue",
    "api",
    ".vscode",
    ".git"
  ],
  "excludeFile": [],
  "excludeRegex": ["_test.go"]
}

You can also point to a custom watcher config file:

NUXT_GIN_WATCH_CONFIG=/path/to/.go-watch.json

🖥️ Environment

• Node.js
• pnpm or bun
• Go, if you need the Gin side to run
• no extra generator dependency is required for the current command set

📝 Notes

• 💨 Go hot reload no longer depends on Air
• 👀 The current watcher model is chokidar + restart go run main.go
• 🪟 Packaging uses platform-aware executable naming: Windows defaults to .exe, Linux/macOS defaults to no extension
• 🌈 Main commands print a consistent banner and clearer success/info output in the terminal
• 📋 Commands also print a styled summary of the actions they performed; long-running dev commands print the startup summary before entering watch mode
• 📦 Both pnpm and bun are supported, but one working tree should stick to one package manager at a time

中文

✨ 功能亮点

• 🚀 一条命令同时启动 Nuxt 与 Go 开发环境
• 🔁 基于 chokidar 的 Go 文件监听与自动重启
• 📦 内置构建与打包流程，适合产物发布
• 🧩 支持 nuxt-gin.config.ts，并提供类型化 helper
• 🛡️ 对打包配置做校验，区分 warn 和 error
• 🔧 支持 --skip-go 等局部开发参数
• 🎨 提供更醒目的彩色命令行 banner 与输出提示
• 📋 命令结束时会打印更清晰的结果摘要

📦 安装

pnpm add -D nuxt-gin-tools

或

bun add -d nuxt-gin-tools

⚡ 快速开始

# 可选：初始化依赖
nuxt-gin install

# 同时启动前后端开发环境
nuxt-gin dev

常见变体：

# 仅启动前端
nuxt-gin dev --skip-go

# 仅启动 Go 监听
nuxt-gin dev --skip-nuxt

# 跳过预清理 / 预安装检查
nuxt-gin dev --no-cleanup

🧱 源码结构

src/
├── assets/
│   ├── go-gin-server.json
│   ├── pack-config.schema.json
│   └── server-config.schema.json
├── cli/
│   ├── commands/
│   │   ├── build.ts
│   │   ├── cleanup.ts
│   │   ├── develop.ts
│   │   ├── install.ts
│   │   └── update.ts
│   ├── options.ts
│   └── terminal-ui.ts
├── config/
│   └── package-manager.ts
├── services/
│   ├── build-service.ts
│   ├── go-dev-service.ts
│   └── pack-service.ts
├── system/
│   └── ports.ts
├── nuxt-config.ts
├── nuxt-gin.ts
└── pack.ts

职责划分：

• src/cli：命令入口、参数解析、终端输出
• src/config：CLI 配置解析
• src/services：构建、打包、Go watcher 执行逻辑
• src/system：端口清理等底层系统辅助能力
• src/assets：随 npm 包一起分发的 JSON 资源与 schema
• src/nuxt-config.ts、src/nuxt-gin.ts、src/pack.ts：给使用方直接 import 的 helper 模块

🗂️ 命令说明

nuxt-gin dev

启动本地开发环境：

• Nuxt：npx nuxt dev --port=<nuxtPort> --host
• Go：监听文件变化并重启 go run main.go
• 启动前会输出一段样式化 banner

参数：

• --skip-go：只启动 Nuxt
• --skip-nuxt：只启动 Go
• --no-cleanup：跳过 develop 前的 cleanup / bootstrap 检查

nuxt-gin install

用于初始化项目：

• 总是执行 npx nuxt prepare
• 检测到 Go 后，额外执行 go mod download && go mod tidy
• 执行前会输出一段样式化 banner

参数：

• --skip-go：跳过 Go 依赖初始化
• --skip-nuxt：跳过 Nuxt prepare

nuxt-gin build

执行构建与打包流程。

命令行输出会额外包含：

• 启动时的样式化 banner
• 打包完成后的 .7z 文件绝对路径
• 组装发布产物时使用的 bundle 目录路径

参数：

• --skip-go：跳过 Go 构建
• --skip-nuxt：跳过 Nuxt 静态构建
• --skip-build：跳过构建阶段，仅组装或打包现有产物
• --skip-zip：跳过 .7z 生成，仅准备 bundle 目录
• --binary-name <name>：覆盖 .build/.server 下的 Go 二进制名称

nuxt-gin cleanup

清理临时文件与构建产物。

执行前也会输出一段样式化 banner。

参数：

• --dry-run：只打印将要删除的内容，不真正删除

nuxt-gin update

按偏保守的默认策略更新依赖：

• Node：通过 --package-manager 控制，默认值为 auto
• Go：go get -u=patch ./... && go mod tidy

参数：

• --package-manager <auto|bun|pnpm|yarn|npm|cnpm>：指定包管理器，默认 auto
• --latest <true|false>：是否使用更激进的升级策略，默认 false
• --skip-go：跳过 Go 依赖更新
• --skip-node：跳过 Node 依赖更新

示例：

nuxt-gin update
nuxt-gin update --package-manager bun --latest true
nuxt-gin update --package-manager pnpm --latest false
nuxt-gin update --package-manager yarn --latest true
nuxt-gin update --package-manager cnpm --latest false

执行前也会输出一段样式化 banner。

🧩 nuxt-gin.config.ts

nuxt-gin 会自动读取项目根目录中的统一配置，优先级如下：

1. nuxt-gin.config.ts
2. nuxt-gin.config.js
3. nuxt-gin.config.cjs
4. nuxt-gin.config.mjs
5. nuxt-gin.config.json

如果同时存在多个配置文件，CLI 会输出 warn，并按优先级选择第一个。

推荐使用 TypeScript 写法：

import createNuxtGinConfig from 'nuxt-gin-tools/src/nuxt-gin';

export default createNuxtGinConfig({
  dev: {
    killPortBeforeDevelop: true,
  },
  goWatch: {
    include: {
      ext: ['go', 'tpl', 'html'],
    },
  },
  pack: {
    zipName: 'server.7z',
    extraFilesGlobs: ['prisma/**'],
  },
});

旧的 pack.config.* 仍可作为 build 的兼容兜底，但 nuxt-gin.config.* 已经成为主入口。

校验规则：

• ❌ 明显类型错误会直接 error 并终止打包
• ⚠️ 可继续执行但存在歧义的情况会输出 warn
• 📝 例如同时设置 zipPath 和 zipName 时，会提示 zipPath 优先生效

🧱 nuxt-gin.config.ts Helper

可通过 src/nuxt-gin.ts 使用 helper：

import createNuxtGinConfig from 'nuxt-gin-tools/src/nuxt-gin';

export default createNuxtGinConfig({
  dev: {
    killPortBeforeDevelop: true,
  },
  goWatch: {
    exclude: {
      dir: ['vendor', 'testdata'],
    },
  },
  pack: {
    serverPath: '.build/production/server',
    zipName: 'release.7z',
  },
});

它提供：

• NuxtGinConfig 类型
• createNuxtGinConfig(config) 函数
• 默认导出即 createNuxtGinConfig

⚙️ 运行时配置

nuxt-gin.config.ts

dev、install、cleanup、update、build 都可以从这个文件读取默认值：

• dev：开发命令默认行为
• goWatch：Go watcher 的默认规则
• install：初始化命令默认行为
• cleanup：清理命令默认行为
• update：包管理器与更新策略默认值
• pack：打包默认值

server.config.json

server.config.json 仍然保留，用于 Go 运行时与打包产物：

• ginPort：Gin 服务端口
• nuxtPort：Nuxt 开发端口
• baseUrl：Nuxt 的 base URL

nuxt-gin build 要求项目根目录中存在这个文件。

前端运行时暴露

createDefaultConfig 会把以下值注入 Nuxt runtimeConfig.public：

• public.ginPort：开发环境可读，生产环境为 null
• public.isDevelopment：当前是否为开发环境

示例：

const config = useRuntimeConfig();
const ginPort = config.public.ginPort;
const isDevelopment = config.public.isDevelopment;

.go-watch.json

Go watcher 的默认规则已经内置在 src/services/go-dev-service.ts。 你可以先在 nuxt-gin.config.ts 里通过 goWatch 设置项目级默认值，再用项目根目录的 .go-watch.json 做覆盖：

{
  "tmpDir": ".build/.server",
  "testDataDir": "testdata",
  "includeExt": ["go", "tpl", "html"],
  "includeDir": [],
  "includeFile": [],
  "excludeDir": [
    "assets",
    ".build/.server",
    "vendor",
    "testdata",
    "node_modules",
    "vue",
    "api",
    ".vscode",
    ".git"
  ],
  "excludeFile": [],
  "excludeRegex": ["_test.go"]
}

也支持通过环境变量指定自定义配置文件：

NUXT_GIN_WATCH_CONFIG=/path/to/.go-watch.json

🖥️ 环境依赖

• Node.js
• pnpm 或 bun
• Go，若需要运行 Gin 侧开发流程
• 当前命令集不再依赖额外的代码生成器

📝 说明

• 💨 Go 热更新不再依赖 Air
• 👀 当前 Go 开发监听方案为 chokidar + 重启 go run main.go
• 🪟 打包时会按平台生成可执行文件名：Windows 默认 .exe，Linux/macOS 默认无扩展名
• 🌈 主要命令会输出统一风格的 banner，并提供更清晰的成功 / 信息提示
• 📋 命令结束后会打印本次实际执行内容的摘要；dev 这类常驻命令会在进入监听前先打印启动摘要
• 📦 同一个工作副本建议固定使用一种包管理器，不要在同一套依赖目录里反复混用 pnpm 与 bun