@gravito/scaffold 4.0.0 → 4.1.2
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 +30 -6
- package/dist/index.cjs +2959 -260
- package/dist/index.d.cts +240 -3
- package/dist/index.d.ts +240 -3
- package/dist/index.js +2956 -260
- package/package.json +5 -2
package/README.md
CHANGED
|
@@ -34,13 +34,29 @@ const result = await scaffold.generate()
|
|
|
34
34
|
console.log(`Created ${result.filesCreated} files`)
|
|
35
35
|
```
|
|
36
36
|
|
|
37
|
-
##
|
|
37
|
+
## ✨ Key Features
|
|
38
38
|
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
39
|
+
- 🪐 **Galaxy-Ready Scaffolding**: Native integration with the Gravito CLI to bootstrap new Satellites and Orbits instantly.
|
|
40
|
+
- 🏗️ **Architectural Blueprints**: Built-in support for **DDD**, **Clean Architecture**, and **Enterprise MVC** patterns.
|
|
41
|
+
- 🧩 **Satellite Templates**: Generate isolated, "plug-and-play" domain units with correct directory structures.
|
|
42
|
+
- 🛠️ **Stub Generator**: Highly customizable Handlebars-based engine for generating boilerplate-free code.
|
|
43
|
+
- 📂 **Directory Integrity**: Ensures that every new module follows the strict dependency rules of the Galaxy.
|
|
44
|
+
|
|
45
|
+
## 🌌 Role in Galaxy Architecture
|
|
46
|
+
|
|
47
|
+
In the **Gravito Galaxy Architecture**, Scaffold acts as the **Blueprint Engine (Constructive Core)**.
|
|
48
|
+
|
|
49
|
+
- **Galaxy Expansion**: Provides the "DNA" for creating new planets (Satellites) within the ecosystem, ensuring that every new piece of code is consistent with the framework's standards.
|
|
50
|
+
- **Structural Enforcement**: Automates the creation of `manifest.json`, `src/index.ts`, and `tests/` directories, preventing architectural drift.
|
|
51
|
+
- **Developer Onboarding**: Lowers the barrier to entry by providing ready-to-use "Starter Kits" for different domain complexities.
|
|
52
|
+
|
|
53
|
+
```mermaid
|
|
54
|
+
graph TD
|
|
55
|
+
CLI([Gravito CLI]) -- "init" --> Scaffold{Scaffold Engine}
|
|
56
|
+
Scaffold --> Blueprint[Architecture: DDD]
|
|
57
|
+
Blueprint --> S1[New Satellite: Orders]
|
|
58
|
+
Blueprint --> S2[New Orbit: Telemetry]
|
|
59
|
+
```
|
|
44
60
|
|
|
45
61
|
## Generators
|
|
46
62
|
|
|
@@ -110,6 +126,14 @@ export class MyCustomGenerator extends BaseGenerator {
|
|
|
110
126
|
}
|
|
111
127
|
```
|
|
112
128
|
|
|
129
|
+
## 📚 Documentation
|
|
130
|
+
|
|
131
|
+
Detailed guides and references for the Galaxy Architecture:
|
|
132
|
+
|
|
133
|
+
- [🏗️ **Architecture Overview**](./README.md) — Blueprint engine and structural integrity.
|
|
134
|
+
- [🏗️ **Galaxy Blueprints**](./doc/GALAXY_BLUEPRINTS.md) — **NEW**: DDD, Clean, and MVC starter kits.
|
|
135
|
+
- [🛠️ **Stub Customization**](#generators) — Building your own code generators.
|
|
136
|
+
|
|
113
137
|
## API Reference
|
|
114
138
|
|
|
115
139
|
### ScaffoldOptions
|