erb_lint 0.0.37 → 0.1.1

data/lib/erb_lint/linters/rubocop_text.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'rubocop'
+require_relative "rubocop"
 
 module ERBLint
   module Linters

data/lib/erb_lint/linters/self_closing_tag.rb

@@ -11,10 +11,8 @@ module ERBLint
       end
       self.config_schema = ConfigSchema
 
-      SELF_CLOSING_TAGS = %w(
-        area base br col command embed hr input keygen
-        link menuitem meta param source track wbr img
-      )
+      SELF_CLOSING_TAGS = ["area", "base", "br", "col", "command", "embed", "hr", "input", "keygen", "link",
+                           "menuitem", "meta", "param", "source", "track", "wbr", "img",]
 
       def run(processed_source)
         processed_source.ast.descendants(:tag).each do |tag_node|
@@ -26,7 +24,7 @@ module ERBLint
             add_offense(
               start_solidus.loc,
               "Tag `#{tag.name}` is a void element, it must not start with `</`.",
-              ''
+              ""
             )
           end
 
@@ -34,7 +32,7 @@ module ERBLint
             add_offense(
               tag_node.loc.end.offset(-1),
               "Tag `#{tag.name}` is self-closing, it must end with `/>`.",
-              '/'
+              "/"
             )
           end
 
@@ -43,7 +41,7 @@ module ERBLint
           add_offense(
             end_solidus.loc,
             "Tag `#{tag.name}` is a void element, it must end with `>` and not `/>`.",
-            ''
+            ""
           )
         end
       end

data/lib/erb_lint/linters/space_around_erb_tag.rb

@@ -15,7 +15,7 @@ module ERBLint
         processed_source.ast.descendants(:erb).each do |erb_node|
           indicator_node, ltrim, code_node, rtrim = *erb_node
           indicator = indicator_node&.loc&.source
-          next if indicator == '#' || indicator == '%'
+          next if indicator == "#" || indicator == "%"
           code = code_node.children.first
 
           start_spaces = code.match(START_SPACES)&.captures&.first || ""
@@ -23,8 +23,8 @@ module ERBLint
             add_offense(
               code_node.loc.resize(start_spaces.size),
               "Use 1 space after `<%#{indicator}#{ltrim&.loc&.source}` "\
-              "instead of #{start_spaces.size} space#{'s' if start_spaces.size > 1}.",
-              ' '
+              "instead of #{start_spaces.size} space#{"s" if start_spaces.size > 1}.",
+              " "
             )
           elsif start_spaces.count("\n") > 1
             lines = start_spaces.split("\n", -1)
@@ -41,8 +41,8 @@ module ERBLint
             add_offense(
               code_node.loc.end.adjust(begin_pos: -end_spaces.size),
               "Use 1 space before `#{rtrim&.loc&.source}%>` "\
-              "instead of #{end_spaces.size} space#{'s' if start_spaces.size > 1}.",
-              ' '
+              "instead of #{end_spaces.size} space#{"s" if start_spaces.size > 1}.",
+              " "
             )
           elsif end_spaces.count("\n") > 1
             lines = end_spaces.split("\n", -1)

data/lib/erb_lint/linters/space_in_html_tag.rb

@@ -50,7 +50,7 @@ module ERBLint
         add_offense(
           processed_source.to_source_range(range),
           "Extra space detected where there should be no space.",
-          ''
+          ""
         )
       end
 
@@ -60,24 +60,24 @@ module ERBLint
 
       def single_space(processed_source, range, accept_newline: false)
         chars = processed_source.file_content[range]
-        return if chars == ' '
+        return if chars == " "
 
         newlines = chars.include?("\n")
-        expected = newlines && accept_newline ? "\n#{chars.split("\n", -1).last}" : ' '
+        expected = newlines && accept_newline ? "\n#{chars.split("\n", -1).last}" : " "
         non_space = chars.match(/([^[[:space:]]])/m)
 
         if non_space && !non_space.captures.empty?
           add_offense(
             processed_source.to_source_range(range),
             "Non-whitespace character(s) detected: "\
-              "#{non_space.captures.map(&:inspect).join(', ')}.",
+              "#{non_space.captures.map(&:inspect).join(", ")}.",
             expected
           )
         elsif newlines && accept_newline
           if expected != chars
             add_offense(
               processed_source.to_source_range(range),
-              "#{chars.empty? ? 'No' : 'Extra'} space detected where there should be "\
+              "#{chars.empty? ? "No" : "Extra"} space detected where there should be "\
                 "a single space or a single line break.",
               expected
             )
@@ -85,7 +85,7 @@ module ERBLint
         else
           add_offense(
             processed_source.to_source_range(range),
-            "#{chars.empty? ? 'No' : 'Extra'} space detected where there should be a single space.",
+            "#{chars.empty? ? "No" : "Extra"} space detected where there should be a single space.",
             expected
           )
         end

data/lib/erb_lint/linters/space_indentation.rb

@@ -23,7 +23,7 @@ module ERBLint
             add_offense(
               processed_source.to_source_range(document_pos...(document_pos + spaces.length)),
               "Indent with spaces instead of tabs.",
-              spaces.gsub("\t", ' ' * @config.tab_width)
+              spaces.gsub("\t", " " * @config.tab_width)
             )
           end
 

data/lib/erb_lint/linters/trailing_whitespace.rb

@@ -25,7 +25,7 @@ module ERBLint
 
       def autocorrect(_processed_source, offense)
         lambda do |corrector|
-          corrector.replace(offense.source_range, '')
+          corrector.replace(offense.source_range, "")
         end
       end
     end

data/lib/erb_lint/offense.rb

@@ -3,9 +3,9 @@
 module ERBLint
   # Defines common functionality available to all linters.
   class Offense
-    attr_reader :linter, :source_range, :message, :context
+    attr_reader :linter, :source_range, :message, :context, :severity
 
-    def initialize(linter, source_range, message, context = nil)
+    def initialize(linter, source_range, message, context = nil, severity = nil)
       unless source_range.is_a?(Parser::Source::Range)
         raise ArgumentError, "expected Parser::Source::Range for arg 2"
       end
@@ -13,19 +13,22 @@ module ERBLint
       @source_range = source_range
       @message = message
       @context = context
+      @severity = severity
     end
 
     def inspect
       "#<#{self.class.name} linter=#{linter.class.name} "\
         "source_range=#{source_range.begin_pos}...#{source_range.end_pos} "\
-        "message=#{message}>"
+        "message=#{message}> "\
+        "severity=#{severity}"
     end
 
     def ==(other)
       other.class <= ERBLint::Offense &&
         other.linter == linter &&
         other.source_range == source_range &&
-        other.message == message
+        other.message == message &&
+        other.severity == severity
     end
 
     def line_range

data/lib/erb_lint/reporter.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
-require 'active_support/core_ext/class'
-require 'active_support/core_ext/module/delegation'
+require "active_support/core_ext/class"
+require "active_support/core_ext/module/delegation"
 
 module ERBLint
   class Reporter

data/lib/erb_lint/reporters/compact_reporter.rb

@@ -5,7 +5,7 @@ module ERBLint
     class CompactReporter < Reporter
       def preview
         puts "Linting #{stats.files} files with "\
-          "#{stats.linters} #{'autocorrectable ' if autocorrect}linters..."
+          "#{stats.linters} #{"autocorrectable " if autocorrect}linters..."
       end
 
       def show
@@ -35,8 +35,14 @@ module ERBLint
       def summary
         if stats.corrected > 0
           report_corrected_offenses
-        elsif stats.found > 0
-          warn(Rainbow("#{stats.found} error(s) were found in ERB files").red)
+        elsif stats.ignored > 0 || stats.found > 0
+          if stats.ignored > 0
+            warn(Rainbow("#{stats.ignored} error(s) were ignored in ERB files").yellow)
+          end
+
+          if stats.found > 0
+            warn(Rainbow("#{stats.found} error(s) were found in ERB files").red)
+          end
         else
           puts Rainbow("No errors were found in ERB files").green
         end

data/lib/erb_lint/reporters/json_reporter.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require "json"
+
+module ERBLint
+  module Reporters
+    class JsonReporter < Reporter
+      def preview; end
+
+      def show
+        puts formatted_data
+      end
+
+      private
+
+      def formatted_data
+        {
+          metadata: metadata,
+          files: formatted_files,
+          summary: summary,
+        }.to_json
+      end
+
+      def metadata
+        {
+          erb_lint_version: ERBLint::VERSION,
+          ruby_engine: RUBY_ENGINE,
+          ruby_version: RUBY_VERSION,
+          ruby_patchlevel: RUBY_PATCHLEVEL.to_s,
+          ruby_platform: RUBY_PLATFORM,
+        }
+      end
+
+      def summary
+        {
+          offenses: stats.found,
+          inspected_files: stats.processed_files.size,
+          corrected: stats.corrected,
+        }
+      end
+
+      def formatted_files
+        processed_files.map do |filename, offenses|
+          {
+            path: filename,
+            offenses: formatted_offenses(offenses),
+          }
+        end
+      end
+
+      def formatted_offenses(offenses)
+        offenses.map do |offense|
+          format_offense(offense)
+        end
+      end
+
+      def format_offense(offense)
+        {
+          linter: offense.linter.class.simple_name,
+          message: offense.message.to_s,
+          location: {
+            start_line: offense.line_number,
+            start_column: offense.column,
+            last_line: offense.source_range.last_line,
+            last_column: offense.source_range.last_column,
+            length: offense.source_range.length,
+          },
+        }
+      end
+    end
+  end
+end

data/lib/erb_lint/reporters/multiline_reporter.rb

@@ -9,7 +9,7 @@ module ERBLint
       def format_offense(filename, offense)
         <<~EOF
 
-          #{offense.message}#{Rainbow(' (not autocorrected)').red if autocorrect}
+          #{offense.message}#{Rainbow(" (not autocorrected)").red if autocorrect}
           In file: #{filename}:#{offense.line_number}
         EOF
       end

data/lib/erb_lint/runner.rb

@@ -8,7 +8,7 @@ module ERBLint
     def initialize(file_loader, config)
       @file_loader = file_loader
       @config = config || RunnerConfig.default
-      raise ArgumentError, 'expect `config` to be a RunnerConfig instance' unless @config.is_a?(RunnerConfig)
+      raise ArgumentError, "expect `config` to be a RunnerConfig instance" unless @config.is_a?(RunnerConfig)
 
       linter_classes = LinterRegistry.linters.select { |klass| @config.for_linter(klass).enabled? }
       @linters = linter_classes.map do |linter_class|

data/lib/erb_lint/runner_config.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'erb_lint/runner_config_resolver'
+require "erb_lint/runner_config_resolver"
 
 module ERBLint
   class RunnerConfig
@@ -9,7 +9,7 @@ module ERBLint
     def initialize(config = nil, file_loader = nil)
       @config = (config || {}).dup.deep_stringify_keys
 
-      resolver.resolve_inheritance_from_gems(@config, @config.delete('inherit_gem'))
+      resolver.resolve_inheritance_from_gems(@config, @config.delete("inherit_gem"))
       resolver.resolve_inheritance(@config, file_loader) if file_loader
       @config.delete("inherit_from")
     end
@@ -24,7 +24,7 @@ module ERBLint
       elsif klass.is_a?(Class) && klass <= ERBLint::Linter
         klass.simple_name
       else
-        raise ArgumentError, 'expected String or linter class'
+        raise ArgumentError, "expected String or linter class"
       end
       linter_klass = LinterRegistry.find_by_name(klass_name)
       raise Error, "#{klass_name}: linter not found (is it loaded?)" unless linter_klass
@@ -32,7 +32,7 @@ module ERBLint
     end
 
     def global_exclude
-      @config['exclude'] || []
+      @config["exclude"] || []
     end
 
     def merge(other_config)
@@ -61,6 +61,7 @@ module ERBLint
             SpaceIndentation: { enabled: default_enabled },
             SpaceInHtmlTag: { enabled: default_enabled },
             TrailingWhitespace: { enabled: default_enabled },
+            RequireInputAutocomplete: { enabled: default_enabled },
           },
         )
       end
@@ -74,13 +75,13 @@ module ERBLint
     private
 
     def linters_config
-      @config['linters'] || {}
+      @config["linters"] || {}
     end
 
     def config_hash_for_linter(klass_name)
       config_hash = linters_config[klass_name] || {}
-      config_hash['exclude'] ||= []
-      config_hash['exclude'].concat(global_exclude) if config_hash['exclude'].is_a?(Array)
+      config_hash["exclude"] ||= []
+      config_hash["exclude"].concat(global_exclude) if config_hash["exclude"].is_a?(Array)
       config_hash
     end
 

data/lib/erb_lint/runner_config_resolver.rb

@@ -24,7 +24,7 @@
 module ERBLint
   class RunnerConfigResolver
     def resolve_inheritance(hash, file_loader)
-      inherited_files = Array(hash['inherit_from'])
+      inherited_files = Array(hash["inherit_from"])
       base_configs(file_loader, inherited_files).reverse_each do |base_config|
         base_config.each do |k, v|
           next unless v.is_a?(Hash)
@@ -36,12 +36,12 @@ module ERBLint
 
     def resolve_inheritance_from_gems(hash, gems)
       (gems || {}).each_pair do |gem_name, config_path|
-        raise(ArgumentError, "can't inherit configuration from the erb-lint gem") if gem_name == 'erb-lint'
+        raise(ArgumentError, "can't inherit configuration from the erb-lint gem") if gem_name == "erb-lint"
 
-        hash['inherit_from'] = Array(hash['inherit_from'])
+        hash["inherit_from"] = Array(hash["inherit_from"])
         Array(config_path).reverse_each do |path|
           # Put gem configuration first so local configuration overrides it.
-          hash['inherit_from'].unshift(gem_config_path(gem_name, path))
+          hash["inherit_from"].unshift(gem_config_path(gem_name, path))
         end
       end
     end

data/lib/erb_lint/stats.rb

@@ -1,14 +1,16 @@
 # frozen_string_literal: true
 module ERBLint
   class Stats
-    attr_accessor :found,
-                  :corrected,
-                  :exceptions,
-                  :linters,
-                  :files,
-                  :processed_files
+    attr_accessor :ignored,
+      :found,
+      :corrected,
+      :exceptions,
+      :linters,
+      :files,
+      :processed_files
 
     def initialize(
+      ignored: 0,
       found: 0,
       corrected: 0,
       exceptions: 0,
@@ -16,6 +18,7 @@ module ERBLint
       files: 0,
       processed_files: {}
     )
+      @ignored = ignored
       @found = found
       @corrected = corrected
       @exceptions = exceptions

data/lib/erb_lint/utils/block_map.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'better_html/ast/node'
-require 'better_html/test_helper/ruby_node'
+require "better_html/ast/node"
+require "better_html/test_helper/ruby_node"
 
 module ERBLint
   module Utils

data/lib/erb_lint/utils/offset_corrector.rb

@@ -63,7 +63,7 @@ module ERBLint
           node_or_range
         else
           raise TypeError,
-            'Expected a Parser::Source::Range, Comment or ' \
+            "Expected a Parser::Source::Range, Comment or " \
                         "Rubocop::AST::Node, got #{node_or_range.class}"
         end
       end