erb_lint 0.0.35 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1bec7519ea346d89eb70e485c59015ea8faae7f4c85f4e3b450a4f8853eaa9b5
-  data.tar.gz: dba705708221bc3b5a71c57d6d9cbf1db2f7c8afbfaa7ed45fc63e71433383b5
+  metadata.gz: b98507494f8af2a33e0e6fcbf28c48a2d91c78f42273a3cc6c1206578f3a55b0
+  data.tar.gz: c090a633a9d041a6d4d71bc292b1525b3a74dccd61311e0224bc1cbb0d8fea33
 SHA512:
-  metadata.gz: 770cd1f544b749a7210949b1221ec4401349cb30bf9a171c1b7677c3d051f9887e264d62e1c8b86c5b09c593bc96b24b867a35b2bf11f4dfe2d8a17f54332d5c
-  data.tar.gz: ae1f2c592fba2fce5a70eb0620024c49cdca3173388791036bb9e2ed56b3b0cbdf3e6361c0b68c94fc222640aba5422c6fd5c15d8691fa019d0a9cfc038e96a3
+  metadata.gz: b2ac77d88b7be36010d69c072e3ee72c370edefa1fc3b68135593b5b494da8b0f9eac79e9b5408d10155a007d94948ae6a4b3b279de2541be66f0576abc964a8
+  data.tar.gz: f0be6a75c5060b49a8b7c5e5a5d19adb3222fb580a11c2e2e488e5b83ada00db0c4daee25e99ba5538057c749f5937b80d25a96bda1ed967e6d1baeddf787965

data/exe/erblint

@@ -3,7 +3,7 @@
 
 $LOAD_PATH.unshift("#{__dir__}/../lib")
 
-require 'erb_lint/cli'
+require "erb_lint/cli"
 
 cli = ERBLint::CLI.new
 exit(cli.run)

data/lib/erb_lint.rb

@@ -1,19 +1,3 @@
 # frozen_string_literal: true
 
-require 'rubocop'
-
-require 'erb_lint/corrector'
-require 'erb_lint/file_loader'
-require 'erb_lint/linter_config'
-require 'erb_lint/linter_registry'
-require 'erb_lint/linter'
-require 'erb_lint/offense'
-require 'erb_lint/processed_source'
-require 'erb_lint/runner_config'
-require 'erb_lint/runner'
-require 'erb_lint/version'
-
-# Load linters
-Dir[File.expand_path('erb_lint/linters/**/*.rb', File.dirname(__FILE__))].each do |file|
-  require file
-end
+require "erb_lint/version"

data/lib/erb_lint/all.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "rubocop"
+
+require "erb_lint"
+require "erb_lint/corrector"
+require "erb_lint/file_loader"
+require "erb_lint/linter_config"
+require "erb_lint/linter_registry"
+require "erb_lint/linter"
+require "erb_lint/offense"
+require "erb_lint/processed_source"
+require "erb_lint/runner_config"
+require "erb_lint/runner"
+require "erb_lint/stats"
+require "erb_lint/reporter"
+
+# Load linters
+Dir[File.expand_path("linters/**/*.rb", __dir__)].each do |file|
+  require file
+end
+
+# Load reporters
+Dir[File.expand_path("reporters/**/*.rb", __dir__)].each do |file|
+  require file
+end

data/lib/erb_lint/cli.rb

@@ -1,29 +1,24 @@
 # frozen_string_literal: true
 
-require 'erb_lint'
-require 'active_support'
-require 'active_support/inflector'
-require 'optparse'
-require 'psych'
-require 'yaml'
-require 'rainbow'
+require "erb_lint/all"
+require "active_support"
+require "active_support/inflector"
+require "optparse"
+require "psych"
+require "yaml"
+require "rainbow"
+require "erb_lint/utils/severity_levels"
 
 module ERBLint
   class CLI
-    DEFAULT_CONFIG_FILENAME = '.erb-lint.yml'
+    include Utils::SeverityLevels
+
+    DEFAULT_CONFIG_FILENAME = ".erb-lint.yml"
     DEFAULT_LINT_ALL_GLOB = "**/*.html{+*,}.erb"
 
     class ExitWithFailure < RuntimeError; end
-    class ExitWithSuccess < RuntimeError; end
 
-    class Stats
-      attr_accessor :found, :corrected, :exceptions
-      def initialize
-        @found = 0
-        @corrected = 0
-        @exceptions = 0
-      end
-    end
+    class ExitWithSuccess < RuntimeError; end
 
     def initialize
       @options = {}
@@ -35,7 +30,7 @@ module ERBLint
     def run(args = ARGV)
       dupped_args = args.dup
       load_options(dupped_args)
-      @files = dupped_args
+      @files = @options[:stdin] || dupped_args
 
       load_config
 
@@ -48,22 +43,27 @@ module ERBLint
       ensure_files_exist(lint_files)
 
       if enabled_linter_classes.empty?
-        failure!('no linter available with current configuration')
+        failure!("no linter available with current configuration")
       end
 
-      puts "Linting #{lint_files.size} files with "\
-        "#{enabled_linter_classes.size} #{'autocorrectable ' if autocorrect?}linters..."
-      puts
+      @options[:format] ||= :multiline
+      @options[:fail_level] ||= severity_level_for_name(:refactor)
+      @stats.files = lint_files.size
+      @stats.linters = enabled_linter_classes.size
+
+      reporter = Reporter.create_reporter(@options[:format], @stats, autocorrect?)
+      reporter.preview
 
       runner = ERBLint::Runner.new(file_loader, @config)
+      file_content = nil
 
       lint_files.each do |filename|
         runner.clear_offenses
         begin
-          run_with_corrections(runner, filename)
+          file_content = run_with_corrections(runner, filename)
         rescue => e
           @stats.exceptions += 1
-          puts "Exception occured when processing: #{relative_filename(filename)}"
+          puts "Exception occurred when processing: #{relative_filename(filename)}"
           puts "If this file cannot be processed by erb-lint, "\
             "you can exclude it in your configuration file."
           puts e.message
@@ -72,19 +72,12 @@ module ERBLint
         end
       end
 
-      if @stats.corrected > 0
-        corrected_found_diff = @stats.found - @stats.corrected
-        if corrected_found_diff > 0
-          warn(Rainbow(
-            "#{@stats.corrected} error(s) corrected and #{corrected_found_diff} error(s) remaining in ERB files"
-          ).red)
-        else
-          puts Rainbow("#{@stats.corrected} error(s) corrected in ERB files").green
-        end
-      elsif @stats.found > 0
-        warn(Rainbow("#{@stats.found} error(s) were found in ERB files").red)
-      else
-        puts Rainbow("No errors were found in ERB files").green
+      reporter.show
+
+      if stdin? && autocorrect?
+        # When running from stdin, we only lint a single file
+        puts "================ #{lint_files.first} ==================\n"
+        puts file_content
       end
 
       @stats.found == 0 && @stats.exceptions == 0
@@ -106,7 +99,7 @@ module ERBLint
     end
 
     def run_with_corrections(runner, filename)
-      file_content = File.read(filename, encoding: Encoding::UTF_8)
+      file_content = read_content(filename)
 
       7.times do
         processed_source = ERBLint::ProcessedSource.new(filename, file_content)
@@ -119,27 +112,40 @@ module ERBLint
 
         @stats.corrected += corrector.corrections.size
 
-        File.open(filename, "wb") do |file|
-          file.write(corrector.corrected_content)
+        # Don't overwrite the file if the input comes from stdin
+        unless stdin?
+          File.open(filename, "wb") do |file|
+            file.write(corrector.corrected_content)
+          end
         end
 
         file_content = corrector.corrected_content
         runner.clear_offenses
       end
+      offenses_filename = relative_filename(filename)
+      offenses = runner.offenses || []
 
-      @stats.found += runner.offenses.size
-      runner.offenses.each do |offense|
-        puts <<~EOF
-          #{offense.message}#{Rainbow(' (not autocorrected)').red if autocorrect?}
-          In file: #{relative_filename(filename)}:#{offense.line_range.begin}
+      @stats.ignored, @stats.found = offenses.partition do |offense|
+        severity_level_for_name(offense.severity) < @options[:fail_level]
+      end.map(&:size)
+        .zip([@stats.ignored, @stats.found])
+        .map(&:sum)
 
-        EOF
-      end
+      @stats.processed_files[offenses_filename] ||= []
+      @stats.processed_files[offenses_filename] |= offenses
+
+      file_content
+    end
+
+    def read_content(filename)
+      return File.read(filename, encoding: Encoding::UTF_8) unless stdin?
+
+      $stdin.binmode.read.force_encoding(Encoding::UTF_8)
     end
 
     def correct(processed_source, offenses)
       corrector = ERBLint::Corrector.new(processed_source, offenses)
-      failure!(corrector.diagnostics.join(', ')) if corrector.diagnostics.any?
+      failure!(corrector.diagnostics.join(", ")) if corrector.diagnostics.any?
       corrector
     end
 
@@ -177,7 +183,7 @@ module ERBLint
         else
           @files
             .map { |f| Dir.exist?(f) ? Dir[File.join(f, glob)] : f }
-            .map { |f| f.include?('*') ? Dir[f] : f }
+            .map { |f| f.include?("*") ? Dir[f] : f }
             .flatten
             .map { |f| File.expand_path(f, Dir.pwd) }
             .select { |filename| !excluded?(filename) }
@@ -190,7 +196,8 @@ module ERBLint
 
     def excluded?(filename)
       @config.global_exclude.any? do |path|
-        File.fnmatch?(path, filename)
+        expanded_path = File.expand_path(path, Dir.pwd)
+        File.fnmatch?(expanded_path, filename)
       end
     end
 
@@ -233,14 +240,14 @@ module ERBLint
     end
 
     def relative_filename(filename)
-      filename.sub("#{File.expand_path('.', Dir.pwd)}/", '')
+      filename.sub("#{File.expand_path(".", Dir.pwd)}/", "")
     end
 
     def runner_config_override
       RunnerConfig.new(
         linters: {}.tap do |linters|
           ERBLint::LinterRegistry.linters.map do |klass|
-            linters[klass.simple_name] = { 'enabled' => enabled_linter_classes.include?(klass) }
+            linters[klass.simple_name] = { "enabled" => enabled_linter_classes.include?(klass) }
           end
         end
       )
@@ -258,6 +265,15 @@ module ERBLint
           end
         end
 
+        opts.on("--format FORMAT", format_options_help) do |format|
+          unless Reporter.available_format?(format)
+            error_message = invalid_format_error_message(format)
+            failure!(error_message)
+          end
+
+          @options[:format] = format
+        end
+
         opts.on("--lint-all", "Lint all files matching configured glob [default: #{DEFAULT_LINT_ALL_GLOB}]") do |config|
           @options[:lint_all] = config
         end
@@ -267,19 +283,36 @@ module ERBLint
         end
 
         opts.on("--enable-linters LINTER[,LINTER,...]", Array,
-          "Only use specified linter", "Known linters are: #{known_linter_names.join(', ')}") do |linters|
+          "Only use specified linter", "Known linters are: #{known_linter_names.join(", ")}") do |linters|
           linters.each do |linter|
             unless known_linter_names.include?(linter)
-              failure!("#{linter}: not a valid linter name (#{known_linter_names.join(', ')})")
+              failure!("#{linter}: not a valid linter name (#{known_linter_names.join(", ")})")
             end
           end
           @options[:enabled_linters] = linters
         end
 
+        opts.on("--fail-level SEVERITY", "Minimum severity for exit with error code") do |level|
+          parsed_severity = SEVERITY_CODE_TABLE[level.upcase.to_sym] || (SEVERITY_NAMES & [level.downcase]).first
+
+          if parsed_severity.nil?
+            failure!("#{level}: not a valid failure level (#{SEVERITY_NAMES.join(", ")})")
+          end
+          @options[:fail_level] = severity_level_for_name(parsed_severity)
+        end
+
         opts.on("-a", "--autocorrect", "Correct offenses automatically if possible (default: false)") do |config|
           @options[:autocorrect] = config
         end
 
+        opts.on(
+          "-sFILE",
+          "--stdin FILE",
+          "Pipe source from STDIN. Takes the path to be used to check which rules to apply."
+        ) do |file|
+          @options[:stdin] = [file]
+        end
+
         opts.on_tail("-h", "--help", "Show this message") do
           success!(opts)
         end
@@ -289,5 +322,19 @@ module ERBLint
         end
       end
     end
+
+    def format_options_help
+      "Report offenses in the given format: "\
+      "(#{Reporter.available_formats.join(", ")}) (default: multiline)"
+    end
+
+    def invalid_format_error_message(given_format)
+      formats = Reporter.available_formats.map { |format| "  - #{format}\n" }
+      "#{given_format}: is not a valid format. Available formats:\n#{formats.join}"
+    end
+
+    def stdin?
+      @options[:stdin].present?
+    end
   end
 end

data/lib/erb_lint/corrector.rb

@@ -21,7 +21,7 @@ module ERBLint
     end
 
     if ::RuboCop::Version::STRING.to_f >= 0.87
-      require 'rubocop/cop/legacy/corrector'
+      require "rubocop/cop/legacy/corrector"
       BASE = ::RuboCop::Cop::Legacy::Corrector
 
       def diagnostics

data/lib/erb_lint/linter.rb

@@ -14,9 +14,10 @@ module ERBLint
       # `ERBLint::Linters::Foo.simple_name`          #=> "Foo"
       # `ERBLint::Linters::Compass::Bar.simple_name` #=> "Compass::Bar"
       def inherited(linter)
-        linter.simple_name = if linter.name.start_with?('ERBLint::Linters::')
-          name_parts = linter.name.split('::')
-          name_parts[2..-1].join('::')
+        super
+        linter.simple_name = if linter.name.start_with?("ERBLint::Linters::")
+          name_parts = linter.name.split("::")
+          name_parts[2..-1].join("::")
         else
           linter.name
         end
@@ -52,8 +53,8 @@ module ERBLint
       raise NotImplementedError, "must implement ##{__method__}"
     end
 
-    def add_offense(source_range, message, context = nil)
-      @offenses << Offense.new(self, source_range, message, context)
+    def add_offense(source_range, message, context = nil, severity = nil)
+      @offenses << Offense.new(self, source_range, message, context, severity)
     end
 
     def clear_offenses

data/lib/erb_lint/linter_config.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'active_support'
-require 'smart_properties'
+require "active_support"
+require "smart_properties"
 
 module ERBLint
   class LinterConfig
@@ -27,7 +27,7 @@ module ERBLint
       allowed_keys = self.class.properties.keys.map(&:to_s)
       given_keys = config.keys
       if (extra_keys = given_keys - allowed_keys).any?
-        raise Error, "Given key is not allowed: #{extra_keys.join(', ')}"
+        raise Error, "Given key is not allowed: #{extra_keys.join(", ")}"
       end
       super(config)
     rescue SmartProperties::InitializationError => e

data/lib/erb_lint/linter_registry.rb

@@ -3,22 +3,31 @@
 module ERBLint
   # Stores all linters available to the application.
   module LinterRegistry
-    CUSTOM_LINTERS_DIR = '.erb-linters'
-    @linters = []
+    CUSTOM_LINTERS_DIR = ".erb-linters"
+    @loaded_linters = []
 
     class << self
-      attr_reader :linters
+      def clear
+        @linters = nil
+      end
 
       def included(linter_class)
-        @linters << linter_class
+        @loaded_linters << linter_class
       end
 
       def find_by_name(name)
         linters.detect { |linter| linter.simple_name == name }
       end
 
+      def linters
+        @linters ||= begin
+          load_custom_linters
+          @loaded_linters
+        end
+      end
+
       def load_custom_linters(directory = CUSTOM_LINTERS_DIR)
-        ruby_files = Dir.glob(File.expand_path(File.join(directory, '**', '*.rb')))
+        ruby_files = Dir.glob(File.expand_path(File.join(directory, "**", "*.rb")))
         ruby_files.each { |file| require file }
       end
     end

data/lib/erb_lint/linters/allowed_script_type.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'better_html'
-require 'better_html/tree/tag'
+require "better_html"
+require "better_html/tree/tag"
 
 module ERBLint
   module Linters
@@ -13,7 +13,7 @@ module ERBLint
 
       class ConfigSchema < LinterConfig
         property :allowed_types, accepts: array_of?(String),
-          default: -> { ['text/javascript'] }
+          default: -> { ["text/javascript"] }
         property :allow_blank, accepts: [true, false], default: true, reader: :allow_blank?
         property :disallow_inline_scripts, accepts: [true, false], default: false, reader: :disallow_inline_scripts?
       end
@@ -24,7 +24,7 @@ module ERBLint
         parser.nodes_with_type(:tag).each do |tag_node|
           tag = BetterHtml::Tree::Tag.from_node(tag_node)
           next if tag.closing?
-          next unless tag.name == 'script'
+          next unless tag.name == "script"
 
           if @config.disallow_inline_scripts?
             name_node = tag_node.to_a[1]
@@ -36,7 +36,7 @@ module ERBLint
             next
           end
 
-          type_attribute = tag.attributes['type']
+          type_attribute = tag.attributes["type"]
           type_present = type_attribute.present? && type_attribute.value_node.present?
 
           if !type_present && !@config.allow_blank?
@@ -50,8 +50,8 @@ module ERBLint
             add_offense(
               type_attribute.loc,
               "Avoid using #{type_attribute.value.inspect} as type for `<script>` tag. "\
-              "Must be one of: #{@config.allowed_types.join(', ')}"\
-              "#{' (or no type attribute)' if @config.allow_blank?}."
+              "Must be one of: #{@config.allowed_types.join(", ")}"\
+              "#{" (or no type attribute)" if @config.allow_blank?}."
             )
           end
         end