worclaude 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +278 -0
- package/package.json +62 -0
- package/src/commands/backup.js +55 -0
- package/src/commands/diff.js +76 -0
- package/src/commands/init.js +628 -0
- package/src/commands/restore.js +95 -0
- package/src/commands/status.js +141 -0
- package/src/commands/upgrade.js +208 -0
- package/src/core/backup.js +94 -0
- package/src/core/config.js +54 -0
- package/src/core/detector.js +43 -0
- package/src/core/file-categorizer.js +177 -0
- package/src/core/merger.js +413 -0
- package/src/core/scaffolder.js +60 -0
- package/src/data/agents.js +164 -0
- package/src/index.js +51 -0
- package/src/prompts/agent-selection.js +99 -0
- package/src/prompts/claude-md-merge.js +153 -0
- package/src/prompts/conflict-resolution.js +24 -0
- package/src/prompts/project-type.js +75 -0
- package/src/prompts/tech-stack.js +35 -0
- package/src/utils/display.js +41 -0
- package/src/utils/file.js +70 -0
- package/src/utils/hash.js +13 -0
- package/src/utils/time.js +22 -0
- package/templates/agents/optional/backend/api-designer.md +61 -0
- package/templates/agents/optional/backend/auth-auditor.md +63 -0
- package/templates/agents/optional/backend/database-analyst.md +61 -0
- package/templates/agents/optional/data/data-pipeline-reviewer.md +68 -0
- package/templates/agents/optional/data/ml-experiment-tracker.md +67 -0
- package/templates/agents/optional/data/prompt-engineer.md +75 -0
- package/templates/agents/optional/devops/ci-fixer.md +64 -0
- package/templates/agents/optional/devops/dependency-manager.md +55 -0
- package/templates/agents/optional/devops/deploy-validator.md +68 -0
- package/templates/agents/optional/devops/docker-helper.md +63 -0
- package/templates/agents/optional/docs/changelog-generator.md +69 -0
- package/templates/agents/optional/docs/doc-writer.md +60 -0
- package/templates/agents/optional/frontend/style-enforcer.md +47 -0
- package/templates/agents/optional/frontend/ui-reviewer.md +51 -0
- package/templates/agents/optional/quality/bug-fixer.md +54 -0
- package/templates/agents/optional/quality/performance-auditor.md +65 -0
- package/templates/agents/optional/quality/refactorer.md +61 -0
- package/templates/agents/optional/quality/security-reviewer.md +74 -0
- package/templates/agents/universal/build-validator.md +15 -0
- package/templates/agents/universal/code-simplifier.md +17 -0
- package/templates/agents/universal/plan-reviewer.md +20 -0
- package/templates/agents/universal/test-writer.md +17 -0
- package/templates/agents/universal/verify-app.md +16 -0
- package/templates/claude-md.md +40 -0
- package/templates/commands/commit-push-pr.md +9 -0
- package/templates/commands/compact-safe.md +8 -0
- package/templates/commands/end.md +9 -0
- package/templates/commands/review-plan.md +10 -0
- package/templates/commands/setup.md +112 -0
- package/templates/commands/start.md +3 -0
- package/templates/commands/status.md +6 -0
- package/templates/commands/techdebt.md +9 -0
- package/templates/commands/update-claude-md.md +9 -0
- package/templates/commands/verify.md +8 -0
- package/templates/mcp-json.json +3 -0
- package/templates/progress-md.md +21 -0
- package/templates/settings/base.json +64 -0
- package/templates/settings/docker.json +9 -0
- package/templates/settings/go.json +10 -0
- package/templates/settings/node.json +17 -0
- package/templates/settings/python.json +16 -0
- package/templates/settings/rust.json +11 -0
- package/templates/skills/templates/backend-conventions.md +57 -0
- package/templates/skills/templates/frontend-design-system.md +48 -0
- package/templates/skills/templates/project-patterns.md +48 -0
- package/templates/skills/universal/claude-md-maintenance.md +110 -0
- package/templates/skills/universal/context-management.md +71 -0
- package/templates/skills/universal/git-conventions.md +95 -0
- package/templates/skills/universal/planning-with-files.md +114 -0
- package/templates/skills/universal/prompt-engineering.md +97 -0
- package/templates/skills/universal/review-and-handoff.md +106 -0
- package/templates/skills/universal/subagent-usage.md +108 -0
- package/templates/skills/universal/testing.md +116 -0
- package/templates/skills/universal/verification.md +120 -0
- package/templates/spec-md-backend.md +85 -0
- package/templates/spec-md-cli.md +79 -0
- package/templates/spec-md-data.md +74 -0
- package/templates/spec-md-devops.md +87 -0
- package/templates/spec-md-frontend.md +81 -0
- package/templates/spec-md-fullstack.md +81 -0
- package/templates/spec-md-library.md +87 -0
- package/templates/spec-md.md +22 -0
- package/templates/workflow-meta.json +10 -0
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
# SPEC.md — {project_name}
|
|
2
|
+
|
|
3
|
+
## Product Overview
|
|
4
|
+
{description}
|
|
5
|
+
|
|
6
|
+
## Tech Stack
|
|
7
|
+
| Layer | Technology |
|
|
8
|
+
|------------------|-----------------------------------|
|
|
9
|
+
| Language | {tech_stack_table} |{docker_row}
|
|
10
|
+
| State Management | [e.g. Zustand, Redux, Pinia] |
|
|
11
|
+
| Styling | [e.g. Tailwind, CSS Modules] |
|
|
12
|
+
| Build Tool | [e.g. Vite, Webpack, Turbopack] |
|
|
13
|
+
| Testing | [e.g. Vitest, Playwright] |
|
|
14
|
+
| Deployment | [e.g. Vercel, Netlify, S3+CF] |
|
|
15
|
+
|
|
16
|
+
## Pages / Routes
|
|
17
|
+
| Path | Component | Purpose |
|
|
18
|
+
|-------------------|------------------|----------------------------------|
|
|
19
|
+
| `/` | HomePage | [Landing or main entry point] |
|
|
20
|
+
| `/login` | LoginPage | [User authentication] |
|
|
21
|
+
| `/dashboard` | DashboardPage | [Primary authenticated view] |
|
|
22
|
+
| `/[resource]` | [Resource]List | [Browse/search items] |
|
|
23
|
+
| `/[resource]/:id` | [Resource]Detail | [View single item] |
|
|
24
|
+
| `/settings` | SettingsPage | [User preferences] |
|
|
25
|
+
| [add routes...] | [Component] | [Purpose] |
|
|
26
|
+
|
|
27
|
+
## Component Architecture
|
|
28
|
+
```
|
|
29
|
+
App -> Layout (Navbar, Sidebar, Footer)
|
|
30
|
+
-> Pages -> [PageName] -> [FeatureSection] -> [Subcomponent]
|
|
31
|
+
-> Shared (Button, Input, Modal, Card, ...)
|
|
32
|
+
```
|
|
33
|
+
[Describe organization strategy: feature-based folders, atomic design, or flat]
|
|
34
|
+
|
|
35
|
+
## State Management
|
|
36
|
+
- **Global state:** [What lives in the global store — auth, theme, notifications]
|
|
37
|
+
- **Server state:** [How API data is cached — React Query, SWR, or manual]
|
|
38
|
+
- **Local state:** [Component-level state approach]
|
|
39
|
+
- **URL state:** [What is stored in query params — filters, pagination, tabs]
|
|
40
|
+
|
|
41
|
+
## Design System
|
|
42
|
+
| Token | Value |
|
|
43
|
+
|---------------|------------------------------------|
|
|
44
|
+
| Primary color | [e.g. #3B82F6] |
|
|
45
|
+
| Font family | [e.g. Inter, system-ui] |
|
|
46
|
+
| Base spacing | [e.g. 4px grid] |
|
|
47
|
+
| Border radius | [e.g. 8px default] |
|
|
48
|
+
| Breakpoints | [sm:640, md:768, lg:1024, xl:1280]|
|
|
49
|
+
|
|
50
|
+
- **Dark mode:** [Yes/No — implementation approach]
|
|
51
|
+
- **Accessibility:** [WCAG level target, e.g. AA]
|
|
52
|
+
- **Animations:** [Library or CSS transitions, motion-reduce support]
|
|
53
|
+
|
|
54
|
+
## API Integration
|
|
55
|
+
- **Base URL:** [e.g. `/api` or `https://api.example.com`]
|
|
56
|
+
- **Auth header:** [e.g. `Authorization: Bearer <token>`]
|
|
57
|
+
- **Error display:** [Toast notifications / inline errors / error pages]
|
|
58
|
+
- **Optimistic updates:** [Which actions, if any]
|
|
59
|
+
- **Offline support:** [Yes/No — strategy if yes]
|
|
60
|
+
|
|
61
|
+
## Implementation Phases
|
|
62
|
+
|
|
63
|
+
### Phase 1 — Foundation
|
|
64
|
+
- [ ] Project scaffolding with build tool
|
|
65
|
+
- [ ] Routing and layout shell
|
|
66
|
+
- [ ] Design tokens and global styles
|
|
67
|
+
- [ ] Shared UI components (Button, Input, Card, Modal)
|
|
68
|
+
|
|
69
|
+
### Phase 2 — Core Pages
|
|
70
|
+
- [ ] Authentication flow (login, signup, password reset)
|
|
71
|
+
- [ ] [Primary feature] page with data fetching
|
|
72
|
+
- [ ] [Secondary feature] page
|
|
73
|
+
- [ ] Navigation and breadcrumbs
|
|
74
|
+
|
|
75
|
+
### Phase 3 — Interactivity & Polish
|
|
76
|
+
- [ ] Forms with validation
|
|
77
|
+
- [ ] Search, filtering, and pagination
|
|
78
|
+
- [ ] Real-time updates and file uploads [if applicable]
|
|
79
|
+
- [ ] Responsive design, loading skeletons, error boundaries
|
|
80
|
+
- [ ] Accessibility audit and performance optimization
|
|
81
|
+
- [ ] E2E tests for critical user flows
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
# SPEC.md — {project_name}
|
|
2
|
+
|
|
3
|
+
## Product Overview
|
|
4
|
+
{description}
|
|
5
|
+
|
|
6
|
+
## Tech Stack
|
|
7
|
+
| Layer | Technology |
|
|
8
|
+
|-------------|-----------------------------------|
|
|
9
|
+
| Language | {tech_stack_table} |{docker_row}
|
|
10
|
+
| Backend | [Framework, e.g. Express, Django] |
|
|
11
|
+
| Database | [e.g. PostgreSQL, MongoDB] |
|
|
12
|
+
| Auth | [e.g. JWT, OAuth2, session-based] |
|
|
13
|
+
| Hosting | [e.g. Vercel, AWS, Railway] |
|
|
14
|
+
| CI/CD | [e.g. GitHub Actions] |
|
|
15
|
+
|
|
16
|
+
## Pages / Routes
|
|
17
|
+
| Path | Page/Component | Purpose | Auth Required |
|
|
18
|
+
|-----------------|------------------|----------------------------------|---------------|
|
|
19
|
+
| `/` | Home | [Landing page / dashboard] | No |
|
|
20
|
+
| `/login` | Login | [User authentication] | No |
|
|
21
|
+
| `/dashboard` | Dashboard | [Main authenticated view] | Yes |
|
|
22
|
+
| [add routes...] | [ComponentName] | [What the user accomplishes] | [Yes/No] |
|
|
23
|
+
|
|
24
|
+
## API Endpoints
|
|
25
|
+
| Method | Path | Purpose | Auth Required |
|
|
26
|
+
|--------|--------------------|----------------------------------|---------------|
|
|
27
|
+
| POST | `/api/auth/login` | [Authenticate user] | No |
|
|
28
|
+
| GET | `/api/users/me` | [Get current user profile] | Yes |
|
|
29
|
+
| GET | `/api/[resource]` | [List resources] | [Yes/No] |
|
|
30
|
+
| POST | `/api/[resource]` | [Create resource] | [Yes/No] |
|
|
31
|
+
| PUT | `/api/[resource]/:id` | [Update resource] | [Yes/No] |
|
|
32
|
+
| DELETE | `/api/[resource]/:id` | [Delete resource] | [Yes/No] |
|
|
33
|
+
|
|
34
|
+
## Data Model
|
|
35
|
+
### [PrimaryEntity]
|
|
36
|
+
| Field | Type | Constraints |
|
|
37
|
+
|-------------|-----------|----------------------------------|
|
|
38
|
+
| id | UUID | Primary key, auto-generated |
|
|
39
|
+
| [field] | [type] | [required, unique, default, etc] |
|
|
40
|
+
| created_at | Timestamp | Auto-set on creation |
|
|
41
|
+
| updated_at | Timestamp | Auto-set on update |
|
|
42
|
+
|
|
43
|
+
### [SecondaryEntity]
|
|
44
|
+
| Field | Type | Constraints |
|
|
45
|
+
|-------------|-----------|----------------------------------|
|
|
46
|
+
| id | UUID | Primary key, auto-generated |
|
|
47
|
+
| [field] | [type] | [constraints] |
|
|
48
|
+
| [foreign] | UUID | FK -> [PrimaryEntity].id |
|
|
49
|
+
|
|
50
|
+
## Authentication & Authorization
|
|
51
|
+
- **Method:** [JWT tokens / session cookies / OAuth2 provider]
|
|
52
|
+
- **Roles:** [e.g. admin, user, guest — describe what each can do]
|
|
53
|
+
- **Token storage:** [httpOnly cookie / localStorage — justify choice]
|
|
54
|
+
- **Session duration:** [e.g. 24h access token, 7d refresh token]
|
|
55
|
+
|
|
56
|
+
## Implementation Phases
|
|
57
|
+
|
|
58
|
+
### Phase 1 — Foundation
|
|
59
|
+
- [ ] Project scaffolding and dev environment
|
|
60
|
+
- [ ] Database schema and migrations
|
|
61
|
+
- [ ] Basic authentication flow (signup, login, logout)
|
|
62
|
+
- [ ] CI/CD pipeline
|
|
63
|
+
|
|
64
|
+
### Phase 2 — Frontend Shell
|
|
65
|
+
- [ ] Layout components (navbar, sidebar, footer)
|
|
66
|
+
- [ ] Routing and navigation
|
|
67
|
+
- [ ] Auth pages (login, signup, forgot password)
|
|
68
|
+
- [ ] Design system / component library setup
|
|
69
|
+
|
|
70
|
+
### Phase 3 — Backend Core
|
|
71
|
+
- [ ] CRUD endpoints for [primary resource]
|
|
72
|
+
- [ ] Input validation and error handling
|
|
73
|
+
- [ ] Authorization middleware
|
|
74
|
+
- [ ] [Additional domain logic]
|
|
75
|
+
|
|
76
|
+
### Phase 4 — Integration & Polish
|
|
77
|
+
- [ ] Connect frontend to backend APIs
|
|
78
|
+
- [ ] Real-time features, file uploads, third-party integrations [if applicable]
|
|
79
|
+
- [ ] Responsive design, loading states, error boundaries
|
|
80
|
+
- [ ] Performance optimization (caching, lazy loading)
|
|
81
|
+
- [ ] End-to-end tests, deployment, and monitoring setup
|
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
# SPEC.md — {project_name}
|
|
2
|
+
|
|
3
|
+
## Product Overview
|
|
4
|
+
{description}
|
|
5
|
+
|
|
6
|
+
## Tech Stack
|
|
7
|
+
| Layer | Technology |
|
|
8
|
+
|---------------|-----------------------------------|
|
|
9
|
+
| Language | {tech_stack_table} |{docker_row}
|
|
10
|
+
| Build | [e.g. tsup, rollup, setuptools] |
|
|
11
|
+
| Testing | [e.g. Vitest, pytest, Jest] |
|
|
12
|
+
| Docs | [e.g. TypeDoc, Sphinx, JSDoc] |
|
|
13
|
+
| Registry | [e.g. npm, PyPI, crates.io] |
|
|
14
|
+
| CI/CD | [e.g. GitHub Actions] |
|
|
15
|
+
|
|
16
|
+
## Public API
|
|
17
|
+
[List all exports that form the public contract. Internal helpers should not appear here.]
|
|
18
|
+
```
|
|
19
|
+
[functionName](param: Type, options?: OptionsType): ReturnType
|
|
20
|
+
— [Description. Throws: ErrorType when condition]
|
|
21
|
+
|
|
22
|
+
class [ClassName]
|
|
23
|
+
constructor(config: ConfigType)
|
|
24
|
+
[method](args): ReturnType — [description]
|
|
25
|
+
|
|
26
|
+
type [TypeName] = { [field]: Type; [field]?: Type }
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
## Configuration Options
|
|
30
|
+
| Option | Type | Default | Description |
|
|
31
|
+
|---------------|----------|------------|--------------------------------------|
|
|
32
|
+
| [option] | string | [default] | [What it controls] |
|
|
33
|
+
| [option] | boolean | `false` | [When to enable] |
|
|
34
|
+
| [option] | number | [default] | [Valid range and effect] |
|
|
35
|
+
| [add more...] | [type] | [default] | [description] |
|
|
36
|
+
|
|
37
|
+
## Usage Examples
|
|
38
|
+
```[language]
|
|
39
|
+
// Basic
|
|
40
|
+
import { [functionName] } from '{project_name}';
|
|
41
|
+
const result = [functionName]([exampleArgs]);
|
|
42
|
+
|
|
43
|
+
// With configuration
|
|
44
|
+
const instance = new [ClassName]({ /* [options] */ });
|
|
45
|
+
const output = instance.[method]([args]);
|
|
46
|
+
|
|
47
|
+
// Error handling
|
|
48
|
+
try { [functionName]([invalidArgs]); }
|
|
49
|
+
catch (error) { /* [ErrorType]: [message] */ }
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
## Compatibility Matrix
|
|
53
|
+
| Runtime/Version | Supported | Notes |
|
|
54
|
+
|------------------------|-----------|----------------------------|
|
|
55
|
+
| [Node.js >= 18] | Yes | [ESM and CJS] |
|
|
56
|
+
| [Node.js 16] | No | [Reason] |
|
|
57
|
+
| [Python >= 3.10] | Yes | [Type hints required] |
|
|
58
|
+
| [Browser (ESM)] | Yes | [Bundle size: ~N kB gzip] |
|
|
59
|
+
| [add environments...] | [Yes/No] | [notes] |
|
|
60
|
+
|
|
61
|
+
- **Module formats:** [ESM, CJS, UMD — which are shipped]
|
|
62
|
+
- **Type definitions:** [Bundled .d.ts / inline / separate package]
|
|
63
|
+
- **Peer dependencies:** [List any, with version ranges]
|
|
64
|
+
|
|
65
|
+
## Implementation Phases
|
|
66
|
+
|
|
67
|
+
### Phase 1 — Foundation
|
|
68
|
+
- [ ] Project scaffolding and build pipeline
|
|
69
|
+
- [ ] TypeScript / type setup and strict config
|
|
70
|
+
- [ ] Core function: [primary export]
|
|
71
|
+
- [ ] Unit tests for core function
|
|
72
|
+
- [ ] CI pipeline (lint, test, build)
|
|
73
|
+
|
|
74
|
+
### Phase 2 — Core API
|
|
75
|
+
- [ ] Remaining public functions and classes
|
|
76
|
+
- [ ] Configuration and options handling
|
|
77
|
+
- [ ] Error types and validation
|
|
78
|
+
- [ ] Comprehensive test coverage (>90%)
|
|
79
|
+
- [ ] JSDoc / docstrings for all exports
|
|
80
|
+
|
|
81
|
+
### Phase 3 — Distribution
|
|
82
|
+
- [ ] Bundle optimization (tree-shaking, size budget)
|
|
83
|
+
- [ ] Generated API documentation
|
|
84
|
+
- [ ] README with usage examples
|
|
85
|
+
- [ ] CHANGELOG setup (conventional commits)
|
|
86
|
+
- [ ] Publish to registry (npm/PyPI)
|
|
87
|
+
- [ ] Integration tests with real consumers
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# SPEC.md — {project_name}
|
|
2
|
+
|
|
3
|
+
## Product Overview
|
|
4
|
+
{description}
|
|
5
|
+
|
|
6
|
+
## Core Features
|
|
7
|
+
[Define your features here]
|
|
8
|
+
|
|
9
|
+
## Technical Architecture
|
|
10
|
+
[Describe your architecture]
|
|
11
|
+
|
|
12
|
+
## API / Interface Design
|
|
13
|
+
[Define interfaces]
|
|
14
|
+
|
|
15
|
+
## Data Model
|
|
16
|
+
[Define data structures]
|
|
17
|
+
|
|
18
|
+
## Implementation Phases
|
|
19
|
+
[Break work into phases]
|
|
20
|
+
|
|
21
|
+
## Design Decisions
|
|
22
|
+
[Document key decisions and rationale]
|