aem-eds-kit 0.4.57 → 0.4.58
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/CHANGELOG.md +16 -0
- package/README.md +18 -0
- package/dist/bin/eds.js +123 -116
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -29,6 +29,11 @@ adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
|
29
29
|
Version links point at npm; the GitHub release links never existed.
|
|
30
30
|
|
|
31
31
|
### Fixed
|
|
32
|
+
- **The site has a menu on phones** (EDS-079). Below 720px the nav links were
|
|
33
|
+
hidden with nothing to bring them back; a menu button (with `aria-expanded`,
|
|
34
|
+
closing on Esc, a link tap or widening the window) now opens them as a
|
|
35
|
+
full-width list on every page, with GitHub and npm inside it under 480px,
|
|
36
|
+
each with its mark (EDS-081).
|
|
32
37
|
- **Scraped designs keep section backgrounds and one-sided lines** (EDS-067).
|
|
33
38
|
A full-width band with no background of its own now carries the colour painted
|
|
34
39
|
behind it (`inheritedBackground`, usually the page background), which the prompt
|
|
@@ -50,6 +55,17 @@ adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
|
50
55
|
where the Universal Editor boilerplate actually lives.
|
|
51
56
|
|
|
52
57
|
### Added
|
|
58
|
+
- **Drafts: review rounds before a block reaches the repository** (EDS-085).
|
|
59
|
+
`block from-design --draft` keeps the result as a version under
|
|
60
|
+
`tmp/eds-cli/drafts/<name>/` and leaves `blocks/` untouched; `eds draft
|
|
61
|
+
preview | refine "<feedback>" | accept [--commit|--branch] | discard | list`
|
|
62
|
+
reviews it, adds a version per round and, on accept, copies it into
|
|
63
|
+
`blocks/<name>/` and commits it with the rounds in the message.
|
|
64
|
+
- **A docs gate in CI** (EDS-083). On a PR, a change under `src/` fails without
|
|
65
|
+
a `CHANGELOG.md` entry, and a change to the CLI surface (`src/bin/eds.ts`) fails
|
|
66
|
+
without `README.md` (the npm page) and `site/docs.html` updates. Plus a PR
|
|
67
|
+
template with a docs checklist, and the rule in `CODING_STANDARDS.md` /
|
|
68
|
+
`CLAUDE.md`.
|
|
53
69
|
- **Any web page is a design source** (EDS-065). `block from-design` scrapes
|
|
54
70
|
every http(s) link that isn't Figma, Framer or Stitch (`--provider web`): a
|
|
55
71
|
live site you're rebuilding, an HTML mock-up, or the project's own example page
|
package/README.md
CHANGED
|
@@ -435,6 +435,7 @@ eds block from-design "<figma-url>" --dry-run # just build the prompt
|
|
|
435
435
|
| `--refresh` | Ignore the cached snapshot and re-fetch |
|
|
436
436
|
| `--sample` | Use the bundled sample design, the example file's hero (no URL, token or MCP) |
|
|
437
437
|
| `--serve` | Auto-start the live preview (non-interactive runs only) |
|
|
438
|
+
| `--draft` | Generate a draft for review instead of writing `blocks/<name>/` (see [`eds draft`](#eds-draft)) |
|
|
438
439
|
| `--yes` | Skip confirmation prompts |
|
|
439
440
|
|
|
440
441
|
Set a **Figma Personal Access Token** (scope `file_content:read`) to use the REST path — via `FIGMA_TOKEN` env or `figma.token` in config. The block generation model defaults to the fastest (Haiku); override with `model` in config.
|
|
@@ -455,6 +456,21 @@ Interactive wizard that:
|
|
|
455
456
|
3. Shows install commands if not
|
|
456
457
|
4. Saves preferences to `~/.eds/config.json`
|
|
457
458
|
|
|
459
|
+
### `eds draft`
|
|
460
|
+
|
|
461
|
+
Review a block before it reaches the repository. With `--draft`, `block from-design` keeps its result as a **draft version** under `tmp/eds-cli/drafts/<name>/v1/`. `blocks/<name>/` stays exactly as it was: an existing block is set aside while the agent works and always put back. Each review round adds a version; nothing is written to `blocks/` until the draft is accepted, either right away or after a few rounds.
|
|
462
|
+
|
|
463
|
+
```bash
|
|
464
|
+
eds block from-design "<design link>" --name hero --draft # → draft v1
|
|
465
|
+
eds draft preview hero # review it (latest version)
|
|
466
|
+
eds draft refine hero "bigger headline, orange buttons" # one more round → v2
|
|
467
|
+
eds draft accept hero --branch feature/hero # → blocks/hero/, committed
|
|
468
|
+
eds draft list # drafts and their versions
|
|
469
|
+
eds draft discard hero # drop it; blocks/ untouched
|
|
470
|
+
```
|
|
471
|
+
|
|
472
|
+
`accept --commit` (or `--branch <name>`, created if missing) commits only `blocks/<name>/`, with the review rounds in the message (`v1: first version`, `v2: "bigger headline, orange buttons"`). `refine` reuses the agent and model that made the draft unless you pass `--agent` / `--model`; `preview` and `accept` take `--version <n>`.
|
|
473
|
+
|
|
458
474
|
### `eds block list`
|
|
459
475
|
|
|
460
476
|
Lists all blocks in the project with their file status and Figma source info.
|
|
@@ -744,6 +760,8 @@ git clone https://github.com/piotrgodycki/aem-eds-kit.git && cd aem-eds-kit
|
|
|
744
760
|
npm install
|
|
745
761
|
```
|
|
746
762
|
|
|
763
|
+
Each change goes through an issue (`EDS-NNN`), a `feature/EDS-NNN` or `bug/EDS-NNN` branch and a PR, and **ships with its docs**: a `CHANGELOG.md` entry, `README.md` (this file is also the npm page) and the site pages it touches. CI's docs gate (`scripts/check-docs.mjs`) fails a PR that changes `src/` without a changelog entry, or the commands and flags in `src/bin/eds.ts` without `README.md` and `site/docs.html`. See [`CODING_STANDARDS.md`](https://github.com/piotrgodycki/aem-eds-kit/blob/main/CODING_STANDARDS.md).
|
|
764
|
+
|
|
747
765
|
### Scripts
|
|
748
766
|
|
|
749
767
|
```bash
|