buildx-cli 1.8.36 → 1.8.37
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 +47 -7
- package/dist/README.md +47 -7
- package/dist/index.cjs +1 -1
- package/dist/index.js +1 -1
- package/dist/package.json +1 -1
- package/dist/templates/schema-as-code-guide.md +134 -43
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -364,25 +364,61 @@ UI package dependency resolution:
|
|
|
364
364
|
Notes:
|
|
365
365
|
- Next scaffold requires npm registry connectivity for `create-next-app`.
|
|
366
366
|
- Use `--dry-run` to preview file plan without running scaffold commands.
|
|
367
|
+
- After backend bootstrap, `project:init` automatically runs initial pull via CLI:
|
|
368
|
+
- `schema:pull --target-dir <workspace>/buildx/generated`
|
|
369
|
+
- `function:pull --target-dir <workspace>/buildx`
|
|
370
|
+
- `ai-function:pull --target-dir <workspace>/buildx/ai-functions`
|
|
371
|
+
- `template:pull --target-dir <workspace>/buildx/templates`
|
|
372
|
+
so starter artifact docs/structure are available immediately.
|
|
367
373
|
- Generated projects are package-manager agnostic (no forced `packageManager` lock in generated `package.json`).
|
|
368
374
|
- Next `app/globals.css` is normalized with Tailwind `@source` to include UI pack classes from `node_modules` (prevents missing utilities like `grid-cols-2` from shared components).
|
|
369
375
|
- Next starter includes `@heroui/react` by default.
|
|
370
376
|
- Expo starter includes `heroui-native` by default.
|
|
371
377
|
|
|
372
|
-
###
|
|
378
|
+
### Standard Artifact Guideline
|
|
373
379
|
|
|
374
|
-
|
|
380
|
+
Use this as the standard workflow for project artifacts after `project:init`.
|
|
381
|
+
|
|
382
|
+
Scope and location:
|
|
383
|
+
- schema artifacts: `buildx/generated/*`
|
|
384
|
+
- function artifacts: `buildx/functions/*`
|
|
385
|
+
- AI function artifacts: `buildx/ai-functions/*`
|
|
386
|
+
- template artifacts: `buildx/templates/*`
|
|
387
|
+
|
|
388
|
+
Initial sync baseline:
|
|
389
|
+
- `project:init` auto-pulls all artifact groups (`schema`, `function`, `ai-function`, `template`).
|
|
390
|
+
|
|
391
|
+
Daily standard loop (recommended):
|
|
392
|
+
1. Pull latest remote artifacts first.
|
|
393
|
+
2. Edit local files.
|
|
394
|
+
3. Diff against remote.
|
|
395
|
+
4. Push with `--dry-run`.
|
|
396
|
+
5. Push for real after review.
|
|
375
397
|
|
|
376
398
|
```bash
|
|
377
|
-
#
|
|
399
|
+
# 1) pull latest (all artifact groups)
|
|
378
400
|
npx buildx-cli schema:pull --project-id <project-id>
|
|
379
|
-
npx buildx-cli schema:diff --project-id <project-id>
|
|
380
|
-
npx buildx-cli schema:push --project-id <project-id> --dry-run
|
|
381
|
-
|
|
382
|
-
# function lifecycle
|
|
383
401
|
npx buildx-cli function:pull --project-id <project-id>
|
|
402
|
+
npx buildx-cli ai-function:pull --project-id <project-id>
|
|
403
|
+
npx buildx-cli template:pull --project-id <project-id>
|
|
404
|
+
|
|
405
|
+
# 2) diff before push
|
|
406
|
+
npx buildx-cli schema:diff --project-id <project-id> --details
|
|
384
407
|
npx buildx-cli function:diff --project-id <project-id>
|
|
408
|
+
npx buildx-cli ai-function:diff --project-id <project-id>
|
|
409
|
+
npx buildx-cli template:diff --project-id <project-id>
|
|
410
|
+
|
|
411
|
+
# 3) dry-run push
|
|
412
|
+
npx buildx-cli schema:push --project-id <project-id> --dry-run
|
|
385
413
|
npx buildx-cli function:push --project-id <project-id> --dry-run
|
|
414
|
+
npx buildx-cli ai-function:push --project-id <project-id> --dry-run
|
|
415
|
+
npx buildx-cli template:push --project-id <project-id> --dry-run
|
|
416
|
+
|
|
417
|
+
# 4) push for real
|
|
418
|
+
npx buildx-cli schema:push --project-id <project-id>
|
|
419
|
+
npx buildx-cli function:push --project-id <project-id>
|
|
420
|
+
npx buildx-cli ai-function:push --project-id <project-id>
|
|
421
|
+
npx buildx-cli template:push --project-id <project-id>
|
|
386
422
|
```
|
|
387
423
|
|
|
388
424
|
### Users
|
|
@@ -553,6 +589,10 @@ Field annotations (JSDoc in `types.ts`) are supported:
|
|
|
553
589
|
- `@bx.validate <json_or_string>`
|
|
554
590
|
- `@bx.props <json-object>` (merge custom keys into `propertiesScheme`)
|
|
555
591
|
|
|
592
|
+
Required behavior:
|
|
593
|
+
- converter does not auto-assume `required: true` from non-optional TypeScript syntax by default.
|
|
594
|
+
- use `@bx.required` (or `@bx.required false`) for explicit required control.
|
|
595
|
+
|
|
556
596
|
System-managed fields:
|
|
557
597
|
- `createdAt`, `updatedAt`, `createdBy`, `updatedBy` in `types.ts` are ignored by convert output and never synced back
|
|
558
598
|
|
package/dist/README.md
CHANGED
|
@@ -364,25 +364,61 @@ UI package dependency resolution:
|
|
|
364
364
|
Notes:
|
|
365
365
|
- Next scaffold requires npm registry connectivity for `create-next-app`.
|
|
366
366
|
- Use `--dry-run` to preview file plan without running scaffold commands.
|
|
367
|
+
- After backend bootstrap, `project:init` automatically runs initial pull via CLI:
|
|
368
|
+
- `schema:pull --target-dir <workspace>/buildx/generated`
|
|
369
|
+
- `function:pull --target-dir <workspace>/buildx`
|
|
370
|
+
- `ai-function:pull --target-dir <workspace>/buildx/ai-functions`
|
|
371
|
+
- `template:pull --target-dir <workspace>/buildx/templates`
|
|
372
|
+
so starter artifact docs/structure are available immediately.
|
|
367
373
|
- Generated projects are package-manager agnostic (no forced `packageManager` lock in generated `package.json`).
|
|
368
374
|
- Next `app/globals.css` is normalized with Tailwind `@source` to include UI pack classes from `node_modules` (prevents missing utilities like `grid-cols-2` from shared components).
|
|
369
375
|
- Next starter includes `@heroui/react` by default.
|
|
370
376
|
- Expo starter includes `heroui-native` by default.
|
|
371
377
|
|
|
372
|
-
###
|
|
378
|
+
### Standard Artifact Guideline
|
|
373
379
|
|
|
374
|
-
|
|
380
|
+
Use this as the standard workflow for project artifacts after `project:init`.
|
|
381
|
+
|
|
382
|
+
Scope and location:
|
|
383
|
+
- schema artifacts: `buildx/generated/*`
|
|
384
|
+
- function artifacts: `buildx/functions/*`
|
|
385
|
+
- AI function artifacts: `buildx/ai-functions/*`
|
|
386
|
+
- template artifacts: `buildx/templates/*`
|
|
387
|
+
|
|
388
|
+
Initial sync baseline:
|
|
389
|
+
- `project:init` auto-pulls all artifact groups (`schema`, `function`, `ai-function`, `template`).
|
|
390
|
+
|
|
391
|
+
Daily standard loop (recommended):
|
|
392
|
+
1. Pull latest remote artifacts first.
|
|
393
|
+
2. Edit local files.
|
|
394
|
+
3. Diff against remote.
|
|
395
|
+
4. Push with `--dry-run`.
|
|
396
|
+
5. Push for real after review.
|
|
375
397
|
|
|
376
398
|
```bash
|
|
377
|
-
#
|
|
399
|
+
# 1) pull latest (all artifact groups)
|
|
378
400
|
npx buildx-cli schema:pull --project-id <project-id>
|
|
379
|
-
npx buildx-cli schema:diff --project-id <project-id>
|
|
380
|
-
npx buildx-cli schema:push --project-id <project-id> --dry-run
|
|
381
|
-
|
|
382
|
-
# function lifecycle
|
|
383
401
|
npx buildx-cli function:pull --project-id <project-id>
|
|
402
|
+
npx buildx-cli ai-function:pull --project-id <project-id>
|
|
403
|
+
npx buildx-cli template:pull --project-id <project-id>
|
|
404
|
+
|
|
405
|
+
# 2) diff before push
|
|
406
|
+
npx buildx-cli schema:diff --project-id <project-id> --details
|
|
384
407
|
npx buildx-cli function:diff --project-id <project-id>
|
|
408
|
+
npx buildx-cli ai-function:diff --project-id <project-id>
|
|
409
|
+
npx buildx-cli template:diff --project-id <project-id>
|
|
410
|
+
|
|
411
|
+
# 3) dry-run push
|
|
412
|
+
npx buildx-cli schema:push --project-id <project-id> --dry-run
|
|
385
413
|
npx buildx-cli function:push --project-id <project-id> --dry-run
|
|
414
|
+
npx buildx-cli ai-function:push --project-id <project-id> --dry-run
|
|
415
|
+
npx buildx-cli template:push --project-id <project-id> --dry-run
|
|
416
|
+
|
|
417
|
+
# 4) push for real
|
|
418
|
+
npx buildx-cli schema:push --project-id <project-id>
|
|
419
|
+
npx buildx-cli function:push --project-id <project-id>
|
|
420
|
+
npx buildx-cli ai-function:push --project-id <project-id>
|
|
421
|
+
npx buildx-cli template:push --project-id <project-id>
|
|
386
422
|
```
|
|
387
423
|
|
|
388
424
|
### Users
|
|
@@ -553,6 +589,10 @@ Field annotations (JSDoc in `types.ts`) are supported:
|
|
|
553
589
|
- `@bx.validate <json_or_string>`
|
|
554
590
|
- `@bx.props <json-object>` (merge custom keys into `propertiesScheme`)
|
|
555
591
|
|
|
592
|
+
Required behavior:
|
|
593
|
+
- converter does not auto-assume `required: true` from non-optional TypeScript syntax by default.
|
|
594
|
+
- use `@bx.required` (or `@bx.required false`) for explicit required control.
|
|
595
|
+
|
|
556
596
|
System-managed fields:
|
|
557
597
|
- `createdAt`, `updatedAt`, `createdBy`, `updatedBy` in `types.ts` are ignored by convert output and never synced back
|
|
558
598
|
|