Circuit JSON to Readable Netlist
https://github.com/tscircuit/circuit-json-to-readable-netlist- Category
- Developer Tools
- Rank
- No. 1605Tools index
Previous survey · No. 1610 ·
- Pricing
- Open Source
- Type
- TOOL
- Builder
- tscircuit
- GitHub
- 6 stars
- Date
About
Convert Circuit JSON into a readable netlist suitable for input to AI. Part of the tscircuit electronics design ecosystem.
What it does
It turns structured circuit data into plain text organized around components, connected nets, empty net pins, and per-component pin mappings. Existing net names are preserved. Unnamed connections receive heuristic names derived from component and port labels, while footprints, values, part numbers, polarity hints, and aliases add useful context.
Why it's ranked here
This is a focused, inspectable bridge from circuit structure to text that humans and language models can scan. Its output covers both net-centric and component-centric views, and inline snapshot tests demonstrate behavior for basic passives, a labeled chip, disconnected pins, and a chip without a footprint.
What's good
The output carries more than connectivity. Component summaries include resistance, capacitance, footprints, or manufacturer part numbers when available. Pin entries preserve useful aliases and show connected net names or an explicit disconnected marker. Single-pin nets receive their own section instead of disappearing, which makes incomplete wiring easier to notice.
Tradeoffs
Automatic naming depends on a small, fixed vocabulary and simple scoring rules. Numeric text is penalized, while selected bus and signal terms receive preference. The package documents only a TypeScript library interface, with no command-line workflow. Tests cover three compact circuits, so behavior on larger or unusual circuit data is not demonstrated here.
How to use it well
Use it inside a TypeScript pipeline that already produces Circuit JSON and needs compact text for inspection or AI input. Keep explicit net names and meaningful port hints in the source data, since they directly improve output labels. It does not document schematic rendering, circuit simulation, electrical-rule checking, or a standalone command-line interface.
Technical notes+
The public export in lib/index.ts re-exports convertCircuitJsonToReadableNetlist from lib/convertCircuitJsonToReadableNetlist.ts. Conversion filters source elements before calling getFullConnectivityMapFromCircuitJson, then uses @tscircuit/circuit-json-util to collect components, ports, nets, traces, and CAD footprint data. lib/generateNetName.ts ranks candidate component and port labels, while lib/scorePhrase.ts supplies the fixed term scores and lib/getReadableNameForPin.ts formats polarity, aliases, and display values. package.json builds ESM plus declarations with tsup, declares TypeScript and circuit utilities as peer dependencies, and runs tests with Bun. Three tests under tests/ use inline snapshots.
Observed
- License
- MIT License
- Primary language
- TypeScript, including TSX tests
- Install surface
- Published package installed with Bun using bun add circuit-json-to-readable-netlist
- Interface
- ES module library with a TypeScript conversion export; no CLI is declared
- Build packaging
- tsup builds ESM output and TypeScript declarations; the published package includes the dist directory
- Peer dependencies
- TypeScript, circuit-json, @tscircuit/circuit-json-util, and circuit-json-to-connectivity-map
- Test structure
- Three Bun test files use inline snapshots for basic, chip, and missing-footprint cases
Read from README.md, package.json, lib/index.ts, lib/scorePhrase.ts, lib/generateNetName.ts, lib/getReadableNameForPin.ts, lib/convertCircuitJsonToReadableNetlist.ts, docs/CIRCUIT_JSON_SOURCE_COMPONENT_OVERVIEW.md, tests/test2-chip.test.tsx, tests/test1-basic-circuit.test.tsx, tests/test3-no-footprint-chip.test.tsx, LICENSE, bun.lock, biome.json, tsconfig.json.
What it can do
Convert Circuit JSON to readable netlist
Circuit JSON file → Readable netlist format
Generate AI-suitable netlist format
Circuit JSON data → AI-optimized netlist representation
Transform electronic circuit data for AI processing
tscircuit Circuit JSON → AI-readable circuit description
Parse Circuit JSON structure
Circuit JSON file → Structured circuit data
Export circuit netlist for external tools
Circuit JSON from tscircuit ecosystem → Standardized netlist file
Tags
Tech Stack
Comments (0)
No comments yet
Editorially curated, with community endorsements as a secondary signal. Corrections welcome.