skeleton-crew-runtime 0.3.1 → 0.3.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 +35 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,13 +1,23 @@
|
|
|
1
|
-
# Skeleton Crew Runtime v0.3.
|
|
1
|
+
# Skeleton Crew Runtime v0.3.2
|
|
2
2
|
|
|
3
3
|
**A minimal plugin runtime for building modular JavaScript applications.**
|
|
4
4
|
|
|
5
5
|
Stop wiring up infrastructure. Start building features.
|
|
6
6
|
|
|
7
7
|
```bash
|
|
8
|
-
npm install skeleton-crew-runtime@^0.3.
|
|
8
|
+
npm install skeleton-crew-runtime@^0.3.2
|
|
9
9
|
```
|
|
10
10
|
|
|
11
|
+
## What's New in v0.3.2
|
|
12
|
+
|
|
13
|
+
✅ **Service Locator API** - New `ctx.services` API for type-safe inter-plugin communication
|
|
14
|
+
✅ **Config Validation** - Validate plugin configuration before setup runs with detailed error reporting
|
|
15
|
+
📝 **Service Locator Guide** - New dedicated guide for using the Service Locator pattern
|
|
16
|
+
📝 **Logger Documentation** - Comprehensive guide to the built-in logging system
|
|
17
|
+
📊 **Optimized Telemetry** - Cleaner startup logs with consolidated plugin loading info
|
|
18
|
+
|
|
19
|
+
**[→ Complete v0.3.2 Features](CHANGELOG.md#032---2026-01-16)**
|
|
20
|
+
|
|
11
21
|
## What's New in v0.3.0
|
|
12
22
|
|
|
13
23
|
✅ **Config Validation** - Validate plugin configuration before setup runs with detailed error reporting
|
|
@@ -85,6 +95,7 @@ const runtime = new Runtime<MyConfig>({
|
|
|
85
95
|
- **[Your First Plugin](docs/getting-started/your-first-plugin.md)** - Build your first feature
|
|
86
96
|
- **[Logger Guide](docs/guides/logger-guide.md)** - Master the built-in logging system
|
|
87
97
|
- **[Config Validation](docs/guides/config-validation.md)** - How to validate plugin configuration
|
|
98
|
+
- **[Service Locator](docs/guides/service-locator-guide.md)** - Type-safe inter-plugin communication
|
|
88
99
|
|
|
89
100
|
### v0.2.0 Migration & Guides
|
|
90
101
|
- **[v0.1.x → v0.2.0 Migration](docs/guides/v0.1-to-v0.2-migration.md)** - Complete migration walkthrough
|
|
@@ -436,7 +447,28 @@ const ctx = runtime.getContext();
|
|
|
436
447
|
const { db, logger } = ctx.host;
|
|
437
448
|
```
|
|
438
449
|
|
|
439
|
-
### 7.
|
|
450
|
+
### 7. Service Locator (v0.3.1): Type-safe inter-plugin communication
|
|
451
|
+
|
|
452
|
+
Plugins can register and consume shared services without hard dependency coupling:
|
|
453
|
+
|
|
454
|
+
```typescript
|
|
455
|
+
// Plugin A: Register a service
|
|
456
|
+
setup(ctx) {
|
|
457
|
+
const myService = {
|
|
458
|
+
doSomething: () => console.log('Service in action!')
|
|
459
|
+
};
|
|
460
|
+
ctx.services.register('my-api', myService);
|
|
461
|
+
}
|
|
462
|
+
|
|
463
|
+
// Plugin B: Consume the service
|
|
464
|
+
setup(ctx) {
|
|
465
|
+
// Wait for the providing plugin to initialize first!
|
|
466
|
+
const api = ctx.services.get<MyApiType>('my-api');
|
|
467
|
+
api.doSomething();
|
|
468
|
+
}
|
|
469
|
+
```
|
|
470
|
+
|
|
471
|
+
### 8. Screens (Optional): UI Definitions
|
|
440
472
|
|
|
441
473
|
Define screens that any UI framework can render:
|
|
442
474
|
|