lidge-jun/codexclaw / plugins/codexclaw/skills/dev-scaffolding
cxc-dev-scaffolding
VerifiedUse for project/module setup and docs. Triggers: scaffold, structure audit, architecture docs, API docs, monorepo setup, 스캐폴딩, 새 프로젝트, 새 기능, 구조 점검, 모듈 추가.
| File | Kind | Size |
|---|---|---|
| SKILL.md | skill md | 2.0 KB |
| agents/openai.yaml | config | 178 B |
| assets/str_func_template.md | markdown | 2.4 KB |
| references/api-docs.md | markdown | 5.5 KB |
| references/external-scaffolding-evidence.md | markdown | 430 B |
| references/implementation-log.md | markdown | 5.5 KB |
| references/monorepo-tooling.md | markdown | 6.9 KB |
| references/scaffold-layout.md | markdown | 8.2 KB |
| references/scaffold-verification.md | markdown | 2.0 KB |
| references/source-of-truth-layout.md | markdown | 6.6 KB |
| scripts/scaffold-audit.shexecutable | script | 5.2 KB |
scripts/scaffold-audit.sh
View on GitHub#!/usr/bin/env bash
set -euo pipefail
# Usage: scaffold-audit.sh [project-path]
# Checks whether a project follows the structural scaffold rules in this skill.
DIR="${1:-.}"
PASS=0
FAIL=0
WARN=0
check() {
local label="$1" result="$2"
if [ "$result" = "pass" ]; then
echo " ✅ $label"
PASS=$((PASS + 1))
elif [ "$result" = "warn" ]; then
echo " ⚠️ $label"
WARN=$((WARN + 1))
else
echo " ❌ $label"
FAIL=$((FAIL + 1))
fi
}
echo "🔍 Auditing '$DIR' against structural scaffold rules"
echo ""
# 1. Feature-based structure (no controllers/models/services at src root)
BAD_DIRS=""
for d in controllers models services views helpers middlewares; do
[ -d "$DIR/src/$d" ] && BAD_DIRS="$BAD_DIRS $d"
done
if [ -n "$BAD_DIRS" ]; then
check "Feature-based (found type-based dirs:$BAD_DIRS)" "fail"
else
check "Feature-based structure" "pass"
fi
# Detect project type
IS_GO=false
[ -f "$DIR/go.mod" ] && IS_GO=true
# 2. Colocation — test files next to source files
if [ -d "$DIR/src" ]; then
if $IS_GO; then
GO_SRC=$(find "$DIR/src" -name "*.go" ! -name "*_test.go" ! -name "main.go" 2>/dev/null | wc -l | tr -d ' ')
if [ "$GO_SRC" -gt 0 ]; then
MISSING=0
while IFS= read -r gofile; do
TEST_FILE="${gofile%.go}_test.go"
[ ! -f "$TEST_FILE" ] && MISSING=$((MISSING + 1))
done < <(find "$DIR/src" -name "*.go" ! -name "*_test.go" ! -name "main.go" 2>/dev/null)
if [ "$MISSING" -eq 0 ]; then
check "Colocation (all Go files have tests)" "pass"
else
check "Colocation ($MISSING Go file(s) missing test)" "fail"
fi
else
check "Colocation (no Go source files yet)" "warn"
fi
else
TOOL_COUNT=$(find "$DIR/src" \( -name "*.tool.*" -o -name "*_tool.*" \) 2>/dev/null | wc -l | tr -d ' ')
if [ "$TOOL_COUNT" -gt 0 ]; then
MISSING=0
while IFS= read -r toolfile; do
TOOL_DIR=$(dirname "$toolfile")
BASE=$(basename "$toolfile" | sed -E 's/[._]tool\.[^.]+$//')
TESTS=$(find "$TOOL_DIR" -maxdepth 1 \( -name "${BASE}.test.*" -o -name "test_${BASE}.*" -o -name "${BASE}_test.*" \) 2>/dev/null | wc -l | tr -d ' ')
[ "$TESTS" -eq 0 ] && MISSING=$((MISSING + 1))
done < <(find "$DIR/src" \( -name "*.tool.*" -o -name "*_tool.*" \) 2>/dev/null)
if [ "$MISSING" -eq 0 ]; then
check "Colocation (all tools have tests)" "pass"
else
check "Colocation ($MISSING tool(s) missing colocated test)" "fail"
fi
else
check "Colocation (no tool files yet)" "warn"
fi
fi
else
check "Colocation (no src/ directory)" "fail"
fi
# 3. Public boundary exports (skip for Go — packages are boundaries)
if $IS_GO; then
check "Public boundary exports (Go packages = boundaries)" "pass"
elif [ -d "$DIR/src" ]; then
FEATURE_DIRS=$(find "$DIR/src" -mindepth 1 -maxdepth 1 -type d ! -name "shared" ! -name "__pycache__" 2>/dev/null)
if [ -n "$FEATURE_DIRS" ]; then
MISSING_BOUNDARY=0
while IFS= read -r fdir; do
[ ! -f "$fdir/index.js" ] && [ ! -f "$fdir/index.ts" ] && [ ! -f "$fdir/__init__.py" ] && MISSING_BOUNDARY=$((MISSING_BOUNDARY + 1))
done <<< "$FEATURE_DIRS"
if [ "$MISSING_BOUNDARY" -eq 0 ]; then
check "Public boundary exports" "pass"
else
check "Public boundary exports ($MISSING_BOUNDARY feature(s) missing index.js/index.ts/__init__.py)" "fail"
fi
else
check "Public boundary exports (no feature dirs yet)" "warn"
fi
else
check "Public boundary exports (no src/)" "fail"
fi
# 4. Source-of-truth docs (optional, convention-driven)
DOC_SIGNALS=0
for path in "$DIR/docs" "$DIR/plans" "$DIR/adr" "$DIR/architecture" "$DIR/README.md" "$DIR/AGENTS.md" "$DIR/CLAUDE.md"; do
[ -e "$path" ] && DOC_SIGNALS=$((DOC_SIGNALS + 1))
done
if [ "$DOC_SIGNALS" -gt 0 ]; then
check "Source-of-truth docs/signals present" "pass"
else
check "Source-of-truth docs/signals absent (optional for small repos)" "warn"
fi
# 5. No .env committed
if [ -f "$DIR/.env" ]; then
check "No .env committed (.env file found!)" "fail"
elif [ -f "$DIR/.env.example" ]; then
check ".env.example exists (no .env)" "pass"
else
check ".env.example missing" "warn"
fi
# 6. File length (<500 lines)
if [ -d "$DIR/src" ]; then
LONG_FILES=""
while IFS= read -r f; do
LINES=$(wc -l < "$f" | tr -d ' ')
[ "$LINES" -gt 500 ] && LONG_FILES="$LONG_FILES $(basename "$f"):${LINES}L"
done < <(find "$DIR/src" -type f \( -name "*.js" -o -name "*.ts" -o -name "*.py" -o -name "*.go" \) 2>/dev/null)
if [ -n "$LONG_FILES" ]; then
check "File length (<500L) — violations:$LONG_FILES" "fail"
else
check "File length (all <500 lines)" "pass"
fi
fi
# 7. Agent/context instructions (optional but recommended)
if [ -f "$DIR/AGENTS.md" ] || [ -f "$DIR/CLAUDE.md" ]; then
check "Agent/context instructions present" "pass"
else
check "Agent/context instructions missing" "warn"
fi
echo ""
echo "━━━━━━━━━━━━━━━━━━━━━━━"
echo " ✅ Pass: $PASS ⚠️ Warn: $WARN ❌ Fail: $FAIL"
TOTAL=$((PASS + WARN + FAIL))
[ "$TOTAL" -gt 0 ] && SCORE=$((PASS * 100 / TOTAL)) || SCORE=0
echo " Score: ${SCORE}%"
echo "━━━━━━━━━━━━━━━━━━━━━━━"
[ "$FAIL" -gt 0 ] && exit 1 || exit 0
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| rea-analysis-optimizationmorluto/reaOptimize REA providers and shared analysis workflows for agent context, latency, CPU, and memory while preserving correctness and Evidence. Use for analysis bottlenecks and cache or query design; CI/test-suite optimization belongs to rea-ci-tests-audit. | Stars: 469k | Updated | Claude CodeCodex | Verified | Install |
| rea-ci-tests-auditmorluto/reaAudit REA CI and test suites for correctness, fixture drift, false passes, and measured performance; use for suite or workflow investigations and efficiency changes, rather than ordinary feature testing or a single test failure. | Stars: 469k | Updated | Claude CodeCodex | Verified | Install |
| rea-tool-designmorluto/reaAudit, investigate, design, or change REA investigation tools, CLI/MCP contracts, provider capabilities, and Evidence semantics. | Stars: 469k | Updated | Claude CodeCodex | Verified | Install |
| ponytail-auditDietrichGebert/ponytailQuality audit of the whole repo: bugs, security, real load, missing tests, speed, and what to delete. Most important first. | Stars: 194k | Updated | Claude CodeCodex | Verified | Install |