gerber-parser

gerber parser

Work in progress.

A printed circuit board Gerber and drill file parser. Implemented as a Node transform stream that takes a Gerber text stream and emits objects to be consumed by some sort of PCB plotter.

how to

$ npm install gerber-parser

var fs = require('fs')
var gerberParser = require('gerber-parser')

var parser = gerberParser()
parser.on('warning', function(w) {
  console.warn('warning at line ' + w.line + ': ' + w.message)
})

fs.createReadStream('/path/to/gerber/file.gbr', {encoding: 'utf8'})
  .pipe(parser)
  .on('data', function(obj) {
    console.log(obj)
  })

To run in the browser, this module should be bundled with a tool like browserify or webpack.

api

See API.md

developing and contributing

Tests are written in Mocha and run in Node, PhantomJS, and a variety of browsers with Zuul and Open Sauce. All PRs should be accompanied by unit tests, with ideally one feature / bugfix per PR. Code linting happens with ESLint automatically post-test and pre-commit.

Code is deployed on tags via TravisCI and code coverage is tracked with Coveralls.

build scripts

• $ npm run lint - lints code
• $ npm run test - runs Node unit tests
• $ npm run test-watch - runs unit tests and re-runs on changes
• $ npm run browser - runs tests in a local browser
• $ npm run browser-phantom - runs tests in PhantomJS
• $ npm run browser-sauce - runs tests in Sauce Labs on multiple browsers
  • Sauce Labs account required
• $ npm run ci - Script for CI server to run
  • Runs npm test and sends coverage report to Coveralls
  • If you want to run this locally, you'll need to set some environment variables