breadkit-lint 0.1.0 → 0.2.0

data/lib/breadkit/lint/rules.rb

@@ -24,6 +24,20 @@ module Breadkit
     end
 
     module Rules
+      module Lint
+        class UnknownRuleInDisable < BuiltinRule
+          rule "Lint/UnknownRuleInDisable", severity: :error, description: "A lint_disable names an unknown rule"
+
+          def check(_context); end
+        end
+
+        class RedundantDisable < BuiltinRule
+          rule "Lint/RedundantDisable", severity: :warning, description: "A lint_disable matches no offense"
+
+          def check(_context); end
+        end
+      end
+
       module Layout
         class InvalidHole < DiagnosticRule
           rule "Layout/InvalidHole", severity: :error, description: "Unknown board hole"
@@ -55,12 +69,66 @@ module Breadkit
           def check(context) = emit_diagnostics(context)
         end
 
+        class UnknownSupplySource < DiagnosticRule
+          rule "Layout/UnknownSupplySource", severity: :error, description: "Supply source is not a provided power output"
+
+          def check(context) = emit_diagnostics(context)
+        end
+
+        class AmbiguousSupplySource < DiagnosticRule
+          rule "Layout/AmbiguousSupplySource", severity: :error, description: "Supply source matches multiple power outputs"
+
+          def check(context) = emit_diagnostics(context)
+        end
+
         class UnknownOption < DiagnosticRule
           rule "Layout/UnknownOption", severity: :error, description: "Unknown component option"
 
           def check(context) = emit_diagnostics(context)
         end
 
+        class InvalidOption < DiagnosticRule
+          rule "Layout/InvalidOption", severity: :error, description: "Invalid component option value"
+
+          def check(context) = emit_diagnostics(context)
+        end
+
+        class InvalidValue < DiagnosticRule
+          rule "Layout/InvalidValue", severity: :error, description: "Invalid component value"
+
+          def check(context) = emit_diagnostics(context)
+        end
+
+        class InvalidColor < DiagnosticRule
+          rule "Layout/InvalidColor", severity: :error, description: "Invalid component or wire color"
+
+          def check(context) = emit_diagnostics(context)
+        end
+
+        class InvalidRoute < DiagnosticRule
+          rule "Layout/InvalidRoute", severity: :error, description: "Invalid wire route"
+
+          def check(context) = emit_diagnostics(context)
+        end
+
+        class InvalidWireId < DiagnosticRule
+          rule "Layout/InvalidWireId", severity: :error, description: "Wire ID conflicts with a board hole"
+
+          def check(context) = emit_diagnostics(context)
+        end
+
+        class UnmatchedParts < DiagnosticRule
+          rule "Layout/UnmatchedParts", severity: :warning, description: "Part glob matches no files"
+
+          def check(context) = emit_diagnostics(context)
+        end
+
+        class PartOverride < DiagnosticRule
+          rule "Layout/PartOverride", severity: :warning, description: "Custom part overrides a built-in part"
+
+          def check(context) = emit_diagnostics(context)
+        end
+
         class UnplacedPin < DiagnosticRule
           rule "Layout/UnplacedPin", severity: :error, description: "A component pin has no board hole"
 
@@ -85,6 +153,30 @@ module Breadkit
           def check(context) = emit_diagnostics(context)
         end
 
+        class HoleCovered < BuiltinRule
+          rule "Layout/HoleCovered", severity: :error, description: "A module or DIP body covers another lead or wire endpoint"
+
+          def check(context) = emit(context, :hole_covered)
+        end
+
+        class BodyOverlap < BuiltinRule
+          rule "Layout/BodyOverlap", severity: :error, description: "Two component bodies overlap"
+
+          def check(context) = emit(context, :body_overlap)
+        end
+
+        class WireOverIC < BuiltinRule
+          rule "Layout/WireOverIC", severity: :info, description: "A straight jumper crosses a DIP IC body"
+
+          def check(context) = emit(context, :wire_over_ic)
+        end
+
+        class LeadSpan < BuiltinRule
+          rule "Layout/LeadSpan", severity: :error, description: "A component's leads cannot span the placed holes"
+
+          def check(context) = emit(context, :lead_span)
+        end
+
         class NoFreeHole < DiagnosticRule
           rule "Layout/NoFreeHole", severity: :error, description: "No free hole is available"
 
@@ -124,6 +216,20 @@ module Breadkit
           def check(context) = emit(context, :floating_pins)
         end
 
+        class FloatingInput < BuiltinRule
+          rule "Electrical/FloatingInput", severity: :info,
+            description: "An input net has no modeled drive or pull resistor", state_sensitive: true
+
+          def check(context) = emit(context, :floating_inputs)
+        end
+
+        class MissingPullResistor < BuiltinRule
+          rule "Electrical/MissingPullResistor", severity: :info,
+            description: "A supply-switched input has no modeled pull resistor"
+
+          def check(context) = emit(context, :missing_pull_resistors)
+        end
+
         class DanglingWire < BuiltinRule
           rule "Electrical/DanglingWire", severity: :warning, description: "A wire end has no other connection"
 
@@ -142,6 +248,20 @@ module Breadkit
           def check(context) = emit(context, :missing_series_resistors)
         end
 
+        class MinimumResistance < BuiltinRule
+          rule "Electrical/MinimumResistance", severity: :warning,
+            description: "A potentiometer can reach zero resistance in an LED current path", state_sensitive: true
+
+          def check(context) = emit(context, :minimum_resistances)
+        end
+
+        class RailPolarityMismatch < BuiltinRule
+          rule "Electrical/RailPolarityMismatch", severity: :warning,
+            description: "A source's positive and negative terminals drive oppositely marked rails"
+
+          def check(context) = emit(context, :rail_polarity_mismatch)
+        end
+
         class ReversePolarity < BuiltinRule
           rule "Electrical/ReversePolarity", severity: :error, description: "A polarized part is connected backwards", state_sensitive: true
 
@@ -172,17 +292,94 @@ module Breadkit
           def check(context) = emit(context, :label_conflicts)
         end
 
+        class VoltageDomainMismatch < BuiltinRule
+          rule "Electrical/VoltageDomainMismatch", severity: :error,
+            description: "A signal exceeds a pin's voltage limit", state_sensitive: true
+
+          def check(context) = emit(context, :voltage_domain_mismatches)
+        end
+
+        class ResistorPowerRating < BuiltinRule
+          rule "Electrical/ResistorPowerRating", severity: :error,
+            description: "A resistor exceeds its declared power rating", state_sensitive: true
+
+          def check(context) = emit(context, :resistor_power_ratings)
+        end
+
+        class CapacitorVoltageRating < BuiltinRule
+          rule "Electrical/CapacitorVoltageRating", severity: :error,
+            description: "An electrolytic exceeds its declared voltage rating", state_sensitive: true
+
+          def check(context) = emit(context, :capacitor_voltage_ratings)
+        end
+
+        class LedOvercurrent < BuiltinRule
+          rule "Electrical/LedOvercurrent", severity: :error,
+            description: "An LED exceeds its declared current limit", state_sensitive: true
+
+          def check(context) = emit(context, :led_overcurrent)
+        end
+
+        class GpioOvercurrent < BuiltinRule
+          rule "Electrical/GpioOvercurrent", severity: :error,
+            description: "A modeled output current exceeds a pin's declared limit", state_sensitive: true
+
+          def check(context) = emit(context, :gpio_overcurrent)
+        end
+
+        class SupplyOverload < BuiltinRule
+          rule "Electrical/SupplyOverload", severity: :error,
+            description: "A modeled load exceeds its supply current limit", state_sensitive: true
+
+          def check(context) = emit(context, :supply_overloads)
+        end
+
+        class I2CAddressConflict < BuiltinRule
+          rule "Electrical/I2CAddressConflict", severity: :error,
+            description: "I2C devices on one bus use the same address", state_sensitive: true
+
+          def check(context) = emit(context, :i2c_address_conflicts)
+        end
+
+        class I2CPullupMissing < BuiltinRule
+          rule "Electrical/I2CPullupMissing", severity: :info,
+            description: "An I2C bus has no modeled pull-up resistor", state_sensitive: true
+
+          def check(context) = emit(context, :i2c_pullup_missing)
+        end
+
+        class MissingDecouplingCapacitor < BuiltinRule
+          rule "Electrical/MissingDecouplingCapacitor", severity: :info,
+            description: "A powered IC has no modeled capacitor across its supply pins", state_sensitive: true
+
+          def check(context) = emit(context, :missing_decoupling_capacitors)
+        end
+
+        class MissingBaseResistor < BuiltinRule
+          rule "Electrical/MissingBaseResistor", severity: :info,
+            description: "A declared output drives a transistor base without a series resistor", state_sensitive: true
+
+          def check(context) = emit(context, :missing_base_resistors)
+        end
+
+        class MissingFlybackDiode < BuiltinRule
+          rule "Electrical/MissingFlybackDiode", severity: :warning,
+            description: "An explicitly inductive load has no reverse flyback diode", state_sensitive: true
+
+          def check(context) = emit(context, :missing_flyback_diodes)
+        end
+
       end
 
       module Intent
         class ConnectionMismatch < BuiltinRule
-          rule "Intent/ConnectionMismatch", severity: :error, description: "Wiring differs from declared expectations"
+          rule "Intent/ConnectionMismatch", severity: :error, description: "Wiring differs from declared expectations", state_sensitive: true
 
           def check(context) = emit(context, :expectations)
         end
 
         class UnknownNet < BuiltinRule
-          rule "Intent/UnknownNet", severity: :error, description: "An expectation refers to an unknown net"
+          rule "Intent/UnknownNet", severity: :error, description: "An expectation refers to an unknown net", state_sensitive: true
 
           def check(context)
             emit_diagnostics(context)
@@ -190,6 +387,12 @@ module Breadkit
           end
         end
 
+        class MeasurementUnavailable < BuiltinRule
+          rule "Intent/MeasurementUnavailable", severity: :warning, description: "A requested DC value cannot be calculated", state_sensitive: true
+
+          def check(context) = emit(context, :expectations)
+        end
+
       end
 
       module Style

data/lib/breadkit/lint/source_editor.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+require "prism"
+require "tempfile"
+require "did_you_mean"
+
+module Breadkit
+  module Lint
+    class SourceEditor
+      Edit = Struct.new(:start, :finish, :replacement, :description, :line, keyword_init: true)
+
+      def initialize(path, source: nil)
+        @path = path
+        @source = source || File.binread(path)
+        parsed = Prism.parse(@source)
+        @valid = parsed.errors.empty?
+        @calls = []
+        collect(parsed.value) if @valid
+        @calls_by_line = @calls.group_by { |call| call.location.start_line }
+      end
+
+      def annotate(offenses)
+        return unless @valid
+
+        offenses.each do |offense|
+          call = call_for(offense)
+          next unless call
+          node = offense.rule == "Layout/InvalidColor" && wire_color_node(call) || call
+          offense.column = node.location.start_character_column + 1
+          if node != call && node.location.start_line != offense.location.line
+            offense.location = Breadkit::SourceLocation.new(path: offense.location.path, line: node.location.start_line)
+          end
+        end
+      end
+
+      def plan(offenses)
+        return [] unless @valid
+
+        offenses.filter_map do |offense|
+          case offense.rule
+          when "Layout/InvalidColor" then color_edit(offense)
+          when "Lint/RedundantDisable" then disable_edit(offense)
+          end
+        end.uniq { |edit| [edit.start, edit.finish, edit.replacement] }.sort_by(&:start)
+      end
+
+      def apply(edits)
+        return false if edits.empty? || File.symlink?(@path)
+        raise Error, "source changed while fixing #{@path}" unless File.binread(@path) == @source
+
+        updated = @source.dup
+        edits.reverse_each { |edit| updated[edit.start...edit.finish] = edit.replacement }
+        mode = File.stat(@path).mode & 0o7777
+        Tempfile.create([".bklint-fix-", ".tmp"], File.dirname(@path)) do |temp|
+          temp.binmode
+          temp.chmod(mode)
+          temp.write(updated)
+          temp.flush
+          temp.fsync
+          temp.close
+          raise Error, "source changed while fixing #{@path}" unless File.binread(@path) == @source
+          File.rename(temp.path, @path)
+        end
+        true
+      end
+
+      private
+
+      def collect(node)
+        return unless node
+        @calls << node if node.is_a?(Prism::CallNode) && node.receiver.nil?
+        node.compact_child_nodes.each { |child| collect(child) }
+      end
+
+      def call_for(offense, name = nil)
+        location = offense.location
+        return unless location&.line && location.path && File.expand_path(location.path) == File.expand_path(@path)
+
+        calls = @calls_by_line[location.line] || @calls.select do |call|
+          call.location.start_line < location.line && location.line <= call.location.end_line
+        end
+        return unless calls.one?
+        return if name && calls.first.name != name
+
+        calls.first
+      end
+
+      def wire_color_node(call)
+        return unless call.name == :wire
+        hashes = Array(call.arguments&.arguments).grep(Prism::KeywordHashNode)
+        entries = hashes.flat_map(&:elements).grep(Prism::AssocNode).select do |entry|
+          entry.key.is_a?(Prism::SymbolNode) && entry.key.value == "color"
+        end
+        entries.first.value if entries.one?
+      end
+
+      def color_edit(offense)
+        return if Array(offense.targets[:wires]).empty?
+        call = call_for(offense, :wire)
+        return unless call
+        node = wire_color_node(call)
+        return unless node.is_a?(Prism::SymbolNode) || node.is_a?(Prism::StringNode)
+
+        color = node.is_a?(Prism::StringNode) ? node.unescaped : node.value
+        return unless color.match?(/\A[a-z]+\z/i) && !Breadkit::Color.valid?(color)
+        candidates = Breadkit::Color::NAMES.select { |name| DidYouMean::Levenshtein.distance(color.downcase, name) == 1 }
+        return unless candidates.one?
+
+        original = node.location.slice
+        corrected = if node.is_a?(Prism::SymbolNode) && original == ":#{color}"
+          ":#{candidates.first}"
+        elsif node.is_a?(Prism::StringNode) && original.match?(/\A(["'])[a-z]+\1\z/i)
+          "#{original[0]}#{candidates.first}#{original[0]}"
+        end
+        return unless corrected
+
+        Edit.new(start: node.location.start_offset, finish: node.location.end_offset, replacement: corrected,
+                 description: "replace wire color #{original} with #{corrected}", line: offense.location.line)
+      end
+
+      def disable_edit(offense)
+        call = call_for(offense, :lint_disable)
+        return unless call && call.location.start_line == call.location.end_line
+
+        line_start = @source.lines.take(call.location.start_line - 1).sum(&:bytesize)
+        newline = @source.index("\n", line_start)
+        line_end = newline ? newline + 1 : @source.bytesize
+        content_end = newline && @source.getbyte(newline - 1) == 13 ? newline - 1 : (newline || line_end)
+        before = @source.byteslice(line_start...call.location.start_offset)
+        after = @source.byteslice(call.location.end_offset...content_end)
+        return unless before.match?(/\A[ \t]*\z/) && after.match?(/\A[ \t]*\z/)
+
+        Edit.new(start: line_start, finish: line_end, replacement: "",
+                 description: "remove unused lint_disable", line: offense.location.line)
+      end
+    end
+  end
+end

data/lib/breadkit/lint/version.rb

@@ -2,6 +2,6 @@
 
 module Breadkit
   module Lint
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end