verify-module

模块完整性校验关卡。扫描目录结构、检测缺失文档、验证代码与文档同步。当魔尊提到模块校验、文档检查、结构完整性、README检查、DESIGN检查时使用。在新建模块完成时自动触发。

155 stars

bytelagod

View on GitHub Installation ↓

Best use case

verify-module is best used when you need a repeatable AI agent workflow instead of a one-off prompt.

Teams using verify-module should expect a more consistent output, faster repeated execution, less prompt rewriting.

When to use this skill

You want a reusable workflow that can be run more than once with consistent structure.

When not to use this skill

You only need a quick one-off answer and do not need a reusable workflow.
You cannot install or maintain the underlying files, dependencies, or repository context.

Installation

Claude Code / Cursor / Codex

$curl -o ~/.claude/skills/verify-module/SKILL.md --create-dirs "https://raw.githubusercontent.com/telagod/code-abyss/main/skills/tools/verify-module/SKILL.md"

Manual Installation

Download SKILL.md from GitHub
Place it in .claude/skills/verify-module/SKILL.md inside your project
Restart your AI agent — it will auto-discover the skill

How verify-module Compares

Feature / Agent	verify-module	Standard Approach
Platform Support	Not specified	Limited / Varies
Context Awareness	High	Baseline
Installation Complexity	Unknown	N/A

Frequently Asked Questions

What does this skill do?

Where can I find the source code?

You can find the source code on GitHub using the link provided at the top of the page.

SKILL.md Source

# 模块完整性校验关卡

## 命令

```bash
node scripts/module_scanner.js <模块路径>
node scripts/module_scanner.js <模块路径> -v      # 详细
node scripts/module_scanner.js <模块路径> --json  # JSON
```

## 检测项

| 文件 | 缺失后果 |
|------|----------|
| `README.md` | 阻断交付 |
| `DESIGN.md` | 阻断交付 |
| `tests/` | 警告 |
| `__init__.py` | 提示 |

## 文档要求

README 须含：模块名与定位、存在理由、核心职责、依赖关系、快速使用示例
DESIGN 须含：设计目标、方案选择与理由、关键决策、已知限制、变更历史

## 触发条件

新建模块 | 模块重构 | 提交前

## 快速修复

缺文档时用 `/gen-docs <模块路径>` 生成骨架。