with one click
project-config
// [Utilities] Use when you need to scan workspace and update docs/project-config JSON to match current project structure.
// [Utilities] Use when you need to scan workspace and update docs/project-config JSON to match current project structure.
[HINT] Download the complete skill directory including SKILL.md and all related files
| name | project-config |
| description | [Utilities] Use when you need to scan workspace and update docs/project-config JSON to match current project structure. |
| disable-model-invocation | false |
Codex compatibility note:
- Invoke repository skills with
$skill-namein Codex; this mirrored copy rewrites legacy Claude/skill-namereferences.- Prefer the
plan-hardskill for planning guidance in this Codex mirror.- Task tracker mandate: BEFORE executing any workflow or skill step, create/update task tracking for all steps and keep it synchronized as progress changes.
- User-question prompts mean to ask the user directly in Codex.
- Ignore Claude-specific mode-switch instructions when they appear.
- Strict execution contract: when a user explicitly invokes a skill, execute that skill protocol as written.
- Subagent authorization: when a skill is user-invoked or AI-detected and its protocol requires subagents, that skill activation authorizes use of the required
spawn_agentsubagent(s) for that task.- Do not skip, reorder, or merge protocol steps unless the user explicitly approves the deviation first.
- For workflow skills, execute each listed child-skill step explicitly and report step-by-step evidence.
- If a required step/tool cannot run in this environment, stop and ask the user before adapting.
Codex does not receive Claude hook-based doc injection. When coding, planning, debugging, testing, or reviewing, open project docs explicitly using this routing.
Always read:
docs/project-config.json (project-specific paths, commands, modules, and workflow/test settings)docs/project-reference/docs-index-reference.md (routes to the full docs/project-reference/* catalog)docs/project-reference/lessons.md (always-on guardrails and anti-patterns)Situation-based docs:
backend-patterns-reference.md, domain-entities-reference.md, project-structure-reference.mdfrontend-patterns-reference.md, scss-styling-guide.md, design-system/README.mdfeature-docs-reference.mdintegration-test-reference.mde2e-test-reference.mdcode-review-rules.md plus domain docs above based on changed filesDo not read all docs blindly. Start from docs-index-reference.md, then open only relevant files for the task.
Goal: Scan workspace, update docs/project-config.json with accurate values.
IMPORTANT MUST ATTENTION follow Plan → Review → Execute workflow. IMPORTANT MUST ATTENTION use exact schema field names (--describe). IMPORTANT MUST ATTENTION validate after each phase. NEVER use classPattern/keyExtractor — correct fields: contentPattern/keyGroup.
Workflow: Recon → classify scale → $plan-hard → $plan-review → Execute phases (scan → merge → validate → fix) → Follow-up scans → $prompt-enhance
Key Rules:
node .claude/hooks/lib/project-config-schema.cjs --describe — use field names verbatimvalidateConfig(config) returns PASSED or errors[\\/] for cross-platform separator matching.claude/hooks/lib/project-config-schema.cjsMUST ATTENTION classify scale FIRST — drives task granularity for all subsequent phases.
find src/ -name "*.csproj" 2>/dev/null | wc -l
find src/ -name "package.json" -not -path "*/node_modules/*" 2>/dev/null | wc -l
find src/ -name "*.cs" 2>/dev/null | wc -l
ls -d src/*/ 2>/dev/null
| Scale | Signal | Task Approach |
|---|---|---|
| Small (<5) | Few modules | Combine 2a+2b, 2k+2l+2m — ~8 tasks |
| Medium (5–20) | Moderate count | One task per section — ~15 tasks |
| Large (20+) | Many service groups | Split 2a per service group — 20+ tasks |
Small projects: ask user to combine into single pass.
$plan-hard)Create plans/{date}-project-config-scan.md:
Phase template:
Phase A: Setup & Metadata — validate config, read schema, scan project metadata
Phase B: Module Discovery — backend projects, frontend apps/libs, framework keywords
Phase C: Context & UI — context groups, design system, styling, component system
Phase D: Testing & Infra — testing, E2E, databases, messaging, API, infrastructure
Phase E: Graph Connectors — API endpoints, implicit connections, referenceDocs
Phase F: Final Review — consolidate, validate, hook tests, create /scan-* tasks
Phase G: Self-Review — re-invoke $project-config to verify all config matches source code
$plan-review)Per phase: task tracking → scan → merge → validate → spot-check → fix → next phase.
Medium/large projects: mkdir -p.ai/workspace/project-config — write phase reports before merging. Delete after consolidation.
NEVER rename/remove/restructure top-level sections. NEVER change field types. NEVER populate deprecated v1 sections for new projects. NEVER remove v1 data from existing projects.
MAY add entries to maps/arrays, update values, add optional schema fields, populate v2 sections.
docs/project-config.json
├── schemaVersion, project{ name, description, languages[], packageManagers[], monorepoTool }
├── modules[] — { name, kind, pathRegex, description, tags[], meta{} }
├── contextGroups[] — { name, pathRegexes[], fileExtensions[], guideDoc, patternsDoc, stylingDoc, designSystemDoc, rules[] }
├── styling — { technology, guideDoc, appMap{}, patterns[] }
├── designSystem — { docsPath, modernUiNote, appMappings[] }
├── componentSystem — { type, selectorPrefixes[], filePattern, layerClassification{} }
├── framework — { name, backendPatternsDoc, frontendPatternsDoc, codeReviewDoc, integrationTestDoc, searchPatternKeywords[] }
├── testing — { frameworks[], filePatterns{}, commands{}, coverageTool, guideDoc }
├── e2eTesting — { framework, language, configFile, testsPath, pageObjectsPath, fixturesPath, ... }
├── databases{}, messaging{ broker, patterns[], consumerConvention }, api{ style, docsFormat, docsPath, authPattern }
├── infrastructure — { containerization, orchestration, cicd{ tool, configPath } }
├── graphConnectors — apiEndpoints{ enabled, frontend{ framework, paths[] }, backend{ framework, paths[], routePrefix } }
│ └── implicitConnections[] — { name, edgeKind, paths[], source{ filePattern, contentPattern, keyGroup }, target{...}, matchBy }
├── referenceDocs[] — { filename, purpose, sections[] }
├── integrationTestVerify — { guidance, referenceDocs[], quickRunCommand, testProjectPattern, testProjects[], systemCheckCommand, runScript, startupScript }
├── workflowPatterns — { architectureStyle, codeHierarchy, cssMethodology, stateManagement, crossModuleValidation, featureDocPath, featureDocTemplate, reviewRulesDoc }
└── DEPRECATED: backendServices, frontendApps, scss, componentFinder, sharedNamespace
MUST ATTENTION run
node .claude/hooks/lib/project-config-schema.cjs --describefor exact field names.
| Wrong | Correct |
|---|---|
classPattern, pattern, regex | contentPattern |
keyExtractor, captureGroup | keyGroup (number, not regex) |
pathRegex singular (in appMappings) | pathRegexes (array) |
designDoc, doc | docFile |
name, file (in referenceDocs) | filename |
examples | scssExamples |
"exact", "contains" | "key-equals", "key-contains" |
glob, fileGlob | filePattern |
# 0a. Validate current config
node -e "const{validateConfig,formatResult}=require('./.claude/hooks/lib/project-config-schema.cjs');const c=JSON.parse(require('fs').readFileSync('docs/project-config.json','utf-8'));console.log(formatResult(validateConfig(c)))"
# 0b. Read exact schema shapes (MANDATORY)
node .claude/hooks/lib/project-config-schema.cjs --describe
# 0c. Check CLAUDE.md
test -f CLAUDE.md && echo "EXISTS" || echo "MISSING"
# 0d. Create workspace
mkdir -p .ai/workspace/project-config
Read docs/project-config.json. Note populated vs skeleton sections.
Each subsection = one task tracking. Per task: investigate → report → merge → validate.
find src/ -name "*.csproj" -maxdepth 5 | head -50 # .NET
find . -name "pom.xml" -o -name "build.gradle" | head -50 # Java
find src/ -name "package.json" -not -path "*/node_modules/*" -maxdepth 4 | head -50 # Node
find . -name "go.mod" | head -50 # Go
Build modules[] entries: { name, kind, pathRegex, description, tags[], meta{} }
kind: "backend-service", "library", "framework"find . -name "nx.json" -o -name "angular.json" -o -name "lerna.json" -o -name "turbo.json" 2>/dev/null | head -5
ls -d src/*/apps/*/ */apps/*/ apps/*/ 2>/dev/null | head -20
ls -d src/*/libs/*/ */libs/*/ libs/*/ packages/*/ 2>/dev/null | head -30
Build entries: kind: "frontend-app" or kind: "library".
Detect languages (.cs→csharp, .ts→typescript, .py→python, .java→java, .go→go), package managers, monorepo tool.
Build project { name, description, languages[], packageManagers[], monorepoTool }.
Grep abstract class, interface I, most-imported symbols.
Build framework { name, searchPatternKeywords[] } from commonly used base classes.
Build contextGroups[] with pathRegexes[], fileExtensions[], patternsDoc, rules[].
Rules MUST ATTENTION be specific: "Use IPlatformRootRepository" not "follow best practices".
designSystem { docsPath, modernUiNote, appMappings[] }styling { technology, fileExtensions, guideDoc, appMap{}, patterns[] }componentSystem { type, selectorPrefixes[], filePattern, layerClassification{} }testing { frameworks[], filePatterns{}, commands{}, coverageTool, guideDoc }e2eTesting { framework, language, configFile, testsPath, pageObjectsPath, fixturesPath, runCommands{}, tcCodeFormat, entryPoints[] }integrationTestVerify { guidance, referenceDocs[], runScript, startupScript, quickRunCommand, systemCheckCommand, testProjectPattern, testProjects[] }integrationTestVerify.referenceDocs[] MUST contain project-specific docs that explain setup prerequisites before a verifier runs systemCheckCommand or test commands.databases {} (freeform)messaging { broker, patterns[], consumerConvention }api { style, docsFormat, docsPath, authPattern }infrastructure { containerization, orchestration, cicd{ tool, configPath } }Only if project has BOTH frontend AND backend.
| Frontend | Signal | Backend | Signal |
|---|---|---|---|
angular | @angular/core | dotnet | .csproj + Microsoft.AspNetCore |
react | react | spring | spring-boot-starter-web |
vue | vue | express | express in package.json |
generic | None | fastapi | fastapi in requirements.txt |
Route prefix: "api" for.NET/Spring, "" for Express/FastAPI.
Algorithm: scan source files → extract keys via contentPattern regex capture group keyGroup → scan target files → match keys via matchBy → create edgeKind edges.
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Unique rule identifier |
edgeKind | string | Yes | "MESSAGE_BUS", "TRIGGERS_EVENT", "PRODUCES_EVENT", or custom |
paths | string[] | No | Directories to scan |
source/target | object | Yes | { filePattern, contentPattern, keyGroup } |
matchBy | string | Yes | "key-equals" (exact) or "key-contains" (substring) |
source/target fields: filePattern (glob, e.g. "*.cs"), contentPattern (regex WITH capture group), keyGroup (1-based integer, default 1)
⛔ NEVER use classPattern, keyExtractor, pattern. ALWAYS use contentPattern, keyGroup.
EntityEventApplicationHandler< → entity-to-handler; EntityEventBusMessageProducer< → producer; PlatformApplicationMessageBusConsumer< → consumer{
"name": "entity-to-event-handlers",
"edgeKind": "MESSAGE_BUS",
"paths": ["src/Backend/MyApp.Domain/", "src/Backend/MyApp.Application/UseCaseEvents/"],
"source": { "filePattern": "*.cs", "contentPattern": "class\\s+(\\w+)\\s*:.*PlatformEntity<", "keyGroup": 1 },
"target": { "filePattern": "*.cs", "contentPattern": "EntityEventApplicationHandler<(\\w+)", "keyGroup": 1 },
"matchBy": "key-contains"
}
IMPORTANT MUST ATTENTION present detected rules to user before writing. IMPORTANT MUST ATTENTION scope paths to relevant dirs (not repo root).
Build referenceDocs[] from docs/project-reference/: { filename, purpose, sections[] }
Merge section-by-section. Overwrite only with concrete scan findings. Large projects: merge incrementally.
file:line evidence)node .claude/hooks/tests/test-all-hooks.cjs| Reference Doc | Scan Skill |
|---|---|
project-structure-reference.md | $scan-project-structure (FIRST) |
backend-patterns-reference.md | $scan-backend-patterns |
seed-test-data-reference.md | $scan-seed-test-data |
design-system/ + scss-styling-guide.md + frontend-patterns-reference.md | $scan-ui-system |
integration-test-reference.md | $scan-integration-tests |
feature-docs-reference.md | $scan-feature-docs |
code-review-rules.md | $scan-code-review-rules |
e2e-test-reference.md | $scan-e2e-tests |
domain-entities-reference.md | $scan-domain-entities |
Then: $claude-md-init (LAST). Optionally: $graph-build.
Run $prompt-enhance on all generated/updated docs and CLAUDE.md. One task per file, parallel OK.
Re-invoke skill: $project-config Self review and verify everything again, ensure all is correct with current source code. Catches regressions and issues missed in first pass.
Report: sections updated vs unchanged, new modules discovered, path mismatches, follow-up tasks created.
[IMPORTANT] Use task tracking to break ALL work into small tasks BEFORE starting.
AI Mistake Prevention — Failure modes to avoid on every task:
Check downstream references before deleting. Deleting components causes documentation and code staleness cascades. Map all referencing files before removal. Verify AI-generated content against actual code. AI hallucinates APIs, class names, and method signatures. Always grep to confirm existence before documenting or referencing. Trace full dependency chain after edits. Changing a definition misses downstream variables and consumers derived from it. Always trace the full chain. Trace ALL code paths when verifying correctness. Confirming code exists is not confirming it executes. Always trace early exits, error branches, and conditional skips — not just happy path. When debugging, ask "whose responsibility?" before fixing. Trace whether bug is in caller (wrong data) or callee (wrong handling). Fix at responsible layer — never patch symptom site. Assume existing values are intentional — ask WHY before changing. Before changing any constant, limit, flag, or pattern: read comments, check git blame, examine surrounding code. Verify ALL affected outputs, not just the first. Changes touching multiple stacks require verifying EVERY output. One green check is not all green checks. Holistic-first debugging — resist nearest-attention trap. When investigating any failure, list EVERY precondition first (config, env vars, DB names, endpoints, DI registrations, data preconditions), then verify each against evidence before forming any code-layer hypothesis. Surgical changes — apply the diff test. Bug fix: every changed line must trace directly to the bug. Don't restyle or improve adjacent code. Enhancement task: implement improvements AND announce them explicitly. Surface ambiguity before coding — don't pick silently. If request has multiple interpretations, present each with effort estimate and ask. Never assume all-records, file-based, or more complex path.
Critical Thinking Mindset — Apply critical thinking, sequential thinking. Every claim needs traced proof, confidence >80% to act. Anti-hallucination: Never present guess as fact — cite sources for every claim, admit uncertainty freely, self-check output for errors, cross-reference independently, stay skeptical of own confidence — certainty without evidence root of all hallucination.
MUST ATTENTION apply critical thinking — every claim needs traced proof, confidence >80% to act. Anti-hallucination: never present guess as fact.
MUST ATTENTION apply AI mistake prevention — holistic-first debugging, fix at responsible layer, surface ambiguity before coding, re-read files after compaction.
IMPORTANT MUST ATTENTION classify project scale FIRST (Step 1) — drives all task granularity decisions.
IMPORTANT MUST ATTENTION plan first — recon → $plan-hard → $plan-review → execute. NEVER jump to scanning.
IMPORTANT MUST ATTENTION break into phases with review cycles — scan → merge → validate → spot-check → fix per phase.
IMPORTANT MUST ATTENTION use exact schema field names — run --describe, copy verbatim. NEVER guess.
IMPORTANT MUST ATTENTION validate after EACH phase — schema errors compound across phases.
NEVER use classPattern/keyExtractor — correct fields: contentPattern (regex) + keyGroup (number).
IMPORTANT MUST ATTENTION one task tracking per config section — NEVER monolithic scan.
IMPORTANT MUST ATTENTION Phase 7 self-review is MANDATORY — catches what every earlier phase missed.
Anti-Rationalization:
| Evasion | Rebuttal |
|---|---|
| "File looks simple, skip planning" | Planning catches scale mistakes and regressions. Apply anyway. |
| "Already know the schema" | Run --describe anyway — field names differ from memory. No proof = no check. |
| "Phase N looks fine, skip validate" | Schema errors compound across phases. Validate every phase, no exceptions. |
| "Self-review is redundant" | Phase 7 catches what every earlier phase missed. Never skip. |
| "Small project, skip task tracking" | Task tracking prevents drift on all project sizes. Always task tracking first. |
[TASK-PLANNING] Before acting, analyze task scope and systematically break it into small todo tasks and sub-tasks using task tracking.
Source: .claude/hooks/lib/prompt-injections.cjs + .claude/.ck.json
$workflow-start <workflowId> for standard; sequence custom steps manually[CRITICAL] Hard-won project debugging/architecture rules. MUST ATTENTION apply BEFORE forming hypothesis or writing code.
Goal: Prevent recurrence of known failure patterns — debugging, architecture, naming, AI orchestration, environment.
Top Rules (apply always):
ExecuteInjectScopedAsync for parallel async + repo/UoW — NEVER ExecuteUowTaskwhere python/where py) — NEVER assume python/python3 resolvesExecuteInjectScopedAsync, NEVER ExecuteUowTask. ExecuteUowTask creates new UoW but reuses outer DI scope (same DbContext) — parallel iterations sharing non-thread-safe DbContext silently corrupt data. ExecuteInjectScopedAsync creates new UoW + new DI scope (fresh repo per iteration).AccountUserEntityEventBusMessage = Accounts owns). Core services (Accounts, Communication) are leaders. Feature services (Growth, Talents) sending to core MUST use {CoreServiceName}...RequestBusMessage — never define own event for core to consume.HrManagerOrHrOrPayrollHrOperationsPolicy names set members, not what it guards. Add role → rename = broken abstraction. Rule: names express DOES/GUARDS, not CONTAINS. Test: adding/removing member forces rename? YES = content-driven = bad → rename to purpose (e.g., HrOperationsAccessPolicy). Nuance: "Or" fine in behavioral idioms (FirstOrDefault, SuccessOrThrow) — expresses HAPPENS, not membership.python/python3 resolves — verify alias first. Python may not be in bash PATH under those names. Check: where python / where py. Prefer py (Windows Python Launcher) for one-liners, node if JS alternative exists.Test-specific lessons →
docs/project-reference/integration-test-reference.mdLessons Learned section. Production-code anti-patterns →docs/project-reference/backend-patterns-reference.mdAnti-Patterns section. Generic debugging/refactoring reminders → System Lessons in.claude/hooks/lib/prompt-injections.cjs.
ExecuteInjectScopedAsync, NEVER ExecuteUowTask (shared DbContext = silent data corruption){CoreServiceName}...RequestBusMessagepython/python3 resolves — run where python/where py first, use py launcher or nodeBreak work into small tasks (task tracking) before starting. Add final task: "Analyze AI mistakes & lessons learned".
Extract lessons — ROOT CAUSE ONLY, not symptom fixes:
$learn.$code-review/$code-simplifier/$security/$lint catch this?" — Yes → improve review skill instead.$learn.
[TASK-PLANNING] [MANDATORY] BEFORE executing any workflow or skill step, create/update task tracking for all planned steps, then keep it synchronized as each step starts/completes.