zig-project-structure

Files (1)

• SKILL.md

SKILL.md (first lines)

# Zig 项目结构管理

> 涵盖项目**创建**（生成标准骨架）与**检查**（验证合规性）全流程。

## Capability Boundaries

### ✅ 强项
1. 生成标准 Zig 项目骨架（`build.zig` + `build.zig.zon` + `src/`）
2. 支持四种项目模板：基础 exe、基础 lib、多模块分层项目、带第三方依赖项目
3. 检查项目目录结构是否符合 Zig 官方布局
4. 验证文件命名是否符合 `TitleCase.zig` / `snake_case.zig` 规范
5. 检查 `build.zig` API 是否使用了已移除的语法（如 `root_source_file`）
6. 检查 `build.zig.zon` 字段完整性（name、version、paths、minimum_zig_version）
7. 检测非标准目录/文件命名（TigerStyle 禁止的模糊命名如 `utils/`、`misc.zig`）
8. 输出结构化合规报告（错误/警告/信息三级）

### ⚠️ 前置要求
1. 已安装 Zig 编译器（推荐 ≥ 0.16.0）
2. 创建时确认目标 Zig 版本（运行 `zig version`）
3. 检查时项目根目录需包含 `build.zig` 或 `build.zig.zon`

### ❌ 不适用范围（替代方案）
1. 不用于编写项目逻辑代码 → 使用 `zig-0.16` 技能
2. 不用于代码逻辑/风格审查 → 使用 `zig-code-review` 或 `zig-tiger-style` 技能
3. 不用于游戏/图形开发 → 使用 `zig-raylib` 或 `zig-sdl3-bindings` 技能

## 何时使用

创建场景：
- "创建一个新的 Zig 项目"
- "创建一个多模块的 Zig 库项目"
- "帮我生成标准的 build.zig 和 build.zig.zon"
- "添加一个第三方依赖到项目"

检查场景：
- "检查我的 Zig 项目结构是否规范"
- "验证我的目录组织和文件命名是否符合 Zig 标准"
- "帮我审查 build.zig 和 build.zig.zon 的配置"
- "审计我的 Zig 项目合规性"

## Data Privacy

本技能不收集、存储或传输任何用户数据。所有代码生成和检查在本地完成。

---
# 第一部分：项目生成
## Workflow

步骤 1. **确认需求** — 项目名称？exe/lib？Zig 版本？是否需要依赖？
步骤 2. **选择模板** — 根据项目类型选择对应模板
步骤 3. **生成骨架** — 输出目录结构、build.zig、build.zig.zon、入口文件

## 模板一：基础可执行项目

```text
{project-name}/
├── build.zig
├── build.zig.zon
├── src/
│   └── main.zig
├── .gitignore
└── README.md
```

### `build.zig.zon`
```zig
.{
    .name = "{project-name}",
    .version = "0.1.0",
    .minimum_zig_version = "0.16.0",
    .dependencies = .{},
    .paths = .{ "build.zig", "build.zig.zon", "src" },
}
```

### `build.zig`
```zig
const std = @import("std");

pub fn build(b: *std.Build) void {
    const target = b.standardTargetOptions(.{});
    const optimize = b.standardOptimizeOption(.{});

    const exe = b.addExecutable(.{
        .name = "{project-name}",
        .root_module = b.createModule(.{
            .root_source_file = b.path("src/main.zig"),
            .target = target,
            .optimize = optimize,
        }),
    });
    b.installArtifact(exe);

    const run_cmd = b.addRunArtifact(exe);
    run_cmd.step.dependOn(b.getInstallStep());
    if (b.args) |args| run_cmd.addArgs(args);
    const run_step = b.step("run", "Run the application");
    run_step.dependOn(&run_cmd.step);
}
```

### `src/main.zig`
```zig
const std = @import("std");

pub fn main() void {
    std.debug.print("Hello from {s}!\n", .{"{project-name}"});
}

test "simple test" {
    try std.testing.expectEqual(2 + 2, 4);
}
```

## 模板二：库项目

使用 `src/root.zig` 作为公共 API 入口：

```text

From Yabuku-xD/omfx, MIT.

More from Yabuku-xD/omfx