@voxgig/create-sdkgen 0.29.2 → 0.30.1
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 -2
- package/package.json +3 -1
- package/project/standard/.sdk/package.json +4 -4
package/README.md
CHANGED
|
@@ -33,7 +33,7 @@ generated output and is overwritten on each regenerate.
|
|
|
33
33
|
| Flag | Meaning |
|
|
34
34
|
| --- | --- |
|
|
35
35
|
| `<name>` | SDK name (kebab-case), the package base name |
|
|
36
|
-
| `-d, --def <spec>` | OpenAPI 3 spec file (`.yaml`/`.json`) |
|
|
36
|
+
| `-d, --def <spec>` | OpenAPI 3 spec file (`.yaml`/`.json`). Its `servers` entry names the base URL of the API. A spec without one still builds: the SDK then takes the URL as its `base` server variable, or `.sdk/build/apidef.js` fixes one with the `server` option |
|
|
37
37
|
| `-o, --folder <dir>` | output directory (default `<name>-sdk`) |
|
|
38
38
|
| `-t, --target <langs>` | targets to add during scaffold (e.g. `ts,py,go`) |
|
|
39
39
|
| `-f, --feature <feats>` | features to add (e.g. `test`) |
|
|
@@ -88,6 +88,16 @@ such a project and re-scaffolds it.
|
|
|
88
88
|
- **[@voxgig/apidef](https://github.com/voxgig/apidef)** — parses your OpenAPI spec into the model.
|
|
89
89
|
- **[@voxgig/sdkgen](https://github.com/voxgig/sdkgen)** — generates the SDKs from the model.
|
|
90
90
|
|
|
91
|
+
The scaffold's `.sdk/package.json` pins each Voxgig toolchain package to the
|
|
92
|
+
patch line this release of create-sdkgen was released with: `~4.31.0` for
|
|
93
|
+
`@voxgig/sdkgen`, and likewise for `@voxgig/apidef`, `@voxgig/model` and
|
|
94
|
+
`@voxgig/docgen`. A release that carries these pins, pinned or not, scaffolds
|
|
95
|
+
a project that installs a toolchain able to drive what the scaffold wrote. A
|
|
96
|
+
release from before them declares open floors instead, so re-scaffold with one
|
|
97
|
+
that has them. Fixes arrive with `npm install`. A newer minor arrives with a
|
|
98
|
+
re-scaffold from the current create-sdkgen, which rewrites the pins, or by
|
|
99
|
+
editing the ranges by hand.
|
|
100
|
+
|
|
91
101
|
## Contributing
|
|
92
102
|
|
|
93
103
|
How to validate a change, and why a pull request from a fork gets no CI, are
|
|
@@ -98,7 +108,15 @@ in [`CONTRIBUTING.md`](./CONTRIBUTING.md). The documentation follows
|
|
|
98
108
|
|
|
99
109
|
New projects include `@voxgig/docgen`. Installing the `.sdk` dependencies adds
|
|
100
110
|
the `summary` and `github-pages` editions. `npm run generate` then produces
|
|
101
|
-
`SUMMARY.md` and
|
|
111
|
+
`SUMMARY.md` and a text QA workflow. The `github-pages` edition is off by
|
|
112
|
+
default. To generate the static HTML site in `docs/` and its GitHub Pages
|
|
113
|
+
deployment, turn it on in `.sdk/model/project.aontu`:
|
|
114
|
+
|
|
115
|
+
```aontu
|
|
116
|
+
main: kit: doc: edition: 'github-pages': active: true
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
With `--no-install`, setup happens when dependencies are installed.
|
|
102
120
|
|
|
103
121
|
Add the optional Slidev presentation from `.sdk`:
|
|
104
122
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@voxgig/create-sdkgen",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.30.1",
|
|
4
4
|
"main": "dist/create-sdkgen.js",
|
|
5
5
|
"type": "commonjs",
|
|
6
6
|
"types": "dist/create-sdkgen.d.ts",
|
|
@@ -27,6 +27,8 @@
|
|
|
27
27
|
"watch": "tsc --build src test -w",
|
|
28
28
|
"build": "tsc --build src test",
|
|
29
29
|
"scan-prose": "python3 tools/check_prose.py",
|
|
30
|
+
"toolchain": "node build/toolchain.js",
|
|
31
|
+
"toolchain-check": "node build/toolchain.js --check",
|
|
30
32
|
"test-model": "voxgig-model project/.sdk/test/test.aontu",
|
|
31
33
|
"test-model-watch": "voxgig-model -w project/.sdk/test/test.aontu",
|
|
32
34
|
"clean": "rm -rf dist dist-test node_modules yarn.lock package-lock.json",
|
|
@@ -29,13 +29,13 @@
|
|
|
29
29
|
"devDependencies": {
|
|
30
30
|
"@types/node": ">=25.6",
|
|
31
31
|
"typescript": ">=6.0",
|
|
32
|
-
"@voxgig/apidef": "
|
|
33
|
-
"@voxgig/model": "
|
|
34
|
-
"@voxgig/sdkgen": "
|
|
32
|
+
"@voxgig/apidef": "~8.20.0",
|
|
33
|
+
"@voxgig/model": "~12.0.0",
|
|
34
|
+
"@voxgig/sdkgen": "~4.31.0",
|
|
35
35
|
"@voxgig/util": ">=0.5",
|
|
36
36
|
"@voxgig/struct": ">=0.2",
|
|
37
37
|
"jostraca": ">=0.39.0",
|
|
38
38
|
"aontu": ">=0.75.0",
|
|
39
|
-
"@voxgig/docgen": "
|
|
39
|
+
"@voxgig/docgen": "~0.30.0"
|
|
40
40
|
}
|
|
41
41
|
}
|