@venizia/ignis-boot 0.0.1-0 → 0.0.2-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 +73 -0
- package/package.json +20 -6
package/README.md
ADDED
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
# @venizia/ignis-boot
|
|
2
|
+
|
|
3
|
+
[](https://www.npmjs.com/package/@venizia/ignis-boot)
|
|
4
|
+
[](https://opensource.org/licenses/MIT)
|
|
5
|
+
|
|
6
|
+
An **automated bootstrapping system** for the **Ignis Framework** - provides artifact auto-discovery and loading during application startup.
|
|
7
|
+
|
|
8
|
+
## Installation
|
|
9
|
+
|
|
10
|
+
```bash
|
|
11
|
+
bun add @venizia/ignis-boot
|
|
12
|
+
# or
|
|
13
|
+
npm install @venizia/ignis-boot
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
## Quick Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import { BaseApplication, IApplicationConfigs } from "@venizia/ignis";
|
|
20
|
+
import { IBootOptions } from "@venizia/ignis-boot";
|
|
21
|
+
|
|
22
|
+
// Configure auto-discovery
|
|
23
|
+
export const appConfigs: IApplicationConfigs = {
|
|
24
|
+
name: "MyApp",
|
|
25
|
+
bootOptions: {
|
|
26
|
+
controllers: { dirs: ["controllers"], isNested: true },
|
|
27
|
+
services: { dirs: ["services"], isNested: true },
|
|
28
|
+
repositories: { dirs: ["repositories"] },
|
|
29
|
+
datasources: { dirs: ["datasources"] },
|
|
30
|
+
},
|
|
31
|
+
};
|
|
32
|
+
|
|
33
|
+
export class Application extends BaseApplication {
|
|
34
|
+
constructor() {
|
|
35
|
+
super(appConfigs);
|
|
36
|
+
// That's it! All artifacts are auto-discovered and registered
|
|
37
|
+
}
|
|
38
|
+
}
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
## Features
|
|
42
|
+
|
|
43
|
+
| Feature | Description |
|
|
44
|
+
|---------|-------------|
|
|
45
|
+
| **Auto-Discovery** | Automatically finds controllers, services, repositories, and datasources |
|
|
46
|
+
| **Convention-Based** | Follow naming patterns (`.controller.js`, `.service.js`, etc.) |
|
|
47
|
+
| **Three-Phase Boot** | Configure → Discover → Load lifecycle |
|
|
48
|
+
| **Customizable** | Configure directories, extensions, and glob patterns |
|
|
49
|
+
| **Extensible** | Create custom booters for new artifact types |
|
|
50
|
+
|
|
51
|
+
## Built-in Booters
|
|
52
|
+
|
|
53
|
+
| Booter | Default Directory | Default Extension |
|
|
54
|
+
|--------|-------------------|-------------------|
|
|
55
|
+
| **ControllerBooter** | `controllers/` | `.controller.js` |
|
|
56
|
+
| **ServiceBooter** | `services/` | `.service.js` |
|
|
57
|
+
| **RepositoryBooter** | `repositories/` | `.repository.js` |
|
|
58
|
+
| **DatasourceBooter** | `datasources/` | `.datasource.js` |
|
|
59
|
+
|
|
60
|
+
## About Ignis
|
|
61
|
+
|
|
62
|
+
Ignis brings together the structured, enterprise development experience of **LoopBack 4** with the blazing speed and simplicity of **Hono** - giving you the best of both worlds.
|
|
63
|
+
|
|
64
|
+
## Documentation
|
|
65
|
+
|
|
66
|
+
- [Ignis Repository](https://github.com/venizia-ai/ignis)
|
|
67
|
+
- [Getting Started](https://github.com/venizia-ai/ignis/blob/main/packages/docs/wiki/get-started/index.md)
|
|
68
|
+
- [Bootstrapping Guide](https://github.com/venizia-ai/ignis/blob/main/packages/docs/wiki/get-started/core-concepts/bootstrapping.md)
|
|
69
|
+
- [Boot Package Reference](https://github.com/venizia-ai/ignis/blob/main/packages/docs/wiki/references/src-details/boot.md)
|
|
70
|
+
|
|
71
|
+
## License
|
|
72
|
+
|
|
73
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,8 +1,22 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@venizia/ignis-boot",
|
|
3
|
-
"version": "0.0.
|
|
4
|
-
"description": "",
|
|
5
|
-
"keywords": [
|
|
3
|
+
"version": "0.0.2-0",
|
|
4
|
+
"description": "Automated bootstrapping system with artifact auto-discovery for Ignis Framework",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"ignis",
|
|
7
|
+
"boot",
|
|
8
|
+
"bootstrap",
|
|
9
|
+
"bootstrapper",
|
|
10
|
+
"auto-discovery",
|
|
11
|
+
"artifact-loading",
|
|
12
|
+
"convention-based",
|
|
13
|
+
"dependency-injection",
|
|
14
|
+
"ioc",
|
|
15
|
+
"venizia",
|
|
16
|
+
"bun",
|
|
17
|
+
"nodejs",
|
|
18
|
+
"typescript"
|
|
19
|
+
],
|
|
6
20
|
"main": "./dist/cjs/index.js",
|
|
7
21
|
"module": "./dist/esm/index.js",
|
|
8
22
|
"types": "./dist/cjs/index.d.ts",
|
|
@@ -62,8 +76,8 @@
|
|
|
62
76
|
"homepage": "https://venizia-ai.github.io/ignis",
|
|
63
77
|
"license": "MIT",
|
|
64
78
|
"dependencies": {
|
|
65
|
-
"@venizia/ignis-helpers": "0.0.
|
|
66
|
-
"@venizia/ignis-inversion": "0.0.
|
|
79
|
+
"@venizia/ignis-helpers": "^0.0.4-0",
|
|
80
|
+
"@venizia/ignis-inversion": "^0.0.3-0",
|
|
67
81
|
"glob": "^13.0.0",
|
|
68
82
|
"lodash": "^4.17.21",
|
|
69
83
|
"reflect-metadata": "^0.2.2"
|
|
@@ -71,7 +85,7 @@
|
|
|
71
85
|
"devDependencies": {
|
|
72
86
|
"@types/bun": "^1.3.2",
|
|
73
87
|
"@types/lodash": "^4.17.21",
|
|
74
|
-
"@venizia/dev-configs": "^0.0.
|
|
88
|
+
"@venizia/dev-configs": "^0.0.5-0",
|
|
75
89
|
"eslint": "^9.36.0",
|
|
76
90
|
"prettier": "^3.6.2",
|
|
77
91
|
"tsc-alias": "^1.8.16",
|