Skip to content

Latest commit

 

History

History
69 lines (51 loc) · 2.62 KB

README.md

File metadata and controls

69 lines (51 loc) · 2.62 KB

breadkit-lint

Catch breadboard wiring mistakes before you build.

RubyGems version CI status Ruby 3.3 or newer MIT license

bklint checks Breadkit circuits for placement, electrical, and connection-intent errors. It accepts Ruby DSL, YAML, TOML, and JSON IR.

Quick start

gem install breadkit-lint
bklint circuit.bk.rb
bklint circuit.bk.rb --format sarif --out lint.sarif

This README follows main (0.2.0), which requires Breadkit core 0.2.x. If the published gems are older, run both main branches from sibling checkouts:

git clone https://github.com/breadkit/breadkit.git
git clone https://github.com/breadkit/breadkit-lint.git
cd breadkit-lint
bundle install
bundle exec bklint ../breadkit/examples/01_led_button.bk.rb

What it checks

Area Example
Layout Conflicting or invalid placements.
Electrical Shorts, polarity, ratings, and missing protection.
Intent Connections that differ from declared expectations.
Style Wire colors that conflict with their net role.

Run bklint --list-rules to discover rules or bklint --explain RULE for specific guidance. The rule reference contains the full list.

Documentation

Ruby DSL files and configuration require entries can execute code. Inspect only trusted files; use JSON IR for data-only input.

Development

From the sibling checkout above, run bundle exec rake for the local checks.

License

MIT.