makit 0.0.158 → 0.0.162

data/lib/makit/lint.rb

@@ -1,212 +1,212 @@
-# frozen_string_literal: true
-
-require "json"
-require "yaml"
-
-# This module provides classes for the Makit gem.
-module Makit
-  # Lint utilities for validating JSON and YAML files
-  #
-  # This class provides methods for linting JSON and YAML files,
-  # helping to catch syntax errors and validation issues early.
-  class Lint
-    # Default directories to exclude from linting
-    DEFAULT_EXCLUDE_PATTERNS = [
-      "artifacts/",
-      "bin/",
-      "obj/",
-      ".nuget/",
-      ".git/",
-      ".specify/"
-    ].freeze
-
-    # Lint JSON files based on a glob pattern or filename
-    #
-    # @param pattern [String] Glob pattern (e.g., "**/*.json") or specific filename
-    # @param exclude_patterns [Array<String>] Optional array of path prefixes to exclude
-    # @return [Hash] Hash with :valid (boolean), :errors (array), :file_count (integer)
-    def self.lint_json(pattern, exclude_patterns: DEFAULT_EXCLUDE_PATTERNS)
-      # Determine if pattern is a glob or specific file
-      if File.file?(pattern)
-        json_files = [pattern]
-      else
-        json_files = Dir.glob(pattern)
-          .reject { |f| exclude_patterns.any? { |exclude| f.start_with?(exclude) } }
-          .select { |f| File.file?(f) }
-      end
-
-      if json_files.empty?
-        return {
-          valid: true,
-          errors: [],
-          file_count: 0,
-          message: "No JSON files found to validate"
-        }
-      end
-
-      errors = []
-      json_files.each do |file|
-        begin
-          content = File.read(file)
-          # Remove BOM if present (UTF-8 BOM: EF BB BF)
-          content = content.force_encoding("UTF-8").sub(/\A\xEF\xBB\xBF/, "")
-          JSON.parse(content)
-        rescue JSON::ParserError => e
-          errors << { file: file, error: e.message }
-        end
-      end
-
-      {
-        valid: errors.empty?,
-        errors: errors,
-        file_count: json_files.length
-      }
-    end
-
-    # Lint JSON files and print results
-    #
-    # @param pattern [String] Glob pattern or filename
-    # @param exclude_patterns [Array<String>] Optional array of path prefixes to exclude
-    # @param verbose [Boolean] Whether to print progress dots
-    # @raise [RuntimeError] If validation fails
-    def self.lint_json!(pattern, exclude_patterns: DEFAULT_EXCLUDE_PATTERNS, verbose: true)
-      result = lint_json(pattern, exclude_patterns: exclude_patterns)
-
-      if result[:file_count] == 0
-        puts result[:message] if verbose
-        return result
-      end
-
-      if verbose
-        puts "Validating #{result[:file_count]} JSON file(s)..."
-      end
-
-      # Re-run to show progress dots
-      if verbose && result[:file_count] > 0
-        json_files = File.file?(pattern) ? [pattern] : Dir.glob(pattern)
-          .reject { |f| exclude_patterns.any? { |exclude| f.start_with?(exclude) } }
-          .select { |f| File.file?(f) }
-
-        json_files.each do |file|
-          begin
-            content = File.read(file)
-            content = content.force_encoding("UTF-8").sub(/\A\xEF\xBB\xBF/, "")
-            JSON.parse(content)
-            print "."
-          rescue JSON::ParserError
-            print "F"
-          end
-        end
-        puts "\n"
-      end
-
-      if result[:valid]
-        puts "✓ All JSON files are valid" if verbose
-      else
-        puts "\n✗ Found #{result[:errors].length} invalid JSON file(s):" if verbose
-        result[:errors].each do |err|
-          puts "  - #{err[:file]}: #{err[:error]}" if verbose
-        end
-        raise "JSON validation failed"
-      end
-
-      result
-    end
-
-    # Lint YAML files based on a glob pattern or filename
-    #
-    # @param pattern [String] Glob pattern (e.g., "**/*.yml") or specific filename
-    # @param exclude_patterns [Array<String>] Optional array of path prefixes to exclude
-    # @return [Hash] Hash with :valid (boolean), :errors (array), :file_count (integer)
-    def self.lint_yaml(pattern, exclude_patterns: DEFAULT_EXCLUDE_PATTERNS)
-      # Determine if pattern is a glob or specific file
-      if File.file?(pattern)
-        yaml_files = [pattern]
-      else
-        yaml_files = Dir.glob(pattern)
-          .reject { |f| exclude_patterns.any? { |exclude| f.start_with?(exclude) } }
-          .select { |f| File.file?(f) }
-      end
-
-      if yaml_files.empty?
-        return {
-          valid: true,
-          errors: [],
-          file_count: 0,
-          message: "No YAML files found to validate"
-        }
-      end
-
-      errors = []
-      yaml_files.each do |file|
-        begin
-          content = File.read(file)
-          # Remove BOM if present (UTF-8 BOM: EF BB BF)
-          content = content.force_encoding("UTF-8").sub(/\A\xEF\xBB\xBF/, "")
-          YAML.load(content, permitted_classes: [Symbol, Date, Time], aliases: true)
-        rescue Psych::SyntaxError => e
-          errors << { file: file, error: e.message }
-        rescue => e
-          errors << { file: file, error: e.message }
-        end
-      end
-
-      {
-        valid: errors.empty?,
-        errors: errors,
-        file_count: yaml_files.length
-      }
-    end
-
-    # Lint YAML files and print results
-    #
-    # @param pattern [String] Glob pattern or filename
-    # @param exclude_patterns [Array<String>] Optional array of path prefixes to exclude
-    # @param verbose [Boolean] Whether to print progress dots
-    # @raise [RuntimeError] If validation fails
-    def self.lint_yaml!(pattern, exclude_patterns: DEFAULT_EXCLUDE_PATTERNS, verbose: true)
-      result = lint_yaml(pattern, exclude_patterns: exclude_patterns)
-
-      if result[:file_count] == 0
-        puts result[:message] if verbose
-        return result
-      end
-
-      if verbose
-        puts "Validating #{result[:file_count]} YAML file(s)..."
-      end
-
-      # Re-run to show progress dots
-      if verbose && result[:file_count] > 0
-        yaml_files = File.file?(pattern) ? [pattern] : Dir.glob(pattern)
-          .reject { |f| exclude_patterns.any? { |exclude| f.start_with?(exclude) } }
-          .select { |f| File.file?(f) }
-
-        yaml_files.each do |file|
-          begin
-            content = File.read(file)
-            content = content.force_encoding("UTF-8").sub(/\A\xEF\xBB\xBF/, "")
-            YAML.load(content, permitted_classes: [Symbol, Date, Time], aliases: true)
-            print "."
-          rescue
-            print "F"
-          end
-        end
-        puts "\n"
-      end
-
-      if result[:valid]
-        puts "✓ All YAML files are valid" if verbose
-      else
-        puts "\n✗ Found #{result[:errors].length} invalid YAML file(s):" if verbose
-        result[:errors].each do |err|
-          puts "  - #{err[:file]}: #{err[:error]}" if verbose
-        end
-        raise "YAML validation failed"
-      end
-
-      result
-    end
-  end
-end
-
+# frozen_string_literal: true
+
+require "json"
+require "yaml"
+
+# This module provides classes for the Makit gem.
+module Makit
+  # Lint utilities for validating JSON and YAML files
+  #
+  # This class provides methods for linting JSON and YAML files,
+  # helping to catch syntax errors and validation issues early.
+  class Lint
+    # Default directories to exclude from linting
+    DEFAULT_EXCLUDE_PATTERNS = [
+      "artifacts/",
+      "bin/",
+      "obj/",
+      ".nuget/",
+      ".git/",
+      ".specify/"
+    ].freeze
+
+    # Lint JSON files based on a glob pattern or filename
+    #
+    # @param pattern [String] Glob pattern (e.g., "**/*.json") or specific filename
+    # @param exclude_patterns [Array<String>] Optional array of path prefixes to exclude
+    # @return [Hash] Hash with :valid (boolean), :errors (array), :file_count (integer)
+    def self.lint_json(pattern, exclude_patterns: DEFAULT_EXCLUDE_PATTERNS)
+      # Determine if pattern is a glob or specific file
+      if File.file?(pattern)
+        json_files = [pattern]
+      else
+        json_files = Dir.glob(pattern)
+          .reject { |f| exclude_patterns.any? { |exclude| f.start_with?(exclude) } }
+          .select { |f| File.file?(f) }
+      end
+
+      if json_files.empty?
+        return {
+          valid: true,
+          errors: [],
+          file_count: 0,
+          message: "No JSON files found to validate"
+        }
+      end
+
+      errors = []
+      json_files.each do |file|
+        begin
+          content = File.read(file)
+          # Remove BOM if present (UTF-8 BOM: EF BB BF)
+          content = content.force_encoding("UTF-8").sub(/\A\xEF\xBB\xBF/, "")
+          JSON.parse(content)
+        rescue JSON::ParserError => e
+          errors << { file: file, error: e.message }
+        end
+      end
+
+      {
+        valid: errors.empty?,
+        errors: errors,
+        file_count: json_files.length
+      }
+    end
+
+    # Lint JSON files and print results
+    #
+    # @param pattern [String] Glob pattern or filename
+    # @param exclude_patterns [Array<String>] Optional array of path prefixes to exclude
+    # @param verbose [Boolean] Whether to print progress dots
+    # @raise [RuntimeError] If validation fails
+    def self.lint_json!(pattern, exclude_patterns: DEFAULT_EXCLUDE_PATTERNS, verbose: true)
+      result = lint_json(pattern, exclude_patterns: exclude_patterns)
+
+      if result[:file_count] == 0
+        puts result[:message] if verbose
+        return result
+      end
+
+      if verbose
+        puts "Validating #{result[:file_count]} JSON file(s)..."
+      end
+
+      # Re-run to show progress dots
+      if verbose && result[:file_count] > 0
+        json_files = File.file?(pattern) ? [pattern] : Dir.glob(pattern)
+          .reject { |f| exclude_patterns.any? { |exclude| f.start_with?(exclude) } }
+          .select { |f| File.file?(f) }
+
+        json_files.each do |file|
+          begin
+            content = File.read(file)
+            content = content.force_encoding("UTF-8").sub(/\A\xEF\xBB\xBF/, "")
+            JSON.parse(content)
+            print "."
+          rescue JSON::ParserError
+            print "F"
+          end
+        end
+        puts "\n"
+      end
+
+      if result[:valid]
+        puts "✓ All JSON files are valid" if verbose
+      else
+        puts "\n✗ Found #{result[:errors].length} invalid JSON file(s):" if verbose
+        result[:errors].each do |err|
+          puts "  - #{err[:file]}: #{err[:error]}" if verbose
+        end
+        raise "JSON validation failed"
+      end
+
+      result
+    end
+
+    # Lint YAML files based on a glob pattern or filename
+    #
+    # @param pattern [String] Glob pattern (e.g., "**/*.yml") or specific filename
+    # @param exclude_patterns [Array<String>] Optional array of path prefixes to exclude
+    # @return [Hash] Hash with :valid (boolean), :errors (array), :file_count (integer)
+    def self.lint_yaml(pattern, exclude_patterns: DEFAULT_EXCLUDE_PATTERNS)
+      # Determine if pattern is a glob or specific file
+      if File.file?(pattern)
+        yaml_files = [pattern]
+      else
+        yaml_files = Dir.glob(pattern)
+          .reject { |f| exclude_patterns.any? { |exclude| f.start_with?(exclude) } }
+          .select { |f| File.file?(f) }
+      end
+
+      if yaml_files.empty?
+        return {
+          valid: true,
+          errors: [],
+          file_count: 0,
+          message: "No YAML files found to validate"
+        }
+      end
+
+      errors = []
+      yaml_files.each do |file|
+        begin
+          content = File.read(file)
+          # Remove BOM if present (UTF-8 BOM: EF BB BF)
+          content = content.force_encoding("UTF-8").sub(/\A\xEF\xBB\xBF/, "")
+          YAML.load(content, permitted_classes: [Symbol, Date, Time], aliases: true)
+        rescue Psych::SyntaxError => e
+          errors << { file: file, error: e.message }
+        rescue => e
+          errors << { file: file, error: e.message }
+        end
+      end
+
+      {
+        valid: errors.empty?,
+        errors: errors,
+        file_count: yaml_files.length
+      }
+    end
+
+    # Lint YAML files and print results
+    #
+    # @param pattern [String] Glob pattern or filename
+    # @param exclude_patterns [Array<String>] Optional array of path prefixes to exclude
+    # @param verbose [Boolean] Whether to print progress dots
+    # @raise [RuntimeError] If validation fails
+    def self.lint_yaml!(pattern, exclude_patterns: DEFAULT_EXCLUDE_PATTERNS, verbose: true)
+      result = lint_yaml(pattern, exclude_patterns: exclude_patterns)
+
+      if result[:file_count] == 0
+        puts result[:message] if verbose
+        return result
+      end
+
+      if verbose
+        puts "Validating #{result[:file_count]} YAML file(s)..."
+      end
+
+      # Re-run to show progress dots
+      if verbose && result[:file_count] > 0
+        yaml_files = File.file?(pattern) ? [pattern] : Dir.glob(pattern)
+          .reject { |f| exclude_patterns.any? { |exclude| f.start_with?(exclude) } }
+          .select { |f| File.file?(f) }
+
+        yaml_files.each do |file|
+          begin
+            content = File.read(file)
+            content = content.force_encoding("UTF-8").sub(/\A\xEF\xBB\xBF/, "")
+            YAML.load(content, permitted_classes: [Symbol, Date, Time], aliases: true)
+            print "."
+          rescue
+            print "F"
+          end
+        end
+        puts "\n"
+      end
+
+      if result[:valid]
+        puts "✓ All YAML files are valid" if verbose
+      else
+        puts "\n✗ Found #{result[:errors].length} invalid YAML file(s):" if verbose
+        result[:errors].each do |err|
+          puts "  - #{err[:file]}: #{err[:error]}" if verbose
+        end
+        raise "YAML validation failed"
+      end
+
+      result
+    end
+  end
+end
+