fritzkit 0.0.0-stage → 0.1.0

package/.claude-plugin/marketplace.json

@@ -0,0 +1,12 @@
+{
+  "name": "fritzkit",
+  "owner": { "name": "pmaxhogan" },
+  "description": "Claude Code marketplace for the fritzkit plugin",
+  "plugins": [
+    {
+      "name": "fritzkit",
+      "source": "./",
+      "description": "Build Fritzing parts from a product link: workflow skill plus the fritzkit MCP server"
+    }
+  ]
+}

package/.claude-plugin/plugin.json

@@ -0,0 +1,13 @@
+{
+  "name": "fritzkit",
+  "version": "0.1.0",
+  "description": "Build first-class Fritzing parts (.fzpz) from a product link, datasheet, photos or KiCad footprint: a skill for the research workflow plus the fritzkit MCP server that compiles, validates, renders, exports and installs the part.",
+  "author": { "name": "Max Hogan", "url": "https://github.com/pmaxhogan" },
+  "homepage": "https://github.com/pmaxhogan/fritzkit#readme",
+  "repository": "https://github.com/pmaxhogan/fritzkit",
+  "license": "MIT",
+  "keywords": ["fritzing", "fzpz", "electronics", "parts", "breadboard", "mcp"],
+  "mcpServers": {
+    "fritzkit": { "command": "npx", "args": ["-y", "fritzkit", "mcp"] }
+  }
+}

package/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changelog
+
+Short notes per release. Releases are cut automatically on every green push to main.
+
+## Unreleased
+
+- Scaffold from stack standards.
+- Agent docs: Claude Code skill (skills/fritzkit), plugin manifest, README, docs/part-json.md field reference and docs/agent-workflow.md.

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Max Hogan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,430 @@
-# Temporary Holding Version
+# fritzkit
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+[![ci](https://github.com/pmaxhogan/fritzkit/actions/workflows/ci.yml/badge.svg)](https://github.com/pmaxhogan/fritzkit/actions/workflows/ci.yml)
+[![fzp-checker](https://github.com/pmaxhogan/fritzkit/actions/workflows/fzp-checker.yml/badge.svg)](https://github.com/pmaxhogan/fritzkit/actions/workflows/fzp-checker.yml)
+
+fritzkit compiles a small JSON description of a board (`part.json`: outline in mm, every
+pad and pin with its name, role and position, buses for shared nets) into a first-class
+Fritzing part: breadboard, schematic, PCB and icon views that pass Fritzing's own part
+checker, seat on the 0.1 in breadboard grid and keep their connector ids across versions so
+placed parts can be swapped without losing wires. It ships as a CLI, an MCP server and a
+Claude Code skill, so you can hand Claude a product link and get a `.fzpz` back in My Parts.
+fritzkit itself is offline and deterministic; the agent does the reading and measuring.
+
+## Install
+
+```
+npx fritzkit --help          # run without installing
+npm i -g fritzkit            # or install the `fritzkit` command globally
+```
+
+Requirements:
+
+- Node.js 22 or newer
+- [Fritzing](https://fritzing.org/) 1.0.7 (to use the parts; `install` and `prune` manage its user parts folder)
+- optional: [uv](https://docs.astral.sh/uv/) for `validate --checker`, which runs Fritzing's own part checker
+
+`fritzkit doctor` checks all of these.
+
+## 60-second quickstart
+
+```
+fritzkit init                                    # create the workspace (~/fritzkit/parts)
+fritzkit new my-breakout --title "My breakout"   # <workspace>/my-breakout/part.json + assets/
+# edit ~/fritzkit/parts/my-breakout/part.json   (see the reference below)
+fritzkit validate my-breakout                    # schema + structural checks
+fritzkit render my-breakout --png                # PNG of every view into my-breakout/build/
+fritzkit export my-breakout                      # -> my-breakout/<moduleId>.fzpz
+fritzkit install my-breakout                     # into Fritzing's My Parts (close Fritzing first)
+```
+
+Then start Fritzing; the part is in the **My Parts** bin.
+
+## Use it from Claude Code
+
+As a plugin (skill + MCP server in one step):
+
+```
+claude plugin marketplace add pmaxhogan/fritzkit
+claude plugin install fritzkit@fritzkit
+```
+
+(Inside a session: `/plugin marketplace add pmaxhogan/fritzkit`, then
+`/plugin install fritzkit@fritzkit`.)
+
+Or just the MCP server:
+
+```
+claude mcp add --scope user fritzkit -- npx -y fritzkit mcp
+```
+
+and, for the workflow, copy `skills/fritzkit/` from this repo into `~/.claude/skills/fritzkit/`.
+
+Then ask: "Make me a Fritzing part for https://www.amazon.com/dp/XXXXXXXXXX". The skill
+tells Claude how to fetch the listing and images, measure the board, name every pad, write
+`part.json`, check the render against the photo, and export/install the part.
+
+## The agent workflow
+
+1. Gather sources with the agent's own tools (listing via Amazon's mobile URL with a plain
+   `curl`, gallery images from the page's `hiRes` URLs, datasheet PDFs, manufacturer wiki, Digikey page, or a KiCad footprint).
+2. Determine the outline in mm from dimension callouts or a drawing, cross-checked.
+3. Identify every pad: silkscreen name, role, net (buses), connector kind, position measured
+   from the photo at a known px/mm.
+4. Write `part.json`, `validate`, `render --png`, compare the render with the photo, fix,
+   repeat.
+5. `export`, then `install` (Fritzing closed) or hand over the `.fzpz`; `prune` old versions.
+6. Report what was measured, what was estimated, and what the user should verify.
+
+Long form: [docs/agent-workflow.md](docs/agent-workflow.md). The skill itself:
+[skills/fritzkit/SKILL.md](skills/fritzkit/SKILL.md).
+
+## part.json reference
+
+Every field, type, default and the coordinate frame: [docs/part-json.md](docs/part-json.md).
+The JSON Schema is printed by `fritzkit schema`. In short: lengths in mm, origin at the
+top-left corner of the outline, x right, y down (like a top-down photo), positions are pad
+centres.
+
+Example, the [Seeed Studio XIAO ESP32-C6](https://wiki.seeedstudio.com/xiao_esp32c6_getting_started/)
+(a portrait board: top view, USB-C at the TOP short edge, two columns of 7 castellated pads
+down the long edges, a 2-pad BAT header on the back, GND pads tied by a bus). Trimmed; the
+full, measured spec is [examples/xiao-esp32-c6](examples/xiao-esp32-c6/README.md):
+
+```json
+{
+  "$schema": "https://raw.githubusercontent.com/pmaxhogan/fritzkit/main/src/core/schema/part.schema.json",
+  "slug": "xiao-esp32-c6",
+  "title": "Seeed Studio XIAO ESP32-C6",
+  "version": 1,
+  "label": "U",
+  "tags": ["xiao", "esp32-c6", "seeed", "castellated"],
+  "description": "Seeed Studio XIAO ESP32-C6, 21 x 17.8 mm. Top (component) view, USB-C at the TOP short edge, the two columns of 7 castellated 0.1 in pads along the long edges: D0..D6 down the left edge, 5V/GND/3V3/D10/D9/D8/D7 down the right edge. BAT+ and BAT- are pads on the BACK, drawn where they sit seen through the board. BAT- and the side GND pad are the same net (Seeed's KiCad symbol names that pad GND), hence the GND bus.",
+  "sources": ["https://wiki.seeedstudio.com/xiao_esp32c6_getting_started/"],
+  "properties": {
+    "mpn": "XIAO ESP32C6",
+    "type": "module",
+    "chip": "ESP32-C6"
+  },
+  "outline": {
+    "widthMm": 17.8,
+    "heightMm": 21,
+    "shape": "rounded",
+    "cornerRadiusMm": 1.5
+  },
+  "artwork": {
+    "style": "vector",
+    "boardColor": "#1A1A1A",
+    "components": [
+      {
+        "kind": "rect",
+        "xMm": 4.4,
+        "yMm": -1.5,
+        "wMm": 9,
+        "hMm": 7.4,
+        "color": "#B8B8B8",
+        "rxMm": 0.8,
+        "note": "USB-C receptacle, overhangs the top edge by 1.5 mm (KiCad footprint silk)"
+      },
+      {
+        "kind": "rect",
+        "xMm": 3,
+        "yMm": 6.8,
+        "wMm": 11.8,
+        "hMm": 10.4,
+        "color": "#6E6E6E",
+        "rxMm": 0.4,
+        "note": "ESP32-C6 RF shield can"
+      }
+    ]
+  },
+  "headers": [
+    {
+      "key": "left",
+      "kind": "castellated",
+      "cols": 7,
+      "orientation": "vertical",
+      "xMm": 1.28,
+      "yMm": 2.88,
+      "pins": [
+        {
+          "key": "d0",
+          "name": "D0",
+          "role": "analog",
+          "description": "D0 / A0: GPIO0 (LP_GPIO0), ADC"
+        },
+        {
+          "key": "d1",
+          "name": "D1",
+          "role": "analog",
+          "description": "D1 / A1: GPIO1 (LP_GPIO1), ADC"
+        },
+        {
+          "key": "d2",
+          "name": "D2",
+          "role": "analog",
+          "description": "D2 / A2: GPIO2 (LP_GPIO2), ADC"
+        },
+        {
+          "key": "d3",
+          "name": "D3",
+          "role": "io",
+          "description": "D3: GPIO21 (SDIO_DATA1)"
+        },
+        {
+          "key": "d4",
+          "name": "D4",
+          "role": "i2c",
+          "description": "D4 / SDA: GPIO22, I2C data (SDIO_DATA2)"
+        },
+        {
+          "key": "d5",
+          "name": "D5",
+          "role": "i2c",
+          "description": "D5 / SCL: GPIO23, I2C clock (SDIO_DATA3)"
+        },
+        {
+          "key": "d6",
+          "name": "D6",
+          "role": "uart",
+          "description": "D6 / TX: GPIO16, UART transmit"
+        }
+      ]
+    },
+    {
+      "key": "right",
+      "kind": "castellated",
+      "cols": 7,
+      "orientation": "vertical",
+      "xMm": 16.52,
+      "yMm": 2.88,
+      "pins": [
+        {
+          "key": "5v",
+          "name": "5V",
+          "role": "power",
+          "description": "5V (VBUS): USB-C 5 V in/out. No voltage here when running from the battery"
+        },
+        {
+          "key": "gnd",
+          "name": "GND",
+          "role": "gnd",
+          "description": "Ground"
+        },
+        {
+          "key": "3v3",
+          "name": "3V3",
+          "role": "power",
+          "description": "3V3 (3V3_OUT): 3.3 V regulator output"
+        },
+        {
+          "key": "d10",
+          "name": "D10",
+          "role": "spi",
+          "description": "D10 / MOSI: GPIO18, SPI data out"
+        },
+        {
+          "key": "d9",
+          "name": "D9",
+          "role": "spi",
+          "description": "D9 / MISO: GPIO20, SPI data in"
+        },
+        {
+          "key": "d8",
+          "name": "D8",
+          "role": "spi",
+          "description": "D8 / SCK: GPIO19, SPI clock"
+        },
+        {
+          "key": "d7",
+          "name": "D7",
+          "role": "uart",
+          "description": "D7 / RX: GPIO17, UART receive"
+        }
+      ]
+    },
+    {
+      "key": "bat",
+      "kind": "castellated",
+      "cols": 2,
+      "orientation": "horizontal",
+      "xMm": 7.11,
+      "yMm": 16.03,
+      "pad": {
+        "shape": "rect",
+        "wMm": 1.1,
+        "hMm": 2.5,
+        "smd": true
+      },
+      "pins": [
+        {
+          "key": "bat+",
+          "name": "BAT+",
+          "label": "B+",
+          "role": "power",
+          "description": "Li-ion battery plus (VBAT), pad on the BACK; charged by the on-board SGM40567 charger"
+        },
+        {
+          "key": "bat-",
+          "name": "BAT-",
+          "label": "B-",
+          "role": "gnd",
+          "description": "Battery minus, pad on the BACK. Same net as GND"
+        }
+      ]
+    }
+  ],
+  "buses": [
+    {
+      "id": "GND",
+      "pins": ["gnd", "bat-"]
+    }
+  ]
+}
+```
+
+More examples (an ESC with wire leads, a relay module, a KiCad import):
+[skills/fritzkit/reference/examples.md](skills/fritzkit/reference/examples.md).
+
+## CLI reference
+
+```
+fritzkit [--workspace <dir>] [--json] <command>
+```
+
+`<part>` is a slug in the workspace (default `~/fritzkit/parts`, or `FRITZKIT_WORKSPACE`) or
+a path to a part folder (`validate` and `render` also accept a `.fzpz`). `--json` prints machine-readable output.
+
+| command                                              | what it does                                                                                                                                                                             |
+| ---------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `init`                                               | create the workspace folder                                                                                                                                                              |
+| `new <slug> [--title <t>]`                           | create `<workspace>/<slug>/part.json` (a placeholder spec) and `assets/`                                                                                                                 |
+| `list`                                               | list the parts in the workspace                                                                                                                                                          |
+| `validate <part> [--checker]`                        | schema and structural checks; `--checker` also runs Fritzing's part checker via uv and prints a `fzp checker: ran (...)` or `skipped - ...` line; a `.fzpz` path checks the package only |
+| `render <part> [--view <v>] [--out <dir>] [--png]`   | write `<view>.svg` for one view or all four (breadboard, schematic, pcb, icon) into `<part>/build/`; `--png` ALSO writes `<view>.png` at 300 dpi                                         |
+| `export <part> [--out <file>] [--install] [--force]` | build the `.fzpz` (next to part.json by default); refuses on validator errors unless `--force`; `--install` also installs it                                                             |
+| `install <part> [--out <file>] [--force]`            | same as `export --install`; refuses while Fritzing is running                                                                                                                            |
+| `prune <family-or-slug> [--keep <moduleId>] [--yes]` | list older installed versions of a family (dry run); `--yes` deletes them, keeping the newest                                                                                            |
+| `doctor`                                             | check Node, uv, the Fritzing install and its parts folder, sharp                                                                                                                         |
+| `schema [--out <file>]`                              | print or write the part.json JSON Schema                                                                                                                                                 |
+| `import-kicad <file> --slug <slug>`                  | create a part from a `.kicad_mod` footprint with exact pad geometry                                                                                                                      |
+| `mcp`                                                | run the MCP server on stdio                                                                                                                                                              |
+| `ui [part] [--port <n>]`                             | local web editor for part.json with live previews                                                                                                                                        |
+
+Exit codes: 0 ok, 1 error, 2 the `ui` app is not built (run `npm run ui:build`), 3 Fritzing is running (install/prune).
+
+## MCP tools
+
+Run with `npx -y fritzkit mcp` (stdio). Same core as the CLI.
+
+| tool                      | purpose                                                        |
+| ------------------------- | -------------------------------------------------------------- |
+| `fritzkit_init_workspace` | create the workspace                                           |
+| `fritzkit_list_parts`     | list parts                                                     |
+| `fritzkit_new_part`       | create a part folder with a placeholder spec                   |
+| `fritzkit_get_part`       | read a part's part.json                                        |
+| `fritzkit_set_part`       | replace part.json with a whole spec                            |
+| `fritzkit_patch_part`     | apply JSON-patch operations to part.json                       |
+| `fritzkit_add_pins`       | append pins                                                    |
+| `fritzkit_validate`       | schema + structural checks (optionally the Fritzing checker)   |
+| `fritzkit_render`         | render a view as SVG text or a PNG image the agent can look at |
+| `fritzkit_export`         | build the `.fzpz`                                              |
+| `fritzkit_install`        | install into Fritzing's user parts folder (Fritzing closed)    |
+| `fritzkit_prune`          | remove old installed versions of a family                      |
+| `fritzkit_import_kicad`   | create a part from a `.kicad_mod`                              |
+| `fritzkit_schema`         | the part.json JSON Schema                                      |
+| `fritzkit_doctor`         | environment check                                              |
+
+## Acceptance
+
+The part pipeline was verified end to end on a real product: a fresh agent built the
+[HW-391 2S 20A balance board](examples/hw391-2s-20a-bms/README.md) from its Amazon listing
+using only the skill and the CLI, every pad landed within 0.75 mm of a hidden golden table, and
+the local acceptance run (`npm run e2e`) rendered it in Fritzing and wired it on a
+breadboard. Screenshots of the GUI run (the part in My Parts, wired, saved) are in
+[docs/acceptance/](docs/acceptance/); the example's own notes and measured-vs-golden table are in
+[examples/hw391-2s-20a-bms/README.md](examples/hw391-2s-20a-bms/README.md).
+
+## FAQ
+
+**Why does every export get a new moduleId?** Fritzing refuses to import a part whose
+moduleId it already has ("Part module ID must be unique"). The moduleId is
+`fritzkit-<slug>-<hash8>`, where the hash covers part.json and the assets, so every change
+imports cleanly. Use `fritzkit prune <family> --yes` to remove the old versions.
+
+**How do I swap a placed part for a newer version?** All versions share a family (the slug)
+and differ in the variant (`v<version> <hash8>`). Select the part in a sketch and pick the
+newer variant in the Inspector. Connector ids come from the persistent `pinIds` map in
+part.json, so pins that still exist keep their ids and wires stay attached.
+
+**Why must Fritzing be closed for `install`?** Fritzing scans its user parts folder only at
+startup, so a part copied in while it runs would not show up (and it may write the same
+files). `install` and `prune` refuse while Fritzing is running and say why.
+
+**Where are parts installed?** Into Fritzing's user parts folder, one folder per moduleId:
+`%APPDATA%\Fritzing\Fritzing\local_parts\user\<moduleId>\` on Windows,
+`~/Library/Application Support/Fritzing/Fritzing/local_parts/user/` on macOS,
+`~/.local/share/Fritzing/Fritzing/local_parts/user/` on Linux. This is the same layout
+Fritzing's own File > Open import writes; the part shows up in My Parts at the next start.
+
+**Should I use the photo artwork style?** Usually not. The default vector style looks like
+Fritzing's own parts, stays sharp, is small and survives Fritzing's Parts Editor. The photo
+style (`artwork.style: "photo"`) embeds the listing photo with vector pads on top; Fritzing's
+Parts Editor drops embedded rasters if you edit the part, it pixelates when zoomed, and
+Gerber export strips images (the PCB view is always vector).
+
+**Can it do the PCB view?** Yes: a real footprint from the pad table (through-hole pads on
+both copper layers with their drill size, SMD and castellated pads on top copper, the
+outline on silkscreen). Positions are only as good as the measurements in part.json, so
+verify against a datasheet drawing or calipers before fabricating a board.
+
+## Development
+
+```
+npm ci
+npm test                 # vitest with coverage
+npm run lint             # eslint
+npm run format:check     # prettier
+npm run check-ascii      # every tracked file must be ASCII
+npm run build            # tsc to dist/
+npm run fritzkit -- <args>   # run the CLI from source
+```
+
+`tools/fzp-checker/` vendors Fritzing's `fzp_checker` (from fritzing-parts 1.0.7) for CI:
+`uv run --project tools/fzp-checker check-fzp <file.fzpz>`. `npm run e2e` is a local-only
+acceptance harness that drives a real Fritzing install; it needs a desktop session with
+Fritzing 1.0.7 installed and is not run in CI. `.mcp.json` points Claude Code at the MCP
+server from source when you work in this repo. Keep its server name `fritzkit`: the plugin
+manifest declares a server with the same name, which replaces the dev entry when the plugin
+is installed, so installers run `npx -y fritzkit mcp` and never the source checkout.
+
+## Releasing
+
+`release.yml` runs after every green CI run on `main` (plus a daily cron) and publishes a
+patch release, the same setup as `pmaxhogan/tasker-mcp`. The version is computed from the
+registry (latest published patch + 1, never below the `major.minor.0` floor in
+`package.json`) and is not committed back. The job installs with `--ignore-scripts` and no
+dependency cache, and npm attaches provenance.
+
+Auth is npm trusted publishing (OIDC) only; no token is stored. Until the repository
+variable `NPM_TRUSTED_PUBLISHING` is `true`, the job runs `npm publish --dry-run` and skips
+the tag and the GitHub Release. One-time setup:
+
+1. The package must exist before a trusted publisher can be attached. Publish the first
+   version by hand: `npm login`, `npm ci`, `npm run build`, `npm publish --access public`
+   (npm asks for 2FA once).
+2. Attach the trusted publisher, allowing direct publishes (2FA once):
+
+   ```bash
+   npm trust github fritzkit --repo pmaxhogan/fritzkit --file release.yml --allow-publish
+   ```
+
+3. Arm the workflow: `gh variable set NPM_TRUSTED_PUBLISHING --body true -R pmaxhogan/fritzkit`.
+
+From then on every green push to `main` publishes `fritzkit@0.1.x`, tags `v0.1.x` and
+creates a GitHub Release with the tarball.
+
+## License
+
+fritzkit itself is MIT (see [LICENSE](LICENSE)). Parts generated with fritzkit are
+released under CC-BY-SA 3.0, the license of Fritzing's own parts library.

package/dist/cli/commands/doctor.d.ts

@@ -0,0 +1,4 @@
+/** `fritzkit doctor`: what this machine has and lacks. */
+import { type DoctorReport } from "../../core/validate/index.js";
+import type { CommandContext, CommandResult } from "../context.js";
+export declare function doctorCommand(ctx: CommandContext): Promise<CommandResult<DoctorReport>>;

package/dist/cli/commands/doctor.js

@@ -0,0 +1,7 @@
+/** `fritzkit doctor`: what this machine has and lacks. */
+import { doctor, formatDoctor } from "../../core/validate/index.js";
+export async function doctorCommand(ctx) {
+    const report = await doctor({ env: ctx.env, ...(ctx.doctorOptions ?? {}) });
+    return { exitCode: report.ok ? 0 : 1, text: formatDoctor(report), data: report };
+}
+//# sourceMappingURL=doctor.js.map

package/dist/cli/commands/doctor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"doctor.js","sourceRoot":"","sources":["../../../src/cli/commands/doctor.ts"],"names":[],"mappings":"AAAA,0DAA0D;AAC1D,OAAO,EAAE,MAAM,EAAE,YAAY,EAAqB,MAAM,8BAA8B,CAAC;AAGvF,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,GAAmB;IACrD,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,CAAC,aAAa,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC;IAC5E,OAAO,EAAE,QAAQ,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,YAAY,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;AACnF,CAAC"}

package/dist/cli/commands/export.d.ts

@@ -0,0 +1,17 @@
+import { type InstallResult } from "../../core/export/install.js";
+import { type Issue } from "../../core/validate/index.js";
+import { type CommandContext, type CommandResult } from "../context.js";
+export interface ExportOptions {
+    out?: string;
+    install?: boolean;
+    /** Export (and install) even when the structural validator reports errors. */
+    force?: boolean;
+}
+export interface ExportData {
+    moduleId: string;
+    fzpz: string;
+    issues: Issue[];
+    installed?: Pick<InstallResult, "installedDir" | "alreadyInstalled" | "files" | "warnings">;
+}
+export declare function exportCommand(part: string, opts: ExportOptions, ctx: CommandContext): Promise<CommandResult<ExportData>>;
+export declare function installCommand(part: string, opts: Omit<ExportOptions, "install">, ctx: CommandContext): Promise<CommandResult<ExportData>>;

package/dist/cli/commands/export.js

@@ -0,0 +1,81 @@
+/** `fritzkit export <part> [--out] [--install] [--force]` and `fritzkit install <part>`. */
+import { join, resolve } from "node:path";
+import { writeFzpz } from "../../core/export/fzpz.js";
+import { FritzingRunningError, installPart, } from "../../core/export/install.js";
+import { formatIssues, validateCompiled, validateFzpzFile, } from "../../core/validate/index.js";
+import { CliError, cwdOf, EXIT_FRITZING_RUNNING, fritzingPathsFor, fritzingRunningMessage, isRunningOf, resolveTarget, } from "../context.js";
+import { compileDir, warningIssues } from "./validate.js";
+async function install(source, fzpz, ctx) {
+    try {
+        return await installPart(source, {
+            paths: fritzingPathsFor(ctx.env),
+            isRunning: isRunningOf(ctx),
+        });
+    }
+    catch (e) {
+        if (e instanceof FritzingRunningError) {
+            throw new CliError(`${fritzingRunningMessage("install")}\nThe .fzpz is ready at ${fzpz}.`, EXIT_FRITZING_RUNNING);
+        }
+        throw e;
+    }
+}
+export async function exportCommand(part, opts, ctx) {
+    if (opts.out !== undefined && !/\.fzpz$/i.test(opts.out)) {
+        throw new CliError(`--out must name a .fzpz file (got "${opts.out}")`);
+    }
+    const target = await resolveTarget(part, ctx);
+    let moduleId;
+    let fzpz;
+    let issues;
+    let source;
+    if (target.kind === "fzpz") {
+        if (!opts.install) {
+            throw new CliError(`${target.path} is already a .fzpz; use \`fritzkit install\` to install it`);
+        }
+        issues = validateFzpzFile(target.path);
+        fzpz = target.path;
+        source = target.path;
+        moduleId = "";
+    }
+    else {
+        const compiled = await compileDir(target.dir, ctx);
+        moduleId = compiled.identity.moduleId;
+        issues = [...validateCompiled(compiled), ...warningIssues(compiled.warnings)];
+        fzpz = opts.out ? resolve(cwdOf(ctx), opts.out) : join(target.dir, `${moduleId}.fzpz`);
+        source = compiled;
+    }
+    const errors = issues.filter((i) => i.level === "error");
+    if (errors.length > 0 && !opts.force) {
+        return {
+            exitCode: 1,
+            text: `${formatIssues(issues)}\nnot exported: fix the errors above or pass --force`,
+            data: { moduleId, fzpz: "", issues },
+        };
+    }
+    const lines = [];
+    if (issues.length > 0)
+        lines.push(formatIssues(issues));
+    if (target.kind === "dir") {
+        await writeFzpz(source, fzpz);
+        lines.push(`wrote ${fzpz}`, `moduleId ${moduleId}`);
+    }
+    const data = { moduleId, fzpz, issues };
+    if (opts.install) {
+        const r = await install(source, fzpz, ctx);
+        data.moduleId = r.moduleId;
+        data.installed = {
+            installedDir: r.installedDir,
+            alreadyInstalled: r.alreadyInstalled,
+            files: r.files,
+            warnings: r.warnings,
+        };
+        if (target.kind === "fzpz")
+            lines.push(`moduleId ${r.moduleId}`);
+        lines.push(...r.warnings.map((w) => `warning: ${w}`), `${r.alreadyInstalled ? "re-installed" : "installed"} to ${r.installedDir}`, "start Fritzing: the part is in the My Parts bin (search for its title)");
+    }
+    return { exitCode: 0, text: lines.join("\n"), data };
+}
+export function installCommand(part, opts, ctx) {
+    return exportCommand(part, { ...opts, install: true }, ctx);
+}
+//# sourceMappingURL=export.js.map

package/dist/cli/commands/export.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"export.js","sourceRoot":"","sources":["../../../src/cli/commands/export.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AACtD,OAAO,EACL,oBAAoB,EACpB,WAAW,GAEZ,MAAM,8BAA8B,CAAC;AACtC,OAAO,EACL,YAAY,EACZ,gBAAgB,EAChB,gBAAgB,GAEjB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EACL,QAAQ,EACR,KAAK,EACL,qBAAqB,EACrB,gBAAgB,EAChB,sBAAsB,EACtB,WAAW,EACX,aAAa,GAGd,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAgB1D,KAAK,UAAU,OAAO,CACpB,MAAyC,EACzC,IAAY,EACZ,GAAmB;IAEnB,IAAI,CAAC;QACH,OAAO,MAAM,WAAW,CAAC,MAAM,EAAE;YAC/B,KAAK,EAAE,gBAAgB,CAAC,GAAG,CAAC,GAAG,CAAC;YAChC,SAAS,EAAE,WAAW,CAAC,GAAG,CAAC;SAC5B,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,IAAI,CAAC,YAAY,oBAAoB,EAAE,CAAC;YACtC,MAAM,IAAI,QAAQ,CAChB,GAAG,sBAAsB,CAAC,SAAS,CAAC,2BAA2B,IAAI,GAAG,EACtE,qBAAqB,CACtB,CAAC;QACJ,CAAC;QACD,MAAM,CAAC,CAAC;IACV,CAAC;AACH,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,IAAY,EACZ,IAAmB,EACnB,GAAmB;IAEnB,IAAI,IAAI,CAAC,GAAG,KAAK,SAAS,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QACzD,MAAM,IAAI,QAAQ,CAAC,sCAAsC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC;IACzE,CAAC;IACD,MAAM,MAAM,GAAG,MAAM,aAAa,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IAC9C,IAAI,QAAgB,CAAC;IACrB,IAAI,IAAY,CAAC;IACjB,IAAI,MAAe,CAAC;IACpB,IAAI,MAAyC,CAAC;IAE9C,IAAI,MAAM,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;QAC3B,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAClB,MAAM,IAAI,QAAQ,CAChB,GAAG,MAAM,CAAC,IAAI,6DAA6D,CAC5E,CAAC;QACJ,CAAC;QACD,MAAM,GAAG,gBAAgB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACvC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;QACnB,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC;QACrB,QAAQ,GAAG,EAAE,CAAC;IAChB,CAAC;SAAM,CAAC;QACN,MAAM,QAAQ,GAAG,MAAM,UAAU,CAAC,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QACnD,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC;QACtC,MAAM,GAAG,CAAC,GAAG,gBAAgB,CAAC,QAAQ,CAAC,EAAE,GAAG,aAAa,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC;QAC9E,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,GAAG,QAAQ,OAAO,CAAC,CAAC;QACvF,MAAM,GAAG,QAAQ,CAAC;IACpB,CAAC;IAED,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,OAAO,CAAC,CAAC;IACzD,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;QACrC,OAAO;YACL,QAAQ,EAAE,CAAC;YACX,IAAI,EAAE,GAAG,YAAY,CAAC,MAAM,CAAC,sDAAsD;YACnF,IAAI,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,EAAE,MAAM,EAAE;SACrC,CAAC;IACJ,CAAC;IAED,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC;QAAE,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;IACxD,IAAI,MAAM,CAAC,IAAI,KAAK,KAAK,EAAE,CAAC;QAC1B,MAAM,SAAS,CAAC,MAAwC,EAAE,IAAI,CAAC,CAAC;QAChE,KAAK,CAAC,IAAI,CAAC,SAAS,IAAI,EAAE,EAAE,YAAY,QAAQ,EAAE,CAAC,CAAC;IACtD,CAAC;IACD,MAAM,IAAI,GAAe,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IACpD,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;QACjB,MAAM,CAAC,GAAG,MAAM,OAAO,CAAC,MAAM,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;QAC3C,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC,QAAQ,CAAC;QAC3B,IAAI,CAAC,SAAS,GAAG;YACf,YAAY,EAAE,CAAC,CAAC,YAAY;YAC5B,gBAAgB,EAAE,CAAC,CAAC,gBAAgB;YACpC,KAAK,EAAE,CAAC,CAAC,KAAK;YACd,QAAQ,EAAE,CAAC,CAAC,QAAQ;SACrB,CAAC;QACF,IAAI,MAAM,CAAC,IAAI,KAAK,MAAM;YAAE,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;QACjE,KAAK,CAAC,IAAI,CACR,GAAG,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,YAAY,CAAC,EAAE,CAAC,EACzC,GAAG,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,WAAW,OAAO,CAAC,CAAC,YAAY,EAAE,EAC3E,wEAAwE,CACzE,CAAC;IACJ,CAAC;IACD,OAAO,EAAE,QAAQ,EAAE,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,CAAC;AACvD,CAAC;AAED,MAAM,UAAU,cAAc,CAC5B,IAAY,EACZ,IAAoC,EACpC,GAAmB;IAEnB,OAAO,aAAa,CAAC,IAAI,EAAE,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,GAAG,CAAC,CAAC;AAC9D,CAAC"}

package/dist/cli/commands/kicad.d.ts

@@ -0,0 +1,10 @@
+import { type CommandContext, type CommandResult } from "../context.js";
+export declare function importKicadCommand(file: string, opts: {
+    slug: string;
+    title?: string;
+}, ctx: CommandContext): Promise<CommandResult<{
+    slug: string;
+    dir: string;
+    partJson: string;
+    pins: number;
+}>>;

package/dist/cli/commands/kicad.js

@@ -0,0 +1,22 @@
+/** `fritzkit import-kicad <file.kicad_mod> --slug <slug> [--title <t>]`. */
+import { resolve } from "node:path";
+import { importKicadFile } from "../../core/kicad/index.js";
+import { partDir, SCHEMA_URL } from "../../core/workspace.js";
+import { cwdOf, workspaceOf } from "../context.js";
+import { createPartFolder } from "./parts.js";
+export async function importKicadCommand(file, opts, ctx) {
+    const dir = partDir(workspaceOf(ctx), opts.slug);
+    const fragment = await importKicadFile(resolve(cwdOf(ctx), file), {
+        slug: opts.slug,
+        ...(opts.title ? { title: opts.title } : {}),
+    });
+    const raw = { $schema: SCHEMA_URL, ...fragment };
+    const { partJson } = await createPartFolder(dir, raw);
+    const pins = raw.pins?.length ?? 0;
+    return {
+        exitCode: 0,
+        text: `created ${partJson} (${pins} pad${pins === 1 ? "" : "s"})\nnext: name the pins, then run: fritzkit validate ${opts.slug}`,
+        data: { slug: opts.slug, dir, partJson, pins },
+    };
+}
+//# sourceMappingURL=kicad.js.map

package/dist/cli/commands/kicad.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"kicad.js","sourceRoot":"","sources":["../../../src/cli/commands/kicad.ts"],"names":[],"mappings":"AAAA,4EAA4E;AAC5E,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAE5D,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,EAAE,KAAK,EAAE,WAAW,EAA2C,MAAM,eAAe,CAAC;AAC5F,OAAO,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAE9C,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,IAAY,EACZ,IAAsC,EACtC,GAAmB;IAEnB,MAAM,GAAG,GAAG,OAAO,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IACjD,MAAM,QAAQ,GAAG,MAAM,eAAe,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,EAAE;QAChE,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KAC7C,CAAC,CAAC;IACH,MAAM,GAAG,GAAkB,EAAE,OAAO,EAAE,UAAU,EAAE,GAAG,QAAQ,EAAE,CAAC;IAChE,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,gBAAgB,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IACtD,MAAM,IAAI,GAAG,GAAG,CAAC,IAAI,EAAE,MAAM,IAAI,CAAC,CAAC;IACnC,OAAO;QACL,QAAQ,EAAE,CAAC;QACX,IAAI,EAAE,WAAW,QAAQ,KAAK,IAAI,OAAO,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,uDAAuD,IAAI,CAAC,IAAI,EAAE;QAChI,IAAI,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE;KAC/C,CAAC;AACJ,CAAC"}