breadkit-lint 0.1.0 → 0.2.0

data/site/schemas/lint-v1.json

@@ -0,0 +1,71 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://breadkit.github.io/breadkit-lint/schemas/lint-v1.json",
+  "title": "Breadkit lint report v1",
+  "type": "object",
+  "required": ["schema_version", "tool", "files", "summary"],
+  "properties": {
+    "schema_version": {"const": 1},
+    "tool": {
+      "type": "object",
+      "required": ["name", "version"],
+      "properties": {"name": {"const": "bklint"}, "version": {"type": "string"}}
+    },
+    "files": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "required": ["path", "analysis_skipped", "offenses"],
+        "properties": {
+          "path": {"type": "string"},
+          "analysis_skipped": {"type": "boolean"},
+          "offenses": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "required": ["rule", "severity", "message", "location", "state", "targets"],
+              "properties": {
+                "rule": {"type": "string"},
+                "severity": {"enum": ["error", "warning", "info"]},
+                "message": {"type": "string"},
+                "docs_url": {"type": ["string", "null"], "format": "uri"},
+                "suggestion": {"type": ["string", "null"]},
+                "location": {
+                  "type": "object",
+                  "required": ["path", "line"],
+                  "properties": {
+                    "path": {"type": "string"},
+                    "line": {"type": ["integer", "null"], "minimum": 1},
+                    "column": {"type": "integer", "minimum": 1}
+                  }
+                },
+                "state": {"type": ["string", "null"]},
+                "targets": {
+                  "type": "object",
+                  "properties": {
+                    "components": {"$ref": "#/$defs/identifiers"},
+                    "pins": {"$ref": "#/$defs/identifiers"},
+                    "holes": {"$ref": "#/$defs/identifiers"},
+                    "wires": {"$ref": "#/$defs/identifiers"},
+                    "nets": {"$ref": "#/$defs/identifiers"}
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "summary": {
+      "type": "object",
+      "required": ["files", "errors", "warnings", "infos"],
+      "properties": {
+        "files": {"type": "integer", "minimum": 0},
+        "errors": {"type": "integer", "minimum": 0},
+        "warnings": {"type": "integer", "minimum": 0},
+        "infos": {"type": "integer", "minimum": 0}
+      }
+    }
+  },
+  "$defs": {"identifiers": {"type": "array", "items": {"type": "string"}}}
+}

data/site/styles.css

@@ -1,6 +1,7 @@
 @import "tailwindcss";
 
 @source "./**/*.html";
+@source "../_site/rules/**/*.html";
 
 @theme {
   --color-ink: #101719;
@@ -12,3 +13,15 @@
   --font-sans: "Avenir Next", Avenir, ui-sans-serif, system-ui, sans-serif;
   --font-mono: "SFMono-Regular", Consolas, "Liberation Mono", monospace;
 }
+
+.rule-doc { max-width: 72ch; line-height: 1.75; color: var(--color-muted); }
+.rule-doc h1 { margin-bottom: 1.5rem; color: var(--color-paper); font-size: clamp(1.875rem, 4vw, 2.75rem); font-weight: 600; line-height: 1.2; text-wrap: balance; }
+.rule-doc h2 { margin: 2.25rem 0 .75rem; color: var(--color-paper); font-size: 1.4rem; font-weight: 600; }
+.rule-doc p, .rule-doc ul, .rule-doc ol, .rule-doc pre { margin-top: 1rem; }
+.rule-doc ul, .rule-doc ol { padding-left: 1.5rem; }
+.rule-doc ul { list-style: disc; }
+.rule-doc ol { list-style: decimal; }
+.rule-doc a { color: var(--color-paper); text-decoration: underline; text-decoration-color: var(--color-copper); text-underline-offset: .25rem; }
+.rule-doc :not(pre) > code, .rule-summary code { color: var(--color-paper); font-family: var(--font-mono); }
+.rule-doc pre { overflow-x: auto; border: 1px solid var(--color-line); border-radius: .5rem; background: var(--color-board); padding: 1.25rem; color: var(--color-paper); font-family: var(--font-mono); font-size: .875rem; line-height: 1.6; }
+.rule-summary { display: -webkit-box; overflow: hidden; -webkit-box-orient: vertical; -webkit-line-clamp: 2; }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: breadkit-lint
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Yudai Takada
@@ -15,14 +15,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: prism
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
 description: bklint analyzes Breadkit circuits and reports layout, electrical, and
   intent offenses.
 email:
@@ -32,55 +46,101 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".yamllint"
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
 - SECURITY.md
+- action.yml
 - config/default.yml
+- docs/REFERENCE.md
+- docs/rules/Electrical/CapacitorVoltageRating.md
 - docs/rules/Electrical/DanglingWire.md
+- docs/rules/Electrical/FloatingInput.md
 - docs/rules/Electrical/FloatingPin.md
+- docs/rules/Electrical/GpioOvercurrent.md
+- docs/rules/Electrical/I2CAddressConflict.md
+- docs/rules/Electrical/I2CPullupMissing.md
+- docs/rules/Electrical/LedOvercurrent.md
+- docs/rules/Electrical/MinimumResistance.md
+- docs/rules/Electrical/MissingBaseResistor.md
+- docs/rules/Electrical/MissingDecouplingCapacitor.md
+- docs/rules/Electrical/MissingFlybackDiode.md
+- docs/rules/Electrical/MissingPullResistor.md
 - docs/rules/Electrical/MissingSeriesResistor.md
 - docs/rules/Electrical/NetLabelConflict.md
 - docs/rules/Electrical/NoCommonGround.md
 - docs/rules/Electrical/PowerPinUnconnected.md
+- docs/rules/Electrical/RailPolarityMismatch.md
+- docs/rules/Electrical/ResistorPowerRating.md
 - docs/rules/Electrical/ReversePolarity.md
 - docs/rules/Electrical/ShortCircuit.md
 - docs/rules/Electrical/ShortedComponent.md
 - docs/rules/Electrical/SplitRail.md
+- docs/rules/Electrical/SupplyOverload.md
 - docs/rules/Electrical/SupplyVoltageRange.md
+- docs/rules/Electrical/VoltageDomainMismatch.md
 - docs/rules/Intent/ConnectionMismatch.md
+- docs/rules/Intent/MeasurementUnavailable.md
 - docs/rules/Intent/UnknownNet.md
+- docs/rules/Layout/AmbiguousSupplySource.md
+- docs/rules/Layout/BodyOverlap.md
 - docs/rules/Layout/DuplicateRef.md
 - docs/rules/Layout/HoleConflict.md
+- docs/rules/Layout/HoleCovered.md
+- docs/rules/Layout/InvalidColor.md
 - docs/rules/Layout/InvalidHole.md
+- docs/rules/Layout/InvalidOption.md
 - docs/rules/Layout/InvalidPlacement.md
+- docs/rules/Layout/InvalidRoute.md
+- docs/rules/Layout/InvalidValue.md
+- docs/rules/Layout/InvalidWireId.md
+- docs/rules/Layout/LeadSpan.md
 - docs/rules/Layout/NoFreeHole.md
+- docs/rules/Layout/PartOverride.md
 - docs/rules/Layout/PinsInSameStrip.md
 - docs/rules/Layout/SplitNetLabel.md
 - docs/rules/Layout/UnknownBoard.md
 - docs/rules/Layout/UnknownOption.md
 - docs/rules/Layout/UnknownPart.md
 - docs/rules/Layout/UnknownPin.md
+- docs/rules/Layout/UnknownSupplySource.md
 - docs/rules/Layout/UnknownTransistorModel.md
+- docs/rules/Layout/UnmatchedParts.md
 - docs/rules/Layout/UnplacedPin.md
+- docs/rules/Layout/WireOverIC.md
+- docs/rules/Lint/RedundantDisable.md
+- docs/rules/Lint/UnknownRuleInDisable.md
 - docs/rules/Style/WireColor.md
 - exe/bklint
 - lib/breadkit/lint.rb
+- lib/breadkit/lint/baseline.rb
+- lib/breadkit/lint/rake_task.rb
 - lib/breadkit/lint/rules.rb
 - lib/breadkit/lint/rules/electrical.rb
 - lib/breadkit/lint/rules/intent.rb
 - lib/breadkit/lint/rules/layout.rb
 - lib/breadkit/lint/rules/style.rb
 - lib/breadkit/lint/rules/support.rb
+- lib/breadkit/lint/source_editor.rb
 - lib/breadkit/lint/version.rb
+- lib/guard/breadkit.rb
+- lib/guard/breadkit/templates/Guardfile
 - locales/en.yml
 - locales/ja.yml
+- locales/ko.yml
+- locales/zh.yml
 - package-lock.json
 - package.json
+- scripts/action-run.sh
+- scripts/build-rule-pages.mjs
+- scripts/check-rule-pages.mjs
 - scripts/check_bad_examples.rb
+- scripts/pre-commit
 - sig/breadkit/lint.rbs
 - site/favicon.svg
 - site/index.html
+- site/schemas/lint-v1.json
 - site/styles.css
 homepage: https://github.com/breadkit/breadkit-lint
 licenses:
@@ -105,7 +165,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.16
+rubygems_version: 4.0.20
 specification_version: 4
 summary: Check breadboard wiring designs for common layout and circuit errors.
 test_files: []