breadkit-lint 0.1.0 → 0.2.0

data/locales/zh.yml

@@ -0,0 +1,191 @@
+rules:
+  Layout/InvalidHole: 所选面包板上不存在该孔位。
+  Layout/UnknownBoard: 找不到所选面包板定义。
+  Layout/UnknownPart: 找不到元件定义。
+  Layout/UnknownTransistorModel: 晶体管型号未知，正在使用通用引脚排列。
+  Layout/UnknownPin: 引用的元件引脚不存在。
+  Layout/UnknownSupplySource: 所选引脚未声明为电源输出。
+  Layout/AmbiguousSupplySource: 所选电源来源匹配多个输出。
+  Layout/UnknownOption: 无法识别元件选项。
+  Layout/InvalidOption: 元件选项的值无效。
+  Layout/InvalidValue: 元件数值无效。
+  Layout/InvalidColor: 元件或导线的颜色无效。
+  Layout/InvalidRoute: 导线的布线路径无效。
+  Layout/InvalidWireId: 导线 ID 与孔位 ID 冲突。
+  Layout/UnmatchedParts: 元件定义的文件模式没有匹配项。
+  Layout/PartOverride: 自定义元件覆盖了内置元件。
+  Lint/RedundantDisable: lint_disable 没有抑制任何诊断。
+  Lint/UnknownRuleInDisable: lint_disable 指定了未知规则。
+  Layout/UnplacedPin: 元件引脚未插入面包板孔位。
+  Layout/DuplicateRef: 元件或导线的标识符重复。
+  Layout/InvalidPlacement: 元件无法按指定位置安装在面包板上。
+  Layout/HoleConflict: 多个引脚占用了同一个孔位。
+  Layout/HoleCovered: 模块或 DIP 本体盖住了其他引脚或导线端点。
+  Layout/BodyOverlap: 两个元件本体发生重叠。
+  Layout/WireOverIC: 直线跳线穿过 DIP 芯片本体。
+  Layout/LeadSpan: 引脚孔位间距超过元件引脚的最大跨度。
+  Layout/NoFreeHole: 自动布线找不到空闲孔位。
+  Layout/SplitNetLabel: 同一标签被赋给互不连通的网络。
+  Layout/PinsInSameStrip: 同一元件的多个引脚接入同一导电条。
+  Electrical/ShortCircuit: 电源电位约束互相冲突。
+  Electrical/ShortedComponent: 双端元件被导线旁路。
+  Electrical/FloatingPin: 元件引脚没有外部连接。
+  Electrical/FloatingInput: 输入网络没有已建模的驱动源或上拉下拉电阻。
+  Electrical/MissingPullResistor: 由电源切换的输入缺少上拉或下拉电阻。
+  Electrical/DanglingWire: 导线端点没有连接到其他对象。
+  Electrical/SplitRail: 分段电源轨的一段没有供电。
+  Electrical/MissingSeriesResistor: LED 缺少限流电阻。
+  Electrical/MinimumResistance: LED 的可变电阻限流路径可能降到 0 Ω。
+  Electrical/RailPolarityMismatch: 电源正负端与电源轨的极性标记相反。
+  Electrical/ReversePolarity: 有极性元件的接线方向相反。
+  Electrical/PowerPinUnconnected: 芯片电源或接地引脚未接入电源。
+  Electrical/SupplyVoltageRange: 芯片电源电压超出额定范围。
+  Electrical/NoCommonGround: 多个电源没有共用地参考。
+  Electrical/VoltageDomainMismatch: 信号电压超出引脚容许范围。
+  Electrical/ResistorPowerRating: 电阻的估算耗散功率超过额定值。
+  Electrical/CapacitorVoltageRating: 电解电容的估算电压超过额定值。
+  Electrical/LedOvercurrent: LED 的估算电流超过额定值。
+  Electrical/GpioOvercurrent: 输出引脚的估算电流超过额定值。
+  Electrical/I2CAddressConflict: 同一 I2C 总线上存在重复地址。
+  Electrical/I2CPullupMissing: I2C 信号线缺少上拉电阻。
+  Electrical/MissingDecouplingCapacitor: 芯片电源引脚之间缺少去耦电容。
+  Electrical/MissingBaseResistor: 输出引脚与晶体管基极之间缺少串联电阻。
+  Electrical/MissingFlybackDiode: 感性负载两端缺少反向续流二极管。
+  Electrical/SupplyOverload: 电源供给电流超过规定上限。
+  Electrical/NetLabelConflict: 同一网络被赋予不同标签。
+  Intent/ConnectionMismatch: 实际接线与声明的连接意图不符。
+  Intent/UnknownNet: 连接声明引用了未知网络。
+  Intent/MeasurementUnavailable: 无法计算指定的直流电压或电流。
+  Style/WireColor: 导线颜色不符合电源轨的颜色约定。
+guidance:
+  Lint/RedundantDisable: 删除未使用的 lint_disable，或修正其规则及目标。
+  Lint/UnknownRuleInDisable: 用 bklint --list-rules 确认规则 ID。
+  Layout/InvalidHole: 使用所选面包板上实际存在的孔位 ID。
+  Layout/UnknownBoard: 选择已有面包板，或通过 use_boards 加载定义。
+  Layout/UnknownPart: 核对元件 ID，或通过 use_parts 加载定义。
+  Layout/UnknownTransistorModel: 核对实物引脚排列并定义准确的型号。
+  Layout/UnknownPin: 使用元件定义中的引脚名称或编号。
+  Layout/UnknownSupplySource: 选择元件定义中声明为电源输出的引脚。
+  Layout/AmbiguousSupplySource: 为每个电源输出指定唯一的正极引脚。
+  Layout/UnknownOption: 使用元件定义中声明的属性。
+  Layout/InvalidOption: 为元件属性选择允许的值。
+  Layout/InvalidValue: 核对元件数值的数字和单位。
+  Layout/InvalidColor: 使用 CSS 颜色名、十六进制颜色、rgb() 或 hsl()。
+  Layout/InvalidRoute: 选择受支持的导线布线路径。
+  Layout/InvalidWireId: 使用不会与孔位 ID 混淆的导线 ID。
+  Layout/UnmatchedParts: 核对 use_parts 的路径及文件模式。
+  Layout/PartOverride: 核对覆盖后元件的引脚排列和属性。
+  Layout/UnplacedPin: 将每个必需引脚插入面包板孔位。
+  Layout/DuplicateRef: 为元件、导线和电源分别指定唯一 ID。
+  Layout/InvalidPlacement: 检查封装、面包板边缘和中央沟槽。
+  Layout/HoleConflict: 每个孔位只插入一个引脚。
+  Layout/HoleCovered: 将引脚或导线端点移至模块本体外的孔位。
+  Layout/BodyOverlap: 调整元件位置，避免本体相互重叠。
+  Layout/WireOverIC: 如需保持导线可见，请绕开芯片本体布线。
+  Layout/LeadSpan: 缩短引脚间距，或选用引脚足够长的元件。
+  Layout/NoFreeHole: 使用目标导电条或电源轨上的空闲孔位。
+  Layout/SplitNetLabel: 用导线连接具有相同标签的网络。
+  Layout/PinsInSameStrip: 将该元件的引脚插到不同的导电条。
+  Electrical/ShortCircuit: 检查报告中的短路路径和电源端子。
+  Electrical/ShortedComponent: 将元件两端连接到不同的网络。
+  Electrical/FloatingPin: 连接该引脚；有意悬空时将其标记为 unused。
+  Electrical/FloatingInput: 添加上拉下拉电阻，或将输入接到已建模的输出。
+  Electrical/MissingPullResistor: 添加固定电阻，使开关断开时输入有确定电位。
+  Electrical/DanglingWire: 将导线两端接到元件、电源或其他导线。
+  Electrical/SplitRail: 用导线桥接报告中的两个孔位。
+  Electrical/MissingSeriesResistor: 在 LED 路径中串联限流电阻。
+  Electrical/MinimumResistance: 在 LED 和可变电阻的路径中串联固定电阻。
+  Electrical/RailPolarityMismatch: 对照电源轨极性标记检查电源端子。
+  Electrical/ReversePolarity: "检查元件极性及电压；若为有意反向偏置，请使用 bias: :reverse 声明。"
+  Electrical/PowerPinUnconnected: 将电源与接地引脚连接到对应电源网络。
+  Electrical/SupplyVoltageRange: 将芯片电源电压保持在其额定范围内。
+  Electrical/NoCommonGround: 在需要共同参考的电路中连接电源地。
+  Electrical/VoltageDomainMismatch: 使用电平转换器或分压器降低信号电压。
+  Electrical/ResistorPowerRating: 使用更高功率额定值的电阻，或降低其耗散功率。
+  Electrical/CapacitorVoltageRating: 使用额定电压高于实际电压的电容。
+  Electrical/LedOvercurrent: 增加或加大串联电阻，使电流低于 LED 上限。
+  Electrical/GpioOvercurrent: 减少负载，使电流低于输出引脚上限。
+  Electrical/I2CAddressConflict: 修改其中一个设备的地址，或改用另一条 I2C 总线。
+  Electrical/I2CPullupMissing: 从 SDA 和 SCL 分别接固定上拉电阻至适当电源。
+  Electrical/MissingDecouplingCapacitor: 在芯片电源和接地引脚之间放置去耦电容。
+  Electrical/MissingBaseResistor: 在输出引脚与晶体管基极之间串联电阻。
+  Electrical/MissingFlybackDiode: 在感性负载两端反向并联二极管。
+  Electrical/SupplyOverload: 减少负载，或选用供电能力足够的电源。
+  Electrical/NetLabelConflict: 解决同一网络上的标签冲突。
+  Intent/ConnectionMismatch: 使 expect 声明与实际导线及网络标签一致。
+  Intent/UnknownNet: 核对 expect 声明中的网络或引脚名称。
+  Intent/MeasurementUnavailable: 接入有地参考的电源和受支持的无源元件，或使用电路仿真器。
+  Style/WireColor: 正电压使用红色或橙色，接地使用黑色或蓝色，或自定义颜色约定。
+messages:
+  diagnostic_invalid_hole: "无效的孔位或端点：%{target}"
+  diagnostic_unknown_board: "找不到面包板定义：%{target}"
+  diagnostic_unknown_part: "找不到元件定义：%{target}"
+  diagnostic_unknown_transistor_model: "晶体管型号未知，使用通用 EBC 引脚排列：%{target}"
+  diagnostic_unknown_pin: "找不到引脚：%{target}"
+  diagnostic_unknown_supply_source: "此端点未声明为电源输出：%{target}"
+  diagnostic_ambiguous_supply_source: "此电源来源匹配多个输出：%{target}"
+  diagnostic_unknown_option: "找不到元件选项：%{option}"
+  diagnostic_invalid_option: "元件选项的值无效：%{target}（%{reason}）"
+  diagnostic_invalid_value: "元件数值无效：%{target}（%{reason}）"
+  diagnostic_invalid_color: "颜色无效：%{target}（%{reason}）"
+  diagnostic_invalid_route: "导线布线路径无效：%{target}（%{reason}）"
+  diagnostic_invalid_wire_id: "导线 ID 与孔位 ID 冲突：%{target}"
+  diagnostic_unmatched_parts: "没有匹配的元件定义文件：%{reason}"
+  diagnostic_part_override: "自定义元件覆盖了内置元件：%{reason}"
+  diagnostic_unplaced_pin: "元件引脚未插入孔位：%{target}"
+  diagnostic_duplicate_ref: "标识符重复：%{target}"
+  diagnostic_invalid_placement: "元件位置无效：%{target}（%{reason}）"
+  placement_straddle: "必须跨越中央沟槽"
+  placement_bounds_or_gap: "封装越过面包板边缘或进入中央沟槽"
+  placement_bounds: "封装越过面包板边缘"
+  placement_footprint: "引脚位置与封装不符"
+  placement_anchor: "请指定端子孔位作为锚点"
+  diagnostic_hole_conflict: "多个端子占用同一孔位：%{target}"
+  hole_covered_lead: "%{pin} 插在 %{module} 本体下方的 %{hole}"
+  hole_covered_wire: "%{wire} 的端点插在 %{module} 本体下方的 %{hole}"
+  body_overlap: "%{first} 与 %{second} 的本体重叠"
+  wire_over_ic: "%{wire} 穿过 %{ic} 的本体"
+  lead_span: "%{ref} 的引脚间距为 %{actual} mm，超过 %{limit} mm 上限"
+  diagnostic_no_free_hole: "找不到空闲孔位：%{target}"
+  diagnostic_split_net_label: "同一标签出现在互不连通的网络上：%{target}"
+  diagnostic_unknown_net: "找不到网络：%{target}"
+  rule_error: "检查 %{rule} 时出错：%{error}"
+  same_strip: "%{ref} 的引脚 %{left} 与 %{right} 位于同一导电条 %{strip}"
+  short_circuit: "%{first}（%{first_voltage} V）与 %{second}（%{second_voltage} V）在网络 %{net} 上电位冲突（路径：%{path}）"
+  shorted_component: "%{ref} 的两端连接到同一网络"
+  unplaced_pin: "%{pin} 未插入面包板孔位"
+  floating_pin: "%{pin} 没有外部连接"
+  floating_input: "%{pin} 没有已建模的驱动源或上拉下拉电阻"
+  missing_pull_resistor: "开关 %{switch} 断开时，%{pin} 可能悬空；请添加上拉或下拉电阻"
+  dangling_wire: "%{wire} 的端点未连接"
+  split_rail: "%{rail} 的使用区段没有供电；请桥接 %{bridge}"
+  missing_series_resistor: "%{ref} 缺少串联限流电阻"
+  series_resistor_recommendation: "请串联至少 %{resistance} 的 E12 系列电阻。这是根据最高电源电压 %{voltage} V、声明的正向电压 %{forward_voltage} V 和最大电流 %{current} mA 估算的；请核对公差。"
+  minimum_resistance: "%{led} 仅靠可变电阻 %{pot} 限流；滑动端到达端点时可能降至 0 Ω"
+  rail_polarity_mismatch: "%{source} 的正极接到 %{positive_rail}，负极接到 %{negative_rail}，与电源轨标记相反"
+  reverse_polarity: "%{ref} 的正极电位低于负极"
+  power_pin: "%{pin} 未接入有效电源"
+  supply_range: "%{ref} 的 %{power}/%{ground} 间电压为 %{voltage} V（额定 %{minimum}–%{maximum} V）"
+  common_ground: "多个电源没有共用地参考"
+  voltage_domain: "%{pin} 承受 %{voltage} V（上限 %{maximum} V）"
+  i2c_address: "%{refs} 在同一 I2C 总线上使用地址 %{address}"
+  i2c_pullup_missing: "%{refs} 的 I2C %{line} 信号线缺少上拉电阻"
+  missing_decoupling_capacitor: "%{ref} 的 %{power} 与 %{ground} 之间缺少电容"
+  missing_base_resistor: "%{driver} 没有通过串联电阻就驱动 %{base}"
+  missing_flyback_diode: "%{ref} 的 %{positive} 与 %{negative} 之间缺少反向续流二极管"
+  supply_overload: "%{supply} 的供电电流为 %{current} mA（上限 %{limit} mA）"
+  gpio_overcurrent: "%{pin} 的电流为 %{current} mA（上限 %{limit} mA）"
+  wire_color: "%{wire} 的颜色 %{color} 不符合预期颜色 %{expected}"
+  label_conflict: "同一网络有不同标签：%{labels}"
+  unknown_expectation: "连接声明引用了未知对象：%{refs}"
+  unknown_state: "未知电路状态：%{state}"
+  measurement_unavailable: "无法验证 %{ref} 的 %{kind}：%{reason}"
+  measurement_mismatch: "%{ref} 的 %{kind} 应为 %{range} %{unit}，实际为 %{value} %{unit}"
+  expected_connected: "%{refs} 应当连接"
+  expected_isolated: "%{refs} 应当互相隔离"
+  undeclared_pins: "声明的网络包含未声明引脚：%{pins}"
+  expected_net_name: "网络名称应为 %{expected}，实际为 %{actual}；可用 net :%{expected}, at: ... 添加标签"
+  expected_one_net: "%{refs} 应位于同一网络"
+  unknown_disable: "lint_disable 指定了未知规则：%{rule}"
+  disable_reason: "%{rule} 的 lint_disable 必须填写原因"
+  redundant_disable: "%{rule} 的 lint_disable 没有抑制任何诊断"

data/package-lock.json

@@ -9,6 +9,7 @@
       "version": "0.0.0",
       "devDependencies": {
         "@tailwindcss/cli": "4.3.3",
+        "markdown-it": "^15.0.2",
         "tailwindcss": "4.3.3"
       }
     },
@@ -677,6 +678,23 @@
         "node": ">= 20"
       }
     },
+    "node_modules/argparse": {
+      "version": "3.0.2",
+      "resolved": "https://registry.npmjs.org/argparse/-/argparse-3.0.2.tgz",
+      "integrity": "sha512-mFdDM6WqWKraGLsVb+C9CahPnzTXOefAOLq3jYcca2YZ8bEWpr++Tzj+zSaKW9+X9L5uSxcm1AZ3Y6aZJ09OhQ==",
+      "dev": true,
+      "funding": [
+        {
+          "type": "github",
+          "url": "https://github.com/sponsors/puzrin"
+        },
+        {
+          "type": "github",
+          "url": "https://github.com/sponsors/nodeca"
+        }
+      ],
+      "license": "PSF-2.0"
+    },
     "node_modules/braces": {
       "version": "3.0.3",
       "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.3.tgz",
@@ -717,6 +735,19 @@
         "node": ">=10.13.0"
       }
     },
+    "node_modules/entities": {
+      "version": "8.1.0",
+      "resolved": "https://registry.npmjs.org/entities/-/entities-8.1.0.tgz",
+      "integrity": "sha512-kxL7msIffSuh9aaFAMD7rxAIuTRMAHMeBtgHW2yUdWw732ZNh4MehkF2gdjvtdmikkaIP9bFDDJOPlsvm7avrA==",
+      "dev": true,
+      "license": "BSD-2-Clause",
+      "engines": {
+        "node": ">=20.19.0"
+      },
+      "funding": {
+        "url": "https://github.com/fb55/entities?sponsor=1"
+      }
+    },
     "node_modules/fill-range": {
       "version": "7.1.1",
       "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.1.1.tgz",
@@ -1063,6 +1094,26 @@
         "node": ">=8"
       }
     },
+    "node_modules/linkify-it": {
+      "version": "6.1.0",
+      "resolved": "https://registry.npmjs.org/linkify-it/-/linkify-it-6.1.0.tgz",
+      "integrity": "sha512-wJ/TwpSDTLepCrQoYWYIExIKg5Zchex2Nn5yk2mFnB+6PtdkHtyLx742md9csRjjOnGkKIS/RrbY7l8D6gT9Vw==",
+      "dev": true,
+      "funding": [
+        {
+          "type": "github",
+          "url": "https://github.com/sponsors/puzrin"
+        },
+        {
+          "type": "github",
+          "url": "https://github.com/sponsors/markdown-it"
+        }
+      ],
+      "license": "MIT",
+      "dependencies": {
+        "uc.micro": "^3.0.0"
+      }
+    },
     "node_modules/magic-string": {
       "version": "0.30.21",
       "resolved": "https://registry.npmjs.org/magic-string/-/magic-string-0.30.21.tgz",
@@ -1073,6 +1124,41 @@
         "@jridgewell/sourcemap-codec": "^1.5.5"
       }
     },
+    "node_modules/markdown-it": {
+      "version": "15.0.2",
+      "resolved": "https://registry.npmjs.org/markdown-it/-/markdown-it-15.0.2.tgz",
+      "integrity": "sha512-q4IGxMv56jCqT4OCRCADBoDP3LO4MhmTXjFbphHPXs4g3j9Xg5RDnxqN8IF/3vIWEU+VCnUq+7JUg/cfy2E6Qw==",
+      "dev": true,
+      "funding": [
+        {
+          "type": "github",
+          "url": "https://github.com/sponsors/puzrin"
+        },
+        {
+          "type": "github",
+          "url": "https://github.com/sponsors/markdown-it"
+        }
+      ],
+      "license": "MIT",
+      "dependencies": {
+        "argparse": "^3.0.0",
+        "entities": "^8.0.0",
+        "linkify-it": "^6.0.0",
+        "mdurl": "^2.1.0",
+        "punycode.js": "^2.3.1",
+        "uc.micro": "^3.0.0"
+      },
+      "bin": {
+        "markdown-it": "bin/markdown-it.mjs"
+      }
+    },
+    "node_modules/mdurl": {
+      "version": "2.1.0",
+      "resolved": "https://registry.npmjs.org/mdurl/-/mdurl-2.1.0.tgz",
+      "integrity": "sha512-1+HBaOx0zi/dQWht8rNv9MYf9qqpqL/kxI0hXImU6Y547zM6Sni8BQibt7ifgMcYtQg41ao3Ivd6cnSM86inpg==",
+      "dev": true,
+      "license": "MIT"
+    },
     "node_modules/micromatch": {
       "version": "4.0.8",
       "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.8.tgz",
@@ -1124,6 +1210,16 @@
         "url": "https://github.com/sponsors/jonschlinkert"
       }
     },
+    "node_modules/punycode.js": {
+      "version": "2.3.1",
+      "resolved": "https://registry.npmjs.org/punycode.js/-/punycode.js-2.3.1.tgz",
+      "integrity": "sha512-uxFIHU0YlHYhDQtV4R9J6a52SLx28BCjT+4ieh7IGbgwVJWO+km431c4yRlREUAsAmt/uMjQUyQHNEPf0M39CA==",
+      "dev": true,
+      "license": "MIT",
+      "engines": {
+        "node": ">=6"
+      }
+    },
     "node_modules/source-map-js": {
       "version": "1.2.1",
       "resolved": "https://registry.npmjs.org/source-map-js/-/source-map-js-1.2.1.tgz",
@@ -1167,6 +1263,13 @@
       "engines": {
         "node": ">=8.0"
       }
+    },
+    "node_modules/uc.micro": {
+      "version": "3.0.0",
+      "resolved": "https://registry.npmjs.org/uc.micro/-/uc.micro-3.0.0.tgz",
+      "integrity": "sha512-U3PppEkleoTnIfi8BozMx3yju3qc/L6SwqWo2Sw+54PX+PX0q9I+r1Um5HCmqD7n9VDX5/v3vQH/AjA6deDdtw==",
+      "dev": true,
+      "license": "MIT"
     }
   }
 }

data/package.json

@@ -3,10 +3,11 @@
   "private": true,
   "version": "0.0.0",
   "scripts": {
-    "build": "mkdir -p _site && cp -R site/. _site/ && tailwindcss -i site/styles.css -o _site/assets/site.css --minify"
+    "build": "mkdir -p _site && cp -R site/. _site/ && node scripts/build-rule-pages.mjs && tailwindcss -i site/styles.css -o _site/assets/site.css --minify && node scripts/check-rule-pages.mjs"
   },
   "devDependencies": {
     "@tailwindcss/cli": "4.3.3",
+    "markdown-it": "^15.0.2",
     "tailwindcss": "4.3.3"
   }
 }

data/scripts/action-run.sh

@@ -0,0 +1,51 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+: "${GITHUB_ACTION_PATH:?}"
+: "${GITHUB_WORKSPACE:?}"
+: "${GITHUB_OUTPUT:?}"
+: "${RUNNER_TEMP:?}"
+: "${INPUT_PATH:?}"
+
+case "${INPUT_UPLOAD_SARIF:-true}" in
+  true|false) ;;
+  *) echo "upload-sarif must be true or false" >&2; exit 2 ;;
+esac
+
+# Pin core source until the 0.2 gem is published. The action's own checkout is
+# the lint source, so both gems resolve without relying on an unpublished gem.
+core_sha=210347f5a095adbe7814911f501395d8717dd027
+core_dir="${BREADKIT_ACTION_CORE_DIR:-$(mktemp -d "$RUNNER_TEMP/breadkit-core.XXXXXX")}"
+if [[ -z "${BREADKIT_ACTION_CORE_DIR:-}" ]]; then
+  git init --quiet "$core_dir"
+  git -C "$core_dir" remote add origin https://github.com/breadkit/breadkit.git
+  git -C "$core_dir" fetch --quiet --depth 1 origin "$core_sha"
+  git -C "$core_dir" checkout --quiet --detach FETCH_HEAD
+fi
+
+bundle_file="$(mktemp "$RUNNER_TEMP/breadkit-action-Gemfile.XXXXXX")"
+ruby -e 'core, lint, file = ARGV; File.write(file, "source \"https://rubygems.org\"\ngem \"breadkit\", path: #{core.inspect}\ngem \"breadkit-lint\", path: #{lint.inspect}\n")' \
+  "$core_dir" "$GITHUB_ACTION_PATH" "$bundle_file"
+export BUNDLE_GEMFILE="$bundle_file"
+bundle install --quiet
+
+cd "$GITHUB_WORKSPACE"
+set +e
+if [[ "${INPUT_UPLOAD_SARIF:-true}" == "true" ]]; then
+  # Keep the upload path inside the workspace, as required by upload-sarif.
+  report_dir="$(mktemp -d "$GITHUB_WORKSPACE/.breadkit-lint.XXXXXX")"
+  report="$report_dir/bklint.sarif"
+  bundle exec ruby "$GITHUB_ACTION_PATH/exe/bklint" --format sarif --out "$report" --fail-level "${INPUT_FAIL_LEVEL:-warning}" -- "$INPUT_PATH"
+  status=$?
+  if [[ -s "$report" ]]; then
+    printf 'sarif-file=%s\n' "${report#"$GITHUB_WORKSPACE"/}" >> "$GITHUB_OUTPUT"
+  elif [[ "$status" -lt 2 ]]; then
+    echo "bklint produced no SARIF report" >&2
+    exit 2
+  fi
+else
+  bundle exec ruby "$GITHUB_ACTION_PATH/exe/bklint" --format github --fail-level "${INPUT_FAIL_LEVEL:-warning}" -- "$INPUT_PATH"
+  status=$?
+fi
+set -e
+printf 'exit-code=%s\n' "$status" >> "$GITHUB_OUTPUT"

data/scripts/build-rule-pages.mjs

@@ -0,0 +1,87 @@
+import { readFileSync, readdirSync, mkdirSync, rmSync, writeFileSync } from "node:fs";
+import { join } from "node:path";
+import MarkdownIt from "markdown-it";
+
+const markdown = new MarkdownIt({ html: false, linkify: true });
+const source = "docs/rules";
+const output = "_site/rules";
+const categories = ["Layout", "Electrical", "Intent", "Style", "Lint"];
+const files = readdirSync(source, { recursive: true }).filter(file => file.endsWith(".md") && file.includes("/"));
+const rules = files.map(file => {
+  const id = file.replace(/\.md$/, "");
+  const contents = readFileSync(join(source, file), "utf8");
+  const summary = contents.split(/\n\s*\n/).slice(1).find(part => part && !part.startsWith("```")) || "";
+  return { id, contents, summary };
+}).sort((a, b) => a.id.localeCompare(b.id));
+
+function escapeHtml(value) {
+  return value.replaceAll("&", "&amp;").replaceAll("<", "&lt;").replaceAll(">", "&gt;").replaceAll('"', "&quot;");
+}
+
+function layout(title, content, depth) {
+  const root = "../".repeat(depth);
+  const pageTitle = title === "Rule reference" ? "Rule reference | breadkit-lint" : `${title} | breadkit-lint`;
+  return `<!doctype html>
+<html lang="en">
+<head>
+  <meta charset="utf-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <meta name="theme-color" content="#101719">
+  <meta name="description" content="Breadkit lint rule reference: ${escapeHtml(title)}">
+  <title>${escapeHtml(pageTitle)}</title>
+  <link rel="canonical" href="https://breadkit.github.io/breadkit-lint/rules/${depth === 1 ? "" : `${title}/`}">
+  <link rel="icon" href="${root}favicon.svg" type="image/svg+xml">
+  <link rel="stylesheet" href="${root}assets/site.css">
+</head>
+<body class="min-h-dvh bg-ink font-sans text-paper antialiased">
+  <a class="sr-only rounded-sm bg-copper px-4 py-3 font-semibold text-ink focus:not-sr-only focus:fixed focus:left-4 focus:top-4" href="#main">Skip to content</a>
+  <header class="border-b border-line"><div class="mx-auto flex max-w-7xl flex-wrap items-center justify-between gap-4 px-5 py-5 sm:px-8 lg:px-10">
+    <a class="flex items-center gap-3 rounded-sm text-xl font-semibold focus-visible:outline-2 focus-visible:outline-offset-4 focus-visible:outline-copper" href="${root}" aria-label="breadkit-lint home"><img class="size-8" src="${root}favicon.svg" alt="" width="32" height="32"><span>breadkit-lint</span></a>
+    <nav aria-label="Main navigation" class="flex flex-wrap items-center gap-x-5 gap-y-2 text-sm text-muted"><a class="text-paper focus-visible:outline-2 focus-visible:outline-offset-4 focus-visible:outline-copper" href="${root}rules/" aria-current="page">Rules</a><a class="hover:text-paper focus-visible:outline-2 focus-visible:outline-offset-4 focus-visible:outline-copper" href="https://breadkit.github.io/breadkit/guide/">Guide</a><a class="hover:text-paper focus-visible:outline-2 focus-visible:outline-offset-4 focus-visible:outline-copper" href="https://github.com/breadkit/breadkit-lint">GitHub</a></nav>
+  </div></header>
+  <main id="main" class="mx-auto max-w-7xl px-5 py-12 sm:px-8 lg:px-10">${content}</main>
+  <footer class="mt-16 border-t border-line"><div class="mx-auto max-w-7xl px-5 py-7 text-sm text-muted sm:px-8 lg:px-10">breadkit-lint is published independently from breadkit.</div></footer>
+</body>
+</html>`;
+}
+
+rmSync(output, { recursive: true, force: true });
+mkdirSync(output, { recursive: true });
+for (const rule of rules) {
+  const directory = join(output, rule.id);
+  mkdirSync(directory, { recursive: true });
+  const content = `<a class="text-sm text-muted underline decoration-line underline-offset-4 hover:text-paper" href="../../">All rules</a>
+    <article class="rule-doc mt-8">${markdown.render(rule.contents)}</article>`;
+  writeFileSync(join(directory, "index.html"), layout(rule.id, content, 3));
+}
+
+const sections = categories.map(category => {
+  const entries = rules.filter(rule => rule.id.startsWith(`${category}/`));
+  if (!entries.length) return "";
+  const items = entries.map(rule => `<li class="rule-item border-t border-line py-4" data-rule="${escapeHtml(rule.id.toLowerCase())}">
+    <a class="font-mono text-paper underline decoration-line underline-offset-4 hover:decoration-copper focus-visible:outline-2 focus-visible:outline-offset-4 focus-visible:outline-copper" href="${rule.id}/">${escapeHtml(rule.id)}</a>
+    <p class="rule-summary mt-2 text-pretty text-sm leading-6 text-muted">${markdown.renderInline(rule.summary)}</p>
+  </li>`).join("");
+  return `<section class="rule-category mt-10" aria-labelledby="${category.toLowerCase()}-heading"><h2 id="${category.toLowerCase()}-heading" class="text-balance text-2xl font-semibold">${category}</h2><ul class="mt-4">${items}</ul></section>`;
+}).join("");
+const index = `<div class="max-w-3xl"><h1 class="text-balance text-4xl font-semibold leading-tight sm:text-5xl">Rule reference</h1>
+  <p class="mt-4 text-pretty text-lg leading-8 text-muted">Find what each check means, see an example, and learn how to fix it.</p>
+  <label class="mt-8 block text-sm font-medium" for="rule-search">Search rules</label>
+  <input id="rule-search" class="mt-2 w-full rounded-md border border-line bg-board px-4 py-3 text-paper focus-visible:outline-2 focus-visible:outline-offset-2 focus-visible:outline-copper" type="search" autocomplete="off" placeholder="Search by rule name" aria-controls="rule-list">
+  <p id="rule-count" class="mt-3 text-sm text-muted" role="status">${rules.length} rules</p>
+  <div id="rule-list">${sections}</div>
+  <p id="rule-empty" class="mt-8 text-muted" hidden>No rules match. Try a shorter name.</p>
+</div>
+<script>
+  const search = document.querySelector('#rule-search');
+  const items = [...document.querySelectorAll('.rule-item')];
+  search.addEventListener('input', () => {
+    const query = search.value.trim().toLowerCase();
+    let count = 0;
+    for (const item of items) { item.hidden = !item.dataset.rule.includes(query); if (!item.hidden) count++; }
+    for (const section of document.querySelectorAll('.rule-category')) section.hidden = !section.querySelector('.rule-item:not([hidden])');
+    document.querySelector('#rule-count').textContent = count + (count === 1 ? ' rule' : ' rules');
+    document.querySelector('#rule-empty').hidden = count !== 0;
+  });
+</script>`;
+writeFileSync(join(output, "index.html"), layout("Rule reference", index, 1));

data/scripts/check-rule-pages.mjs

@@ -0,0 +1,18 @@
+import assert from "node:assert/strict";
+import { readFileSync, readdirSync } from "node:fs";
+import { join } from "node:path";
+
+const rules = readdirSync("docs/rules", { recursive: true })
+  .filter(file => file.endsWith(".md") && file.includes("/"))
+  .map(file => file.replace(/\.md$/, ""));
+assert.ok(rules.length > 40, "Expected the complete rule reference");
+
+const index = readFileSync("_site/rules/index.html", "utf8");
+assert.match(index, /<input[^>]+type="search"/);
+for (const rule of rules) {
+  assert.ok(index.includes(`href="${rule}/"`), `Missing index link for ${rule}`);
+  const page = readFileSync(join("_site/rules", rule, "index.html"), "utf8");
+  assert.ok(page.includes(rule), `Missing title for ${rule}`);
+  assert.ok(page.includes("<main"), `Missing page content for ${rule}`);
+}
+console.log(`Published ${rules.length} rule reference pages.`);

data/scripts/pre-commit

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "open3"
+
+paths, error, status = Open3.capture3("git", "diff", "--cached", "--name-only", "--diff-filter=ACMR", "-z")
+abort error unless status.success?
+
+command = File.file?("Gemfile") ? %w[bundle exec bklint] : ["bklint"]
+failed = false
+paths.split("\0").grep(/\.bk\.(?:rb|ya?ml|toml)\z/).each do |path|
+  source, error, status = Open3.capture3("git", "show", ":#{path}")
+  unless status.success?
+    warn error
+    failed = true
+    next
+  end
+
+  output, error, status = Open3.capture3(*command, "--stdin=#{path}", stdin_data: source)
+  print output
+  warn error unless error.empty?
+  failed ||= !status.success?
+end
+exit(failed ? 1 : 0)

data/sig/breadkit/lint.rbs

@@ -12,6 +12,7 @@ module Breadkit
       attr_reader location: Breadkit::SourceLocation?
       attr_reader targets: Hash[Symbol, untyped]
       attr_reader state: String?
+      attr_reader column: Integer?
     end
 
     class Rule
@@ -49,16 +50,26 @@ module Breadkit
 
     class Engine
       def initialize: (?config: Config) -> void
-      def run: (String | Array[String] paths, ?only: Array[String]?, ?except: Array[String]?) -> Array[Hash[Symbol, untyped]]
+      def run: (String | Array[String] paths, ?only: Array[String]?, ?except: Array[String]?, ?timeout: Numeric, ?source: String?) -> Array[Hash[Symbol, untyped]]
       def fail?: (Array[Hash[Symbol, untyped]] files, ?String threshold) -> bool
       def fatal?: (Array[Hash[Symbol, untyped]] files) -> bool
     end
 
+    class Baseline
+      def initialize: (String path) -> void
+      def write: (Array[Hash[Symbol, untyped]] files) -> Integer
+      def filter: (Array[Hash[Symbol, untyped]] files) -> Array[Hash[Symbol, untyped]]
+    end
+
     class Formatter
       def text: (Array[Hash[Symbol, untyped]] files, ?locale: String) -> String
       def json: (Array[Hash[Symbol, untyped]] files) -> String
       def github: (Array[Hash[Symbol, untyped]] files) -> String
       def sarif: (Array[Hash[Symbol, untyped]] files) -> String
+      def markdown: (Array[Hash[Symbol, untyped]] files) -> String
+      def junit: (Array[Hash[Symbol, untyped]] files) -> String
+      def checkstyle: (Array[Hash[Symbol, untyped]] files) -> String
+      def rdjson: (Array[Hash[Symbol, untyped]] files) -> String
     end
 
     class CLI

data/site/index.html

@@ -18,7 +18,7 @@
         <nav aria-label="Main navigation" class="flex flex-wrap items-center gap-x-5 gap-y-2 text-sm text-muted">
           <a class="rounded-sm hover:text-paper focus-visible:outline-2 focus-visible:outline-offset-4 focus-visible:outline-copper" href="https://breadkit.github.io/breadkit/">Breadkit</a>
           <a class="rounded-sm hover:text-paper focus-visible:outline-2 focus-visible:outline-offset-4 focus-visible:outline-copper" href="https://breadkit.github.io/breadkit/guide/">Guide</a>
-          <a class="rounded-sm hover:text-paper focus-visible:outline-2 focus-visible:outline-offset-4 focus-visible:outline-copper" href="https://breadkit.github.io/breadkit/guide/dsl/">Reference</a>
+          <a class="rounded-sm hover:text-paper focus-visible:outline-2 focus-visible:outline-offset-4 focus-visible:outline-copper" href="./rules/">Rules</a>
           <a class="rounded-sm hover:text-paper focus-visible:outline-2 focus-visible:outline-offset-4 focus-visible:outline-copper" href="https://breadkit.github.io/breadkit-render/">Render</a>
           <a class="rounded-sm hover:text-paper focus-visible:outline-2 focus-visible:outline-offset-4 focus-visible:outline-copper" href="https://github.com/breadkit/breadkit-lint">GitHub</a>
         </nav>
@@ -33,12 +33,13 @@
           <p class="mt-6 max-w-lg text-pretty text-lg leading-8 text-muted">Analyze breadboard holes and component connections to find placement errors, shorts, floating pins, and mismatches with your design intent.</p>
           <div class="mt-8 flex flex-wrap gap-x-6 gap-y-4">
             <a class="rounded-sm bg-copper px-5 py-3 font-semibold text-ink hover:bg-paper focus-visible:outline-2 focus-visible:outline-offset-4 focus-visible:outline-copper" href="#example">See a finding</a>
-            <a class="rounded-sm py-3 font-medium text-paper underline decoration-line underline-offset-4 hover:decoration-copper focus-visible:outline-2 focus-visible:outline-offset-4 focus-visible:outline-copper" href="https://github.com/breadkit/breadkit-lint/tree/main/docs/rules">Browse rules</a>
+            <a class="rounded-sm py-3 font-medium text-paper underline decoration-line underline-offset-4 hover:decoration-copper focus-visible:outline-2 focus-visible:outline-offset-4 focus-visible:outline-copper" href="./rules/">Browse rules</a>
           </div>
           <div class="mt-10 rounded-lg border border-line bg-board p-5">
-            <p class="mb-3 text-sm text-muted">Install and run</p>
+            <p class="mb-3 text-sm text-muted">Install from RubyGems</p>
             <pre class="overflow-x-auto font-mono text-sm leading-7"><code>gem install breadkit-lint
 bklint circuit.bk.rb</code></pre>
+            <p class="mt-4 text-pretty text-sm leading-6 text-muted">This site documents the main branch. Published gems may lag behind it; check the <a class="text-paper underline decoration-copper underline-offset-4 hover:decoration-paper" href="https://github.com/breadkit/breadkit-lint#quick-start">setup guide</a> for source checkout instructions.</p>
           </div>
         </div>
         <figure id="example" class="m-0 overflow-hidden rounded-xl border border-line bg-board">
@@ -50,9 +51,10 @@ supply :USB, voltage: 5.0,
 wire "a10", "B+"
 wire "b10", "B-"</code></pre>
             <div class="my-6 border-t border-line"></div>
-            <p class="mb-3 text-sm text-muted">From the bklint report</p>
+            <p class="mb-3 text-sm text-muted">Excerpt from the bklint report</p>
             <pre class="overflow-x-auto font-mono text-sm leading-7 text-paper"><code>E: [Electrical/ShortCircuit]
-inconsistent voltage constraints near USB.+</code></pre>
+USB.- (0.0 V) and USB.+ (5.0 V)
+conflict on USB+ (path: B-1 → … → B+1)</code></pre>
           </div>
           <figcaption class="border-t border-line px-5 py-4 text-pretty text-sm leading-6 text-muted">a10 and b10 share a conductive strip, so the positive and negative rails are shorted.</figcaption>
         </figure>
@@ -76,6 +78,7 @@ inconsistent voltage constraints near USB.+</code></pre>
           <pre class="mt-6 overflow-x-auto rounded-lg border border-line bg-board p-5 font-mono text-sm leading-7"><code>bklint circuit.bk.rb --format github
 bklint circuit.bk.rb --format sarif --out lint.sarif
 bklint circuit.bk.rb --only Electrical/ShortCircuit</code></pre>
+          <a class="mt-5 inline-block rounded-sm text-paper underline decoration-copper underline-offset-4 focus-visible:outline-2 focus-visible:outline-offset-4 focus-visible:outline-copper" href="schemas/lint-v1.json">Lint JSON schema</a>
         </div>
         <div class="rounded-lg border border-line bg-board p-6">
           <h3 class="text-balance text-xl font-semibold">Review findings on the diagram</h3>
@@ -87,7 +90,7 @@ bkrender circuit.bk.rb --annotations lint.json \
         </div>
       </section>
 
-      <section class="border-t border-line"><div class="mx-auto flex max-w-7xl flex-wrap items-center justify-between gap-4 px-5 py-10 sm:px-8 lg:px-10"><p class="max-w-2xl text-pretty text-sm leading-6 text-muted">DSL files and configuration <code class="font-mono text-paper">require</code> statements run as Ruby. Only process inputs you trust. Use IR JSON for data-only exchange.</p><a class="rounded-sm text-paper underline decoration-line underline-offset-4 hover:decoration-copper focus-visible:outline-2 focus-visible:outline-offset-4 focus-visible:outline-copper" href="https://breadkit.github.io/breadkit/guide/">Learn to write a circuit</a></div></section>
+      <section class="border-t border-line"><div class="mx-auto flex max-w-7xl flex-wrap items-center justify-between gap-4 px-5 py-10 sm:px-8 lg:px-10"><p class="max-w-2xl text-pretty text-sm leading-6 text-muted">Ruby DSL files and configuration <code class="font-mono text-paper">require</code> statements run as Ruby. Only process inputs you trust. YAML, TOML, and IR JSON are data-only circuit formats.</p><a class="rounded-sm text-paper underline decoration-line underline-offset-4 hover:decoration-copper focus-visible:outline-2 focus-visible:outline-offset-4 focus-visible:outline-copper" href="https://breadkit.github.io/breadkit/guide/">Learn to write a circuit</a></div></section>
     </main>
 
     <footer class="border-t border-line"><div class="mx-auto flex max-w-7xl flex-wrap items-center justify-between gap-3 px-5 py-7 text-sm text-muted sm:px-8 lg:px-10"><p>breadkit-lint is published independently from breadkit.</p><a class="rounded-sm text-paper underline decoration-line underline-offset-4 hover:decoration-copper focus-visible:outline-2 focus-visible:outline-offset-4 focus-visible:outline-copper" href="https://github.com/breadkit/breadkit-lint">GitHub repository</a></div></footer>