tracespace
PCB visualization tools for Node.js and the browser
tracespace is an open-source collection of tools to make looking at circuit boards on the internet easier.
examples
Renders of the Arduino Uno produced by pcb-stackup and gerber-to-svg:
Arduino Uno design files used under the terms of the Creative Commons Attribution Share-Alike license.
Individual layers
top copper
drill hits
outline
top silkscreen
bottom copper
top soldermask
bottom soldermask
tracespace in the wild
- viewer.tracespace.io - A Gerber viewer that lets you inspect the individual layers as well as the board preview
- kitspace.org - An electronics project sharing site with links to easily buy the required parts
- OpenHardware.io - A social site around open source hardware. Enables authors to sell and manufacture their boards.
packages
pcb-stackup
Render PCBs as beautiful, precise SVGs from Gerber / NC drill files
@tracespace/cli
Render PCBs as SVGs from the comfort of your own terminal
pcb-stackup-core
Layer stacking core logic for pcb-stackup
gerber-to-svg
Render individual Gerber / NC drill files as SVGs
gerber-plotter
Streaming layer image plotter (consumer of
gerber-parser
)
gerber-parser
Streaming Gerber/drill file parser
whats-that-gerber
Identify Gerber and drill files by filename
@tracespace/xml-id
XML ID generation and sanitation utilities for tracespace projects
@tracespace/fixtures
Test fixtures for tracespace projects
contributing
We could use your help maintaining and growing the tracespace ecosystem! Issues and pull requests are greatly appreciated.
development setup
The tracespace tools live here in this monorepo. We use lerna to manage this setup.
Node v8 (lts/carbon) or later is recommended.
# clone repository and install dependencies
git clone git@github.com:tracespace/tracespace.git
cd tracespace
npm install
This repository adheres to the Conventional Changelog commit specification for automatic changelog generation. We recommend installing commitizen to ensure your commit messages are properly formatted:
npm install -g commitizen
# later, when you're ready to commit
git add some/files/*
git cz
tests
# run unit and integration tests tests with coverage and linting
npm test
# set SNAPSHOT_UPDATE=1 to update integration test snapshots
SNAPSHOT_UPDATE=1 npm test
# run unit tests in watch mode (no coverage, no linting)
npm run test:watch
# set INTEGRATION=1 to also include integration tests
INTEGRATION=1 npm run test:watch
# run unit tests in watch mode in Firefox and Chrome (using Karma)
# will autolaunch Chrome and/or Firefox if they're installed
# TODO: not yet implemented
# npm run test:browser
integration tests
Automated integration tests consist of snapshot tests of SVG and data outputs and are run automatically as part of yarn run test
.
pcb-stackup
, pcb-stackup-core
, and gerber-to-svg
also have integration test servers that serve a set of reference renders for manual visual inspection.
# run all integration test servers
npm run integration:server
# run server for a specific project
npm run integration:server --scope gerber-to-svg
linting and formatting
# format the code for styling
npm run format
# lint the code for potential errors
npm run lint
publishing
Packages are published to npm by the CI server. To publish a release, you must have write access to the repository. There is a bump
script in the package.json
that will:
- Run all tests
- Write new version to
package.json
in updated packages - Generate / update the changelogs
- Commit, tag, and push to git
# by default, bump to the next version as determined by conventional commits
npm run bump
# you may specify a bump level or exact version
# prerelease bumps will be prefixed with "next", e.g. 4.0.0 -> 4.0.1-next.0
# https://github.com/lerna/lerna/tree/master/commands/version#readme
npm run bump -- ${major|minor|patch|premajor|preminor|prepatch|prerelease}
npm run bump -- v42.0.0
# to do a "dry run", you can stop before commit, tag, and push
npm run bump -- --no-git-tag-version --no-push
The release will be published to the latest
npm tag for bare versions (e.g. 4.0.0
) and to next
for pre-release versions (e.g. 4.0.0-next.0
).