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 |
assets/str_func_template.md
View on GitHub# [Feature Name] — Structure & Functions
> One-line summary of this feature module.
---
## File Tree
```
src/<feature-name>/
├── index.js # public boundary export
├── <feature>.tool.js # core logic
├── <feature>.test.js # tests
├── <feature>.schema.js # (if applicable)
└── <feature>.route.js # (if applicable)
```
---
## Module Responsibility
Describe in one paragraph what this module does and why it exists.
Include the business context — what problem it solves.
---
## Key Functions
| Function | Params | Returns | Description |
|----------|--------|---------|-------------|
| `exampleTool(input)` | `input: string` | `{ success: boolean, data: any }` | Main entry point |
| | | | |
### Function Details
#### `exampleTool(input)`
```js
// Usage example
const result = exampleTool('sample');
// → { success: true, data: 'sample' }
```
**Edge cases:**
- Empty input → returns `{ success: false, error: 'empty' }`
- Invalid type → throws TypeError
---
## Data Flow
```
Input → validate → process → format → Output
↓
side effect (e.g., DB write, API call)
```
---
## Dependencies
| Depends On | Import Path | Why |
|-----------|-------------|-----|
| `shared/formatter` | `../shared/formatter.js` | Output formatting |
| | | |
---
## Dependents (who imports this module)
| Module | What It Uses | Import Path |
|--------|-------------|-------------|
| `report/` | `exampleTool` | `../feature/index.js` |
| | | |
---
## Configuration
| Config Key | Default | Description |
|-----------|---------|-------------|
| | | |
Environment variables used:
- `API_KEY` — (describe purpose)
---
## Error Handling
| Error | Cause | Recovery |
|-------|-------|----------|
| `NetworkError` | API unreachable | Retry 3x with exponential backoff |
| | | |
---
## Sync Checklist
When modifying this module, also update:
- [ ] The repo's module-structure doc for this feature (or create one only if the repo already uses that convention)
- [ ] Any index/table-of-contents file that tracks module docs
- [ ] Other files that must stay in sync
---
## Changelog
| Date | Change | Author |
|------|--------|--------|
| YYMMDD | Initial creation | — |
---
*Keep this document concise, bounded, and task-oriented. Expand only when the feature's real surface area requires it.*
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: 470k | 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: 470k | 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: 470k | 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 |