lex-detect 0.1.7 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0a985e71fac2b9cbee47bb0f1eef3d7eb744dbbea99b573f0d90dba9ca7bc89
-  data.tar.gz: dca63d849d77bb5aa83da69ce23146a8294666c594bb155b6f3d964d7416dccc
+  metadata.gz: 8e8430d894d1792494f0781c7f13c28de7da13817c40fa3a9f80cfc4c89bc9ad
+  data.tar.gz: 2bff9f69460165c22a025dc97912639202cca9200366e91dafbc84dc9d37bb8f
 SHA512:
-  metadata.gz: c8718ab255658b92ce9579815b01032afc68ded3cece3d6c13eaaaa714143203303023541ffb4b24f3d275a69004f7c043492f030b775c78b371d1edce3c76ba
-  data.tar.gz: 2695aff906451268b4733463190117c099f8c2fbb6be063003fd9ff3216db0494d0d3e265d9b8c5ebdd538b817132975dff186b37bc75f0838578b49d60e2b72
+  metadata.gz: b087321a87beeff9cd42417286a39477edd5608ca8190bc67877b6e55b57f6bd4f971c05b802eadf47b68967acbb40c0e74b96c25a1d970d1431adffc3f43d2a
+  data.tar.gz: 6f9c61761fad7069ad09110f21d23227a664a606fcc5b50737d0d05c462ce9240b60e6f91a7d3b1684845b76c92f1500e2951a512725c33880eafacbc8ac3274

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## [0.2.1] - 2026-03-22
+
+### Added
+- `Formatters::Json` passthrough formatter returning detections unchanged (or as pretty-printed JSON via `.to_json`)
+- `Formatters` module entry point with `Formatters.format(detections, format:)` dispatcher for `:sarif`, `:markdown`, and `:json`
+- `format_results` now delegates to `Formatters.format` instead of dispatching inline
+- 5 new specs for `Formatters::Json` covering passthrough identity, field preservation, JSON serialization, and empty input
+
+## [0.2.0] - 2026-03-22
+
+### Added
+- SARIF 2.1.0 formatter (`Formatters::Sarif`) for GitHub Code Scanning integration
+- Markdown PR comment formatter (`Formatters::MarkdownPr`) for GitHub PR annotations
+- `format_results(format:, detections:)` public API method supporting `:sarif`, `:markdown`, and `:json` output formats
+
 ## [0.1.7] - 2026-03-22
 
 ### Fixed

data/CLAUDE.md

@@ -10,7 +10,7 @@ Legion Extension that scans the local environment and recommends which `lex-*` e
 
 **GitHub**: https://github.com/LegionIO/lex-detect
 **License**: MIT
-**Version**: 0.1.4
+**Version**: 0.2.0
 
 ## Architecture
 
@@ -57,7 +57,7 @@ Legion::Extensions::Detect.catalog          # raw CATALOG constant
 
 ## Testing
 
-40 specs across 6 spec files.
+54 specs across 9 spec files.
 
 ```bash
 bundle install

data/lib/legion/extensions/detect/formatters/json.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Legion
+  module Extensions
+    module Detect
+      module Formatters
+        module Json
+          module_function
+
+          def format(detections)
+            detections
+          end
+
+          def to_json(detections)
+            ::JSON.pretty_generate(format(detections))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/legion/extensions/detect/formatters/markdown_pr.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Legion
+  module Extensions
+    module Detect
+      module Formatters
+        module MarkdownPr
+          module_function
+
+          def format(detections)
+            missing   = collect_missing(detections)
+            installed = collect_installed(detections)
+
+            lines = ["## Legion Detect Findings\n"]
+
+            if missing.any?
+              lines << "### Missing Extensions (#{missing.size})\n"
+              missing.each do |m|
+                lines << "- **#{m[:name]}**: `#{m[:extension]}` not installed"
+                lines << "  Detected by: #{m[:signals].join(', ')}"
+                lines << "  Install: `gem install #{m[:extension]}`\n"
+              end
+            end
+
+            if installed.any?
+              lines << "### Installed (#{installed.size})\n"
+              installed.each do |i|
+                lines << "- #{i[:name]}: `#{i[:extension]}` :white_check_mark:"
+              end
+            end
+
+            lines << "No extensions detected.\n" if missing.empty? && installed.empty?
+
+            lines << "\n---\n*Generated by legion-detect v#{VERSION}*"
+            lines.join("\n")
+          end
+
+          def collect_missing(detections)
+            detections.flat_map do |d|
+              d[:extensions].filter_map do |ext|
+                next if d[:installed][ext]
+
+                { name: d[:name], extension: ext, signals: d[:matched_signals] }
+              end
+            end
+          end
+
+          def collect_installed(detections)
+            detections.flat_map do |d|
+              d[:extensions].filter_map do |ext|
+                next unless d[:installed][ext]
+
+                { name: d[:name], extension: ext }
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/legion/extensions/detect/formatters/sarif.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Legion
+  module Extensions
+    module Detect
+      module Formatters
+        module Sarif
+          SCHEMA = 'https://json.schemastore.org/sarif-2.1.0.json'
+          SARIF_VERSION = '2.1.0'
+
+          SEVERITY_MAP = {
+            missing:   'warning',
+            installed: 'note'
+          }.freeze
+
+          module_function
+
+          def format(detections)
+            rules   = build_rules(detections)
+            results = build_results(detections)
+
+            {
+              '$schema' => SCHEMA,
+              'version' => SARIF_VERSION,
+              'runs'    => [{
+                'tool'    => {
+                  'driver' => {
+                    'name'           => 'legion-detect',
+                    'version'        => VERSION,
+                    'informationUri' => 'https://github.com/LegionIO/lex-detect',
+                    'rules'          => rules
+                  }
+                },
+                'results' => results
+              }]
+            }
+          end
+
+          def to_json(detections)
+            ::JSON.pretty_generate(format(detections))
+          end
+
+          def build_rules(detections)
+            rules = detections.flat_map do |detection|
+              detection[:extensions].map do |ext|
+                {
+                  'id'                   => "detect/#{ext}",
+                  'name'                 => detection[:name],
+                  'shortDescription'     => { 'text' => "#{detection[:name]} detected — #{ext} recommended" },
+                  'defaultConfiguration' => { 'level' => 'warning' }
+                }
+              end
+            end
+            rules.uniq { |r| r['id'] }
+          end
+
+          def build_results(detections)
+            detections.flat_map do |detection|
+              detection[:extensions].filter_map do |ext|
+                next if detection[:installed][ext]
+
+                {
+                  'ruleId'     => "detect/#{ext}",
+                  'level'      => 'warning',
+                  'message'    => {
+                    'text' => "#{detection[:name]} detected (#{detection[:matched_signals].join(', ')}) but #{ext} is not installed"
+                  },
+                  'properties' => {
+                    'matched_signals' => detection[:matched_signals],
+                    'detection_name'  => detection[:name]
+                  }
+                }
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/legion/extensions/detect/formatters.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'legion/extensions/detect/formatters/json'
+require 'legion/extensions/detect/formatters/sarif'
+require 'legion/extensions/detect/formatters/markdown_pr'
+
+module Legion
+  module Extensions
+    module Detect
+      module Formatters
+        module_function
+
+        def format(detections, format: :json)
+          case format.to_sym
+          when :sarif    then Sarif.to_json(detections)
+          when :markdown then MarkdownPr.format(detections)
+          else Json.format(detections)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/legion/extensions/detect/version.rb

@@ -3,7 +3,7 @@
 module Legion
   module Extensions
     module Detect
-      VERSION = '0.1.7'
+      VERSION = '0.2.1'
     end
   end
 end

data/lib/legion/extensions/detect.rb

@@ -4,6 +4,7 @@ require 'legion/extensions/detect/version'
 require 'legion/extensions/detect/catalog'
 require 'legion/extensions/detect/scanner'
 require 'legion/extensions/detect/installer'
+require 'legion/extensions/detect/formatters'
 require_relative 'detect/runners/task_observer'
 require_relative 'detect/runners/cancel_task'
 
@@ -41,6 +42,11 @@ module Legion
         def catalog
           CATALOG
         end
+
+        def format_results(format: :json, detections: nil)
+          results = detections || scan
+          Formatters.format(results, format: format)
+        end
       end
 
       require_relative 'detect/actors/full_scan' if defined?(Legion::Extensions::Actors::Once)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lex-detect
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.2.1
 platform: ruby
 authors:
 - Esity
@@ -31,6 +31,10 @@ files:
 - lib/legion/extensions/detect/actors/full_scan.rb
 - lib/legion/extensions/detect/actors/observer_tick.rb
 - lib/legion/extensions/detect/catalog.rb
+- lib/legion/extensions/detect/formatters.rb
+- lib/legion/extensions/detect/formatters/json.rb
+- lib/legion/extensions/detect/formatters/markdown_pr.rb
+- lib/legion/extensions/detect/formatters/sarif.rb
 - lib/legion/extensions/detect/installer.rb
 - lib/legion/extensions/detect/local_migrations/20260319000001_create_detect_results.rb
 - lib/legion/extensions/detect/local_migrations/20260320000001_create_observer_events.rb