@igniter-js/cli 0.4.93 → 0.4.96
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 +20 -10
- package/dist/index.mjs +522 -231
- package/dist/index.mjs.map +1 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
|
-
# @igniter-js/
|
|
1
|
+
# @igniter-js/cli
|
|
2
2
|
|
|
3
3
|
The official Igniter.js command-line interface for scaffolding projects, generating features, wiring add-ons, and keeping your API docs in sync. It is designed for a fast developer experience, type-safe defaults, and seamless automation.
|
|
4
4
|
|
|
5
5
|
## Highlights
|
|
6
6
|
|
|
7
|
-
-
|
|
8
|
-
-
|
|
9
|
-
-
|
|
10
|
-
-
|
|
11
|
-
-
|
|
7
|
+
- **Project bootstrapper** with interactive wizards, starter templates, and add-on setup (store, jobs, auth, bots, telemetry, MCP, database, Shadcn/UI).
|
|
8
|
+
- **Code generators** for features, controllers, procedures, schemas, and OpenAPI specs, all backed by Handlebars templates.
|
|
9
|
+
- **Schema-aware workflow** with pluggable providers (Prisma out of the box) that produce strongly typed controllers, procedures, and interfaces.
|
|
10
|
+
- **Development dashboard** powered by Ink that automatically regenerates schema/docs and streams app logs in a split view.
|
|
11
|
+
- **Template engine + registries** to extend starters, add-ons, and schema providers without touching the core.
|
|
12
12
|
|
|
13
13
|
---
|
|
14
14
|
|
|
@@ -131,7 +131,7 @@ Generates a TypeScript client schema (const assertion + type) that mirrors your
|
|
|
131
131
|
|
|
132
132
|
### `igniter generate caller`
|
|
133
133
|
|
|
134
|
-
Generate
|
|
134
|
+
Generate an `IgniterCallerSchema` builder plus a ready-to-use Igniter Caller from an OpenAPI 3 spec.
|
|
135
135
|
|
|
136
136
|
```
|
|
137
137
|
# Remote spec
|
|
@@ -141,7 +141,19 @@ igniter generate caller --name facebook --url https://api.example.com/openapi.js
|
|
|
141
141
|
igniter generate caller --name billing --path ./openapi.yaml --output src/callers/billing
|
|
142
142
|
```
|
|
143
143
|
|
|
144
|
-
Outputs `schema.ts` (
|
|
144
|
+
Outputs `schema.ts` (path-first schema builder with registry, `$Infer` helpers, and derived types) and
|
|
145
|
+
`index.ts` (preconfigured caller) under `src/callers/<hostname>` by default, ready to use with
|
|
146
|
+
`@igniter-js/caller`.
|
|
147
|
+
|
|
148
|
+
Example usage:
|
|
149
|
+
|
|
150
|
+
```
|
|
151
|
+
import { facebookCallerSchemas } from "./src/callers/api.example.com/schema"
|
|
152
|
+
|
|
153
|
+
type ProductsResponse = ReturnType<
|
|
154
|
+
typeof facebookCallerSchemas.$Infer.Response<"/products", "GET", 200>
|
|
155
|
+
>
|
|
156
|
+
```
|
|
145
157
|
|
|
146
158
|
### `igniter dev`
|
|
147
159
|
|
|
@@ -258,5 +270,3 @@ MIT © Felipe Barcelos and the Igniter.js contributors.
|
|
|
258
270
|
|
|
259
271
|
|
|
260
272
|
|
|
261
|
-
|
|
262
|
-
|