plm-mpt / tracespace

⚡️generate beautiful and accurate SVG renders of printed circuit boards

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.

packages

- Render PCBs as beautiful, precise SVGs from Gerber / NC drill files
- Layer stacking core logic for pcb-stackup
- Render individual Gerber / NC drill files as SVGs
- Streaming layer image plotter (consumer of gerber-parser)
- Streaming Gerber/drill file parser
- Identify Gerber and drill files by filename
- Test fixtures for tracespace projects
- Render PCBs as SVGs from the comfort of your own terminal

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.

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) is recommended and yarn is required.

# clone repository and install dependencies
git clone [email protected]:tracespace/tracespace.git
cd tracespace
yarn

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:

yarn global add 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
yarn run test

# set SNAPSHOT_UPDATE=1 to update integration test snapshots
SNAPSHOT_UPDATE=1 yarn run test

# run unit tests in watch mode (no coverage, no linting)
yarn run test:watch

# set INTEGRATION=1 to also include integration tests
INTEGRATION=1 yarn 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
# yarn 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
yarn run integration:server

# run server for a specific project
yarn run integration:server --scope gerber-to-svg

linting and formatting

# format the code for styling
yarn run format

# lint the code for potential errors
yarn 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 prerelease with identifier "next"
# e.g. 4.0.0 -> 4.0.1-next.0
yarn run bump

# you may specify a bump level
# https://github.com/lerna/lerna#--cd-version
yarn run bump --cd-version=${major|minor|patch|premajor|preminor|prepatch|prerelease}

# to do a "dry run", you can stop before commit, tag, and push
yarn run bump --skip-git

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).