1# Data Model: Project Initialization
2
3**Date**: 2025-01-09  
4**Context**: Data structures for dumber project initialization
5
6## Core Entities
7
8### 1. Go Module Configuration
9**Purpose**: Represents the initialized Go module and its metadata
10
11**Structure**:
12```go
13type ModuleConfig struct {
14    Name         string `validate:"required"`           // "dumber"
15    Version      string `validate:"required,semver"`    // "v0.1.0"
16    GoVersion    string `validate:"required"`           // Go version requirement
17    Dependencies []Dependency `validate:"dive"`
18}
19
20type Dependency struct {
21    ImportPath string `validate:"required,uri"`        // e.g. "github.com/spf13/cobra"
22    Version    string `validate:"required"`            // "@latest" or specific version
23    Type       DependencyType `validate:"required"`    // runtime, dev, tool
24}
25
26type DependencyType int
27const (
28    RuntimeDep DependencyType = iota  // Core application dependencies
29    DevDep                           // Development/testing tools  
30    ToolDep                          // CLI tools (sqlc, wails)
31)
32```
33
34**Validation Rules**:
35- Module name must be valid Go identifier
36- Version must follow semantic versioning
37- All dependency paths must be valid import paths
38- No circular dependencies allowed
39
40### 2. Project Structure
41**Purpose**: Defines the directory layout and file organization
42
43**Structure**:
44```go
45type ProjectStructure struct {
46    RootPath     string `validate:"required,dir"`
47    Directories  []Directory `validate:"dive"`
48    ConfigFiles  []ConfigFile `validate:"dive"`
49    InitialFiles []InitialFile `validate:"dive"`
50}
51
52type Directory struct {
53    Path        string `validate:"required"`           // relative to root
54    Purpose     string `validate:"required"`           // description
55    Required    bool                                   // must be created
56}
57
58type ConfigFile struct {
59    Path        string `validate:"required"`           // relative to root
60    Template    string `validate:"required"`           // template name
61    Variables   map[string]string                      // template variables
62}
63
64type InitialFile struct {
65    Path     string `validate:"required"`              // relative to root
66    Content  string                                    // file content
67    Type     FileType `validate:"required"`           // go, sql, yaml, etc.
68}
69```
70
71### 3. Dependency Installation Status
72**Purpose**: Tracks installation progress and success/failure states
73
74**Structure**:
75```go
76type InstallationStatus struct {
77    ModuleName   string `validate:"required"`
78    Dependencies []DependencyStatus `validate:"dive"`
79    Tools        []ToolStatus `validate:"dive"`
80    Overall      StatusType `validate:"required"`
81    Timestamp    time.Time `validate:"required"`
82    Errors       []InstallError
83}
84
85type DependencyStatus struct {
86    ImportPath   string `validate:"required"`
87    Version      string
88    Status       StatusType `validate:"required"`
89    InstallTime  time.Duration                        // how long to install
90    Error        *InstallError
91}
92
93type ToolStatus struct {
94    Name         string `validate:"required"`          // "sqlc", "wails"
95    Command      string `validate:"required"`          // installation command
96    Status       StatusType `validate:"required"`
97    Version      string                                // installed version
98    Error        *InstallError
99}
100
101type StatusType int
102const (
103    NotStarted StatusType = iota
104    InProgress
105    Success
106    Failed
107    Skipped
108)
109
110type InstallError struct {
111    Message     string `validate:"required"`
112    Code        int
113    Suggestion  string                                 // helpful hint for user
114}
115```
116
117## State Transitions
118
119### Module Initialization Flow
120```
121Empty Directory → Module Init → Dependency Resolution → Tool Installation → Verification → Complete
122                     ↓              ↓                      ↓                ↓
123                  [go.mod]      [go.mod updated]      [tools available]  [build succeeds]
124```
125
126### Dependency Installation States
127```
128NotStarted → InProgress → Success
129             ↓
130             Failed (with retry option)
131```
132
133## Relationships
134
1351. **ModuleConfig** contains multiple **Dependencies**
1362. **ProjectStructure** defines where **ConfigFiles** are placed
1373. **InstallationStatus** tracks the progress of **ModuleConfig** setup
1384. Each **Directory** in **ProjectStructure** serves specific **Dependencies**
139
140## Validation Constraints
141
142### Business Rules
1431. **Module name uniqueness**: No conflicts with existing Go modules in workspace
1442. **Dependency compatibility**: All dependencies must support the same Go version
1453. **Tool availability**: Required tools (sqlc, wails) must be installable
1464. **Directory permissions**: All target directories must be writable
1475. **Disk space**: Adequate space for dependencies and generated files
148
149### Technical Constraints
1501. **Go version**: Must support generics (Go 1.18+)
1512. **CGO requirement**: SQLite driver requires CGO_ENABLED=1
1523. **System dependencies**: Wails requires WebKit2GTK development headers
1534. **Network access**: Dependency download requires internet connectivity
154
155## Integration Points
156
157### With CLI Commands
158- `dumber init` → Creates **ModuleConfig** and **ProjectStructure**
159- `dumber deps install` → Updates **InstallationStatus**
160- `dumber deps verify` → Validates all **Dependencies**
161
162### With Configuration Files
163- **go.mod**: Generated from **ModuleConfig**
164- **sqlc.yaml**: Generated from database **Dependencies**
165- **wails.json**: Generated from Wails **Dependencies**
166
167### With Testing Framework
168- Integration tests validate each **StatusType** transition
169- Contract tests verify **ConfigFile** template generation
170- Unit tests cover **Dependency** validation logic
171
172This data model supports the initialization phase while preparing for the next development phases (CLI implementation, database setup, browser integration).