archspec 1.3.0 → 1.5.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/README.md +119 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,119 @@
|
|
|
1
|
+
# archspec
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
Deterministic architecture governance scaffolding CLI.
|
|
8
|
+
|
|
9
|
+
`archspec` bootstraps a structured, layered architecture workflow into any repository.
|
|
10
|
+
|
|
11
|
+
It generates a decision-driven architecture governance system designed for reproducible, bottom-up system design.
|
|
12
|
+
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
## 🚀 Installation
|
|
16
|
+
|
|
17
|
+
Run without installing:
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
npx archspec init
|
|
21
|
+
````
|
|
22
|
+
|
|
23
|
+
Or install globally:
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
npm install -g archspec
|
|
27
|
+
archspec init
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
---
|
|
31
|
+
|
|
32
|
+
## 🛠 Usage
|
|
33
|
+
|
|
34
|
+
Initialize governance structure in the current directory:
|
|
35
|
+
|
|
36
|
+
```bash
|
|
37
|
+
archspec init
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
This creates:
|
|
41
|
+
|
|
42
|
+
```
|
|
43
|
+
architecture/
|
|
44
|
+
governance/
|
|
45
|
+
implementation/
|
|
46
|
+
execution/
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
Files are created only if they do not already exist.
|
|
50
|
+
|
|
51
|
+
---
|
|
52
|
+
|
|
53
|
+
## 🧠 Philosophy
|
|
54
|
+
|
|
55
|
+
archspec enforces:
|
|
56
|
+
|
|
57
|
+
* Decisions as the **only source of truth**
|
|
58
|
+
* Deterministic document generation
|
|
59
|
+
* Fixed architectural layer order
|
|
60
|
+
* Strict separation between:
|
|
61
|
+
|
|
62
|
+
* Architecture
|
|
63
|
+
* Governance
|
|
64
|
+
* Implementation
|
|
65
|
+
* Execution
|
|
66
|
+
|
|
67
|
+
If it is not a Decision, it is not architecture.
|
|
68
|
+
|
|
69
|
+
---
|
|
70
|
+
|
|
71
|
+
## 📐 Architecture Model
|
|
72
|
+
|
|
73
|
+
The system uses a fixed bottom-up layered structure:
|
|
74
|
+
|
|
75
|
+
1. Infra
|
|
76
|
+
2. DAL
|
|
77
|
+
3. Services
|
|
78
|
+
4. Controllers
|
|
79
|
+
5. Routes
|
|
80
|
+
6. API Service
|
|
81
|
+
7. FE Services
|
|
82
|
+
8. Context
|
|
83
|
+
9. Components
|
|
84
|
+
|
|
85
|
+
These layers are deterministic and must not be reordered.
|
|
86
|
+
|
|
87
|
+
---
|
|
88
|
+
|
|
89
|
+
## 🔄 Workflow
|
|
90
|
+
|
|
91
|
+
1. Propose architectural decisions
|
|
92
|
+
2. Validate decisions
|
|
93
|
+
3. Approve decisions
|
|
94
|
+
4. Regenerate architecture deterministically
|
|
95
|
+
|
|
96
|
+
`architecture.md` is always generated and must never be manually edited.
|
|
97
|
+
|
|
98
|
+
---
|
|
99
|
+
|
|
100
|
+
## 📦 Versioning
|
|
101
|
+
|
|
102
|
+
The generated structure is versioned through the CLI.
|
|
103
|
+
|
|
104
|
+
Upgrading `archspec` does not automatically modify existing folders.
|
|
105
|
+
|
|
106
|
+
Future updates may introduce migration commands.
|
|
107
|
+
|
|
108
|
+
---
|
|
109
|
+
|
|
110
|
+
## 📜 License
|
|
111
|
+
|
|
112
|
+
ISC
|
|
113
|
+
|
|
114
|
+
````
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
|