erb_lint 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98ba7a87f348e584502a9e4810f9311329c04aeddf34af0b05a37702648b495e
-  data.tar.gz: 8728892a4c09fcbdbddb60316b911bf73ce099cc04e9ac10534b76f8aa6708a5
+  metadata.gz: ed317d0bcb868320c088c8788e5b14ba9f8224aab3e6ae2e4952e34df8fdefc4
+  data.tar.gz: 21fe3cfccf4d30225d11fa2f397186b5274bbb8d1fe6ff5bf593ac225bb327a9
 SHA512:
-  metadata.gz: 8d01f3c07ddebb9482ee744c69df6e799b4c0cb06bd24ffd7939f3d86e612a4f1bb2d5b4040c8505d7c8f8e9cceaecaabcca7dc03cab6ea5f23e73f10e098345
-  data.tar.gz: '080398f6522352b669bf21ea1fbdd8850b7b6b8dcef60493d8349fbfeb98eceeefc77c15442cad339612e83c5056d5498a286046c3a3749a73428661c962b695'
+  metadata.gz: d281ca485b9763dc2d7e3b3297b429c2fa08f1f043e557b7a9ad9ab65c5e0e422d5ccabbd66f40e3da43088bc1b580dd9dab5213dca39a894a7b0da82c0e113c
+  data.tar.gz: 9907b4b4089693f5787c96b0e5cef7b1c9bd49b6831d6e6c42757fb69911a0905b395f468fab7c0339d3b0e166b6962d1a4db772476f669d659f6380e88a90c4

data/exe/erb_lint

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+lib_path = File.expand_path("#{__dir__}/../lib")
+$LOAD_PATH.unshift(lib_path) unless $LOAD_PATH.include?(lib_path)
+
+require "erb_lint/cli"
+
+cli = ERBLint::CLI.new
+exit(cli.run)

data/exe/erblint

@@ -1,9 +1,10 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-$LOAD_PATH.unshift("#{__dir__}/../lib")
+lib_path = File.expand_path("#{__dir__}/../lib")
+$LOAD_PATH.unshift(lib_path) unless $LOAD_PATH.include?(lib_path)
 
-require "erb_lint/cli"
+require "rainbow"
 
-cli = ERBLint::CLI.new
-exit(cli.run)
+warn(Rainbow("Calling `erblint` is deprecated, please call the renamed executable `erb_lint` instead.").yellow)
+exec(File.join(__dir__, "erb_lint"), *ARGV)

data/lib/erb_lint/cache.rb

@@ -2,7 +2,7 @@
 
 module ERBLint
   class Cache
-    CACHE_DIRECTORY = ".erb-lint-cache"
+    CACHE_DIRECTORY = ".erb_lint_cache"
 
     def initialize(config, cache_dir = nil)
       @config = config
@@ -16,7 +16,7 @@ module ERBLint
       file_checksum = checksum(filename, file_content)
       begin
         cache_file_contents_as_offenses = JSON.parse(
-          File.read(File.join(@cache_dir, file_checksum))
+          File.read(File.join(@cache_dir, file_checksum)),
         ).map do |offense_hash|
           ERBLint::CachedOffense.new(offense_hash)
         end
@@ -76,7 +76,7 @@ module ERBLint
       mode = File.stat(filename).mode
 
       digester.update(
-        "#{mode}#{config.to_hash}#{ERBLint::VERSION}#{file_content}"
+        "#{mode}#{config.to_hash}#{ERBLint::VERSION}#{file_content}",
       )
       digester.hexdigest
     rescue Errno::ENOENT

data/lib/erb_lint/cached_offense.rb

@@ -38,7 +38,7 @@ module ERBLint
           last_line: offense.last_line,
           last_column: offense.last_column,
           length: offense.length,
-        }
+        },
       )
     end
 

data/lib/erb_lint/cli.rb

@@ -13,7 +13,8 @@ module ERBLint
   class CLI
     include Utils::SeverityLevels
 
-    DEFAULT_CONFIG_FILENAME = ".erb-lint.yml"
+    DEPRECATED_CONFIG_FILENAME = ".erb-lint.yml"
+    DEFAULT_CONFIG_FILENAME = ".erb_lint.yml"
     DEFAULT_LINT_ALL_GLOB = "**/*.html{+*,}.erb"
 
     class ExitWithFailure < RuntimeError; end
@@ -74,7 +75,7 @@ module ERBLint
       @stats.linters = enabled_linter_classes.size
       @stats.autocorrectable_linters = enabled_linter_classes.count(&:support_autocorrect?)
 
-      reporter = Reporter.create_reporter(@options[:format], @stats, autocorrect?)
+      reporter = Reporter.create_reporter(@options[:format], @stats, autocorrect?, @options[:show_linter_names])
       reporter.preview
 
       runner = ERBLint::Runner.new(file_loader, @config, @options[:disable_inline_configs])
@@ -87,7 +88,7 @@ module ERBLint
         rescue => e
           @stats.exceptions += 1
           puts "Exception occurred when processing: #{relative_filename(filename)}"
-          puts "If this file cannot be processed by erb-lint, "\
+          puts "If this file cannot be processed by erb_lint, " \
             "you can exclude it in your configuration file."
           puts e.message
           puts Rainbow(e.backtrace.join("\n")).red
@@ -215,6 +216,13 @@ module ERBLint
       if File.exist?(config_filename)
         config = RunnerConfig.new(file_loader.yaml(config_filename), file_loader)
         @config = RunnerConfig.default_for(config)
+      elsif File.exist?(DEPRECATED_CONFIG_FILENAME)
+        deprecation_message = "The config file has been renamed to `#{DEFAULT_CONFIG_FILENAME}` and " \
+          "`#{DEPRECATED_CONFIG_FILENAME}` is deprecated. " \
+          "Please rename your config file to `#{DEFAULT_CONFIG_FILENAME}`."
+        warn(Rainbow(deprecation_message).yellow)
+        config = RunnerConfig.new(file_loader.yaml(DEPRECATED_CONFIG_FILENAME), file_loader)
+        @config = RunnerConfig.default_for(config)
       else
         warn(Rainbow("#{config_filename} not found: using default config").yellow)
         @config = RunnerConfig.default
@@ -303,7 +311,7 @@ module ERBLint
           ERBLint::LinterRegistry.linters.map do |klass|
             linters[klass.simple_name] = { "enabled" => enabled_linter_classes.include?(klass) }
           end
-        end
+        end,
       )
     end
 
@@ -348,8 +356,12 @@ module ERBLint
           @options[:clear_cache] = config
         end
 
-        opts.on("--enable-linters LINTER[,LINTER,...]", Array,
-          "Only use specified linter", "Known linters are: #{known_linter_names.join(", ")}") do |linters|
+        opts.on(
+          "--enable-linters LINTER[,LINTER,...]",
+          Array,
+          "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(", ")})")
@@ -371,6 +383,10 @@ module ERBLint
           @options[:autocorrect] = config
         end
 
+        opts.on("--show-linter-names", "Show linter names") do
+          @options[:show_linter_names] = true
+        end
+
         opts.on("--allow-no-files", "When no matching files found, exit successfully (default: false)") do |config|
           @options[:allow_no_files] = config
         end
@@ -382,7 +398,7 @@ module ERBLint
         opts.on(
           "-sFILE",
           "--stdin FILE",
-          "Pipe source from STDIN. Takes the path to be used to check which rules to apply."
+          "Pipe source from STDIN. Takes the path to be used to check which rules to apply.",
         ) do |file|
           @options[:stdin] = [file]
         end
@@ -398,7 +414,7 @@ module ERBLint
     end
 
     def format_options_help
-      "Report offenses in the given format: "\
+      "Report offenses in the given format: " \
         "(#{Reporter.available_formats.join(", ")}) (default: multiline)"
     end
 

data/lib/erb_lint/linter.rb

@@ -38,7 +38,7 @@ module ERBLint
     def initialize(file_loader, config)
       @file_loader = file_loader
       @config = config
-      raise ArgumentError, "expect `config` to be #{self.class.config_schema} instance, "\
+      raise ArgumentError, "expect `config` to be #{self.class.config_schema} instance, " \
         "not #{config.class}" unless config.is_a?(self.class.config_schema)
       @offenses = []
     end

data/lib/erb_lint/linter_registry.rb

@@ -3,7 +3,8 @@
 module ERBLint
   # Stores all linters available to the application.
   module LinterRegistry
-    CUSTOM_LINTERS_DIR = ".erb-linters"
+    DEPRECATED_CUSTOM_LINTERS_DIR = ".erb-linters"
+    CUSTOM_LINTERS_DIR = ".erb_linters"
     @loaded_linters = []
 
     class << self
@@ -28,6 +29,15 @@ module ERBLint
 
       def load_custom_linters(directory = CUSTOM_LINTERS_DIR)
         ruby_files = Dir.glob(File.expand_path(File.join(directory, "**", "*.rb")))
+
+        deprecated_ruby_files = Dir.glob(File.expand_path(File.join(DEPRECATED_CUSTOM_LINTERS_DIR, "**", "*.rb")))
+        if deprecated_ruby_files.any?
+          deprecation_message = "The '#{DEPRECATED_CUSTOM_LINTERS_DIR}' directory for custom linters is deprecated. " \
+            "Please rename it to '#{CUSTOM_LINTERS_DIR}'"
+          warn(Rainbow(deprecation_message).yellow)
+          ruby_files.concat(deprecated_ruby_files)
+        end
+
         ruby_files.each { |file| require file }
       end
     end

data/lib/erb_lint/linters/allowed_script_type.rb

@@ -12,7 +12,8 @@ module ERBLint
       include LinterRegistry
 
       class ConfigSchema < LinterConfig
-        property :allowed_types, accepts: array_of?(String),
+        property :allowed_types,
+          accepts: array_of?(String),
           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?
@@ -30,8 +31,8 @@ module ERBLint
             name_node = tag_node.to_a[1]
             add_offense(
               name_node.loc,
-              "Avoid using inline `<script>` tags altogether. "\
-                "Instead, move javascript code into a static file."
+              "Avoid using inline `<script>` tags altogether. " \
+                "Instead, move javascript code into a static file.",
             )
             next
           end
@@ -44,14 +45,14 @@ module ERBLint
             add_offense(
               name_node.loc,
               "Missing a `type=\"text/javascript\"` attribute to `<script>` tag.",
-              [type_attribute]
+              [type_attribute],
             )
           elsif type_present && !@config.allowed_types.include?(type_attribute.value)
             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?}."
+              "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?}.",
             )
           end
         end

data/lib/erb_lint/linters/closing_erb_tag_indent.rb

@@ -25,13 +25,13 @@ module ERBLint
             add_offense(
               code_node.loc.end.adjust(begin_pos: -end_spaces.size),
               "Remove newline before `%>` to match start of tag.",
-              " "
+              " ",
             )
           elsif start_with_newline && !end_with_newline
             add_offense(
               code_node.loc.end.adjust(begin_pos: -end_spaces.size),
               "Insert newline before `%>` to match start of tag.",
-              "\n"
+              "\n",
             )
           elsif start_with_newline && end_with_newline
             current_indent = end_spaces.split("\n", -1).last
@@ -39,7 +39,7 @@ module ERBLint
               add_offense(
                 code_node.loc.end.adjust(begin_pos: -current_indent.size),
                 "Indent `%>` on column #{erb_node.loc.column} to match start of tag.",
-                " " * erb_node.loc.column
+                " " * erb_node.loc.column,
               )
             end
           end

data/lib/erb_lint/linters/comment_syntax.rb

@@ -31,7 +31,7 @@ module ERBLint
 
           add_offense(
             source_range,
-            <<~EOF.chomp
+            <<~EOF.chomp,
               Bad ERB comment syntax. Should be #{correct_erb_tag} without a space between.
               Leaving a space between ERB tags and the Ruby comment character can cause parser errors.
             EOF

data/lib/erb_lint/linters/deprecated_classes.rb

@@ -49,7 +49,7 @@ module ERBLint
           process_nested_offenses(
             source: sub_source,
             offset: offset + content_node.loc.begin_pos,
-            parent_source: parent_source
+            parent_source: parent_source,
           )
         end
       end
@@ -99,7 +99,7 @@ module ERBLint
 
           add_offense(
             range,
-            format(message, class_name, violated_rule[:class_expr], suggestion)
+            format(message, class_name, violated_rule[:class_expr], suggestion),
           )
         end
       end

data/lib/erb_lint/linters/erb_safety.rb

@@ -26,7 +26,7 @@ module ERBLint
           tester.errors.each do |error|
             add_offense(
               error.location,
-              error.message
+              error.message,
             )
           end
         end

data/lib/erb_lint/linters/extra_newline.rb

@@ -15,7 +15,7 @@ module ERBLint
           add_offense(
             processed_source
               .to_source_range((matches.begin(index) + 2)...matches.end(index)),
-            "Extra blank line detected."
+            "Extra blank line detected.",
           )
         end
       end

data/lib/erb_lint/linters/final_newline.rb

@@ -29,22 +29,22 @@ module ERBLint
             add_offense(
               processed_source.to_source_range(file_content.size...file_content.size),
               "Missing a trailing newline at the end of the file.",
-              :insert
+              :insert,
             )
           else
             add_offense(
               processed_source.to_source_range(
-                (file_content.size - final_newline.size + 1)...file_content.size
+                (file_content.size - final_newline.size + 1)...file_content.size,
               ),
               "Remove multiple trailing newline at the end of the file.",
-              :remove
+              :remove,
             )
           end
         elsif !@new_lines_should_be_present && !final_newline.empty?
           add_offense(
             processed_source.to_source_range(match.begin(0)...match.end(0)),
             "Remove #{final_newline.size} trailing newline at the end of the file.",
-            :remove
+            :remove,
           )
         end
       end

data/lib/erb_lint/linters/hard_coded_string.rb

@@ -41,6 +41,8 @@ module ERBLint
         " ",
         " ",
         "×",
+        "«",
+        "»",
       ])
 
       class ConfigSchema < LinterConfig
@@ -67,7 +69,7 @@ module ERBLint
 
           add_offense(
             source_range,
-            message(source_range.source)
+            message(source_range.source),
           )
         end
       end
@@ -84,7 +86,7 @@ module ERBLint
       def autocorrect(processed_source, offense)
         string = offense.source_range.source
         return unless (klass = load_corrector)
-        return unless string.strip.length > 1
+        return if string.strip.length <= 1
 
         node = ::RuboCop::AST::StrNode.new(:str, [string])
         corrector = klass.new(node, processed_source.filename, corrector_i18n_load_path, offense.source_range)

data/lib/erb_lint/linters/no_javascript_tag_helper.rb

@@ -38,9 +38,9 @@ module ERBLint
 
           add_offense(
             erb_node.loc,
-            "Avoid using 'javascript_tag do' as it confuses tests "\
+            "Avoid using 'javascript_tag do' as it confuses tests " \
               "that validate html, use inline <script> instead",
-            [erb_node, send_node]
+            [erb_node, send_node],
           )
         end
       end
@@ -82,8 +82,10 @@ module ERBLint
           corrector.replace(end_node.loc, end_content)
         elsif script_content
           script_content = "\n//<![CDATA[\n#{script_content}\n//]]>\n" if @config.correction_style == :cdata
-          corrector.replace(begin_node.loc,
-            "<script#{arguments}>#{script_content}</script>")
+          corrector.replace(
+            begin_node.loc,
+            "<script#{arguments}>#{script_content}</script>",
+          )
         end
       rescue Utils::RubyToERB::Error, Utils::BlockMap::ParseError
         nil

data/lib/erb_lint/linters/no_unused_disable.rb

@@ -35,8 +35,10 @@ module ERBLint
 
         disabled_rules_and_line_number.each do |rule, line_numbers|
           line_numbers.each do |line_number|
-            add_offense(processed_source.source_buffer.line_range(line_number),
-              "Unused erblint:disable comment for #{rule}")
+            add_offense(
+              processed_source.source_buffer.line_range(line_number),
+              "Unused erblint:disable comment for #{rule}",
+            )
           end
         end
       end

data/lib/erb_lint/linters/parser_errors.rb

@@ -9,7 +9,7 @@ module ERBLint
         processed_source.parser.parser_errors.each do |error|
           add_offense(
             error.loc,
-            "#{error.message} (at #{error.loc.source})"
+            "#{error.message} (at #{error.loc.source})",
           )
         end
       end

data/lib/erb_lint/linters/partial_instance_variable.rb

@@ -13,9 +13,9 @@ module ERBLint
 
         add_offense(
           processed_source.to_source_range(
-            processed_source.file_content =~ instance_variable_regex..processed_source.file_content.size
+            processed_source.file_content =~ instance_variable_regex..processed_source.file_content.size,
           ),
-          "Instance variable detected in partial."
+          "Instance variable detected in partial.",
         )
       end
     end

data/lib/erb_lint/linters/require_input_autocomplete.rb

@@ -62,9 +62,9 @@ module ERBLint
 
           add_offense(
             tag_node.to_a[1].loc,
-            "Input tag is missing an autocomplete attribute. If no "\
+            "Input tag is missing an autocomplete attribute. If no " \
               "autocomplete behaviour is desired, use the value `off` or `nope`.",
-            [autocomplete_attribute]
+            [autocomplete_attribute],
           )
         end
       end
@@ -96,9 +96,9 @@ module ERBLint
 
           add_offense(
             erb_node.loc,
-            "Input field helper is missing an autocomplete attribute. If no "\
+            "Input field helper is missing an autocomplete attribute. If no " \
               "autocomplete behaviour is desired, use the value `off` or `nope`.",
-            [erb_node, send_node]
+            [erb_node, send_node],
           )
         end
       end

data/lib/erb_lint/linters/require_script_nonce.rb

@@ -29,7 +29,7 @@ module ERBLint
           add_offense(
             tag_node.to_a[1].loc,
             "Missing a nonce attribute. Use request.content_security_policy_nonce",
-            [nonce_attribute]
+            [nonce_attribute],
           )
         end
       end
@@ -67,7 +67,7 @@ module ERBLint
           add_offense(
             erb_node.loc,
             "Missing a nonce attribute. Use nonce: true",
-            [erb_node, send_node]
+            [erb_node, send_node],
           )
         end
       end

data/lib/erb_lint/linters/right_trim.rb

@@ -19,7 +19,7 @@ module ERBLint
 
           add_offense(
             trim_node.loc,
-            "Prefer #{@config.enforced_style}%> instead of #{trim_node.loc.source}%> for trimming on the right."
+            "Prefer #{@config.enforced_style}%> instead of #{trim_node.loc.source}%> for trimming on the right.",
           )
         end
       end

data/lib/erb_lint/linters/rubocop.rb

@@ -134,7 +134,7 @@ module ERBLint
         source = ::RuboCop::ProcessedSource.new(
           content,
           @rubocop_config.target_ruby_version,
-          filename
+          filename,
         )
         if ::RuboCop::Version::STRING.to_f >= 1.38
           registry = RuboCop::Cop::Registry.global
@@ -146,15 +146,15 @@ module ERBLint
 
       def cop_classes
         if @only_cops.present?
-          selected_cops = ::RuboCop::Cop::Cop.all.select { |cop| cop.match?(@only_cops) }
+          selected_cops = ::RuboCop::Cop::Registry.all.select { |cop| cop.match?(@only_cops) }
           ::RuboCop::Cop::Registry.new(selected_cops)
         else
-          ::RuboCop::Cop::Registry.new(::RuboCop::Cop::Cop.all)
+          ::RuboCop::Cop::Registry.new(::RuboCop::Cop::Registry.all)
         end
       end
 
       def build_team
-        ::RuboCop::Cop::Team.new(
+        ::RuboCop::Cop::Team.mobilize(
           cop_classes,
           @rubocop_config,
           extra_details: true,

data/lib/erb_lint/linters/rubocop_text.rb

@@ -29,7 +29,7 @@ module ERBLint
       end
 
       def cop_classes
-        selected_cops = ::RuboCop::Cop::Cop.all.select { |cop| cop.match?(@only_cops) }
+        selected_cops = ::RuboCop::Cop::Registry.all.select { |cop| cop.match?(@only_cops) }
 
         ::RuboCop::Cop::Registry.new(selected_cops)
       end

data/lib/erb_lint/linters/self_closing_tag.rb

@@ -11,8 +11,25 @@ module ERBLint
       end
       self.config_schema = ConfigSchema
 
-      SELF_CLOSING_TAGS = ["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|
@@ -24,7 +41,7 @@ module ERBLint
             add_offense(
               start_solidus.loc,
               "Tag `#{tag.name}` is a void element, it must not start with `</`.",
-              ""
+              "",
             )
           end
 
@@ -32,7 +49,7 @@ module ERBLint
             add_offense(
               tag_node.loc.end.offset(-1),
               "Tag `#{tag.name}` is self-closing, it must end with `/>`.",
-              "/"
+              "/",
             )
           end
 
@@ -42,7 +59,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

@@ -23,17 +23,17 @@ module ERBLint
           if start_spaces.size != 1 && !start_spaces.include?("\n")
             add_offense(
               code_node.loc.resize(start_spaces.size),
-              "Use 1 space after `<%#{indicator}#{ltrim&.loc&.source}` "\
+              "Use 1 space after `<%#{indicator}#{ltrim&.loc&.source}` " \
                 "instead of #{start_spaces.size} space#{"s" if start_spaces.size > 1}.",
-              " "
+              " ",
             )
           elsif start_spaces.count("\n") > 1
             lines = start_spaces.split("\n", -1)
             add_offense(
               code_node.loc.resize(start_spaces.size),
-              "Use 1 newline after `<%#{indicator&.loc&.source}#{ltrim&.loc&.source}` "\
+              "Use 1 newline after `<%#{indicator&.loc&.source}#{ltrim&.loc&.source}` " \
                 "instead of #{start_spaces.count("\n")}.",
-              "#{lines.first}\n#{lines.last}"
+              "#{lines.first}\n#{lines.last}",
             )
           end
 
@@ -41,17 +41,17 @@ module ERBLint
           if end_spaces.size != 1 && !end_spaces.include?("\n")
             add_offense(
               code_node.loc.end.adjust(begin_pos: -end_spaces.size),
-              "Use 1 space before `#{rtrim&.loc&.source}%>` "\
+              "Use 1 space before `#{rtrim&.loc&.source}%>` " \
                 "instead of #{end_spaces.size} space#{"s" if start_spaces.size > 1}.",
-              " "
+              " ",
             )
           elsif end_spaces.count("\n") > 1
             lines = end_spaces.split("\n", -1)
             add_offense(
               code_node.loc.end.adjust(begin_pos: -end_spaces.size),
-              "Use 1 newline before `#{rtrim&.loc&.source}%>` "\
+              "Use 1 newline before `#{rtrim&.loc&.source}%>` " \
                 "instead of #{end_spaces.count("\n")}.",
-              "#{lines.first}\n#{lines.last}"
+              "#{lines.first}\n#{lines.last}",
             )
           end
         end

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
 
@@ -69,24 +69,24 @@ module ERBLint
         if non_space && !non_space.captures.empty?
           add_offense(
             processed_source.to_source_range(range),
-            "Non-whitespace character(s) detected: "\
+            "Non-whitespace character(s) detected: " \
               "#{non_space.captures.map(&:inspect).join(", ")}.",
-            expected
+            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
+              expected,
             )
           end
         else
           add_offense(
             processed_source.to_source_range(range),
             "#{chars.empty? ? "No" : "Extra"} space detected where there should be a single space.",
-            expected
+            expected,
           )
         end
       end
@@ -103,7 +103,7 @@ module ERBLint
 
           single_space_or_newline(
             processed_source,
-            attribute.loc.end_pos...next_attribute.loc.begin_pos
+            attribute.loc.end_pos...next_attribute.loc.begin_pos,
           )
         end
       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

@@ -18,7 +18,7 @@ module ERBLint
 
           add_offense(
             processed_source.to_source_range((document_pos - whitespace.length - 1)...(document_pos - 1)),
-            "Extra whitespace detected at end of line."
+            "Extra whitespace detected at end of line.",
           )
         end
       end

data/lib/erb_lint/offense.rb

@@ -23,9 +23,9 @@ module ERBLint
     end
 
     def inspect
-      "#<#{self.class.name} linter=#{linter.class.name} "\
-        "source_range=#{source_range.begin_pos}...#{source_range.end_pos} "\
-        "message=#{message}> "\
+      "#<#{self.class.name} linter=#{linter.class.name} " \
+        "source_range=#{source_range.begin_pos}...#{source_range.end_pos} " \
+        "message=#{message}> " \
         "severity=#{severity}"
     end
 

data/lib/erb_lint/processed_source.rb

@@ -27,7 +27,7 @@ module ERBLint
       BetterHtml::Tokenizer::Location.new(
         source_buffer,
         range.begin,
-        range.exclude_end? ? range.end : range.end + 1
+        range.exclude_end? ? range.end : range.end + 1,
       )
     end
   end

data/lib/erb_lint/reporter.rb

@@ -23,9 +23,10 @@ module ERBLint
         .sort
     end
 
-    def initialize(stats, autocorrect)
+    def initialize(stats, autocorrect, show_linter_names = false)
       @stats = stats
       @autocorrect = autocorrect
+      @show_linter_names = show_linter_names
     end
 
     def preview; end
@@ -34,7 +35,7 @@ module ERBLint
 
     private
 
-    attr_reader :stats, :autocorrect
+    attr_reader :stats, :autocorrect, :show_linter_names
 
     delegate :processed_files, to: :stats
   end

data/lib/erb_lint/reporters/compact_reporter.rb

@@ -33,8 +33,9 @@ module ERBLint
           "#{filename}:",
           "#{offense.line_number}:",
           "#{offense.column}: ",
+          ("[#{offense.simple_name}] " if show_linter_names),
           offense.message.to_s,
-        ].join
+        ].compact.join
       end
 
       def footer; end
@@ -60,7 +61,7 @@ module ERBLint
 
         if corrected_found_diff > 0
           message = Rainbow(
-            "#{stats.corrected} error(s) corrected and #{corrected_found_diff} error(s) remaining in ERB files"
+            "#{stats.corrected} error(s) corrected and #{corrected_found_diff} error(s) remaining in ERB files",
           ).red
 
           warn(message)

data/lib/erb_lint/reporters/gitlab_reporter.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "json"
+
+module ERBLint
+  module Reporters
+    class GitlabReporter < Reporter
+      def preview; end
+
+      def show
+        puts formatted_data
+      end
+
+      private
+
+      def formatted_data
+        formatted_files.to_json
+      end
+
+      def formatted_files
+        processed_files.flat_map do |filename, offenses|
+          formatted_offenses(filename, offenses)
+        end
+      end
+
+      def formatted_offenses(filename, offenses)
+        offenses.map do |offense|
+          format_offense(filename, offense)
+        end
+      end
+
+      def format_offense(filename, offense)
+        {
+          description: offense.message,
+          check_name: offense.simple_name,
+          fingerprint: generate_fingerprint(filename, offense),
+          severity: offense.severity,
+          location: {
+            path: filename,
+            lines: {
+              begin: offense.line_number,
+              end: offense.last_line,
+            },
+          },
+        }
+      end
+
+      def generate_fingerprint(filename, offense)
+        Digest::MD5.hexdigest(
+          "#{offense.simple_name}@#{filename}:#{offense.line_number}:#{offense.last_line}",
+        )
+      end
+    end
+  end
+end

data/lib/erb_lint/reporters/junit_reporter.rb

@@ -1,111 +1,62 @@
 # frozen_string_literal: true
 
-require "rexml/document"
-require "rexml/formatters/pretty"
-
 module ERBLint
   module Reporters
     class JunitReporter < Reporter
+      ESCAPE_MAP = {
+        '"' => "&quot;",
+        "'" => "&apos;",
+        "<" => "&lt;",
+        ">" => "&gt;",
+        "&" => "&amp;",
+      }.freeze
+
+      PROPERTIES = [
+        ["erb_lint_version", ERBLint::VERSION],
+        ["ruby_engine", RUBY_ENGINE],
+        ["ruby_version", RUBY_VERSION],
+        ["ruby_patchlevel", RUBY_PATCHLEVEL.to_s],
+        ["ruby_platform", RUBY_PLATFORM],
+      ].freeze
+
       def preview; end
 
       def show
-        xml = create_junit_xml
-        formatted_xml_string = StringIO.new
-        REXML::Formatters::Pretty.new.write(xml, formatted_xml_string)
-        puts formatted_xml_string.string
-      end
-
-      private
-
-      CONTEXT = {
-        prologue_quote: :quote,
-        attribute_quote: :quote,
-      }
-
-      def create_junit_xml
-        # create prologue
-        xml = REXML::Document.new(nil, CONTEXT)
-        xml << REXML::XMLDecl.new("1.0", "UTF-8")
-
-        xml.add_element(create_testsuite_element)
+        puts %(<?xml version="1.0" encoding="UTF-8"?>)
+        puts %(<testsuite name="erblint" tests="#{@stats.processed_files.size}" failures="#{@stats.found}">)
 
-        xml
-      end
-
-      def create_testsuite_element
-        tests = stats.processed_files.size
-        failures = stats.found
-        testsuite_element = REXML::Element.new("testsuite", nil, CONTEXT)
-        testsuite_element.add_attribute("name", "erblint")
-        testsuite_element.add_attribute("tests", tests.to_s)
-        testsuite_element.add_attribute("failures", failures.to_s)
-
-        testsuite_element.add_element(create_properties)
+        puts %(  <properties>)
+        PROPERTIES.each do |key, value|
+          puts %(    <property name="#{xml_escape(key)}" value="#{xml_escape(value)}"/>)
+        end
+        puts %(  </properties>)
 
         processed_files.each do |filename, offenses|
+          filename_escaped = xml_escape(filename)
           if offenses.empty?
-            testcase_element = REXML::Element.new("testcase", nil, CONTEXT)
-            testcase_element.add_attribute("name", filename.to_s)
-            testcase_element.add_attribute("file", filename.to_s)
-
-            testsuite_element.add_element(testcase_element)
-          end
-
-          offenses.each do |offense|
-            testsuite_element.add_element(create_testcase(filename, offense))
+            puts %(  <testcase name="#{filename_escaped}" file="#{filename_escaped}"/>)
+          else
+            offenses.each do |offense|
+              type = offense.simple_name
+              message = "#{type}: #{offense.message}"
+              body = "#{message} at #{filename}:#{offense.line_number}:#{offense.column}"
+
+              puts %(  <testcase name="#{filename_escaped}" file="#{filename_escaped}" lineno="#{offense.line_number}">)
+              puts %(    <failure message="#{xml_escape(message)}" type="#{xml_escape(type)}">)
+              puts %(      #{xml_escape(body)})
+              puts %(    </failure>)
+              puts %(  </testcase>)
+            end
           end
         end
 
-        testsuite_element
+        puts %(</testsuite>)
       end
 
-      def create_properties
-        properties_element = REXML::Element.new("properties", nil, CONTEXT)
-
-        [
-          ["erb_lint_version", ERBLint::VERSION],
-          ["ruby_engine", RUBY_ENGINE],
-          ["ruby_version", RUBY_VERSION],
-          ["ruby_patchlevel", RUBY_PATCHLEVEL.to_s],
-          ["ruby_platform", RUBY_PLATFORM],
-        ].each do |property_attribute|
-          properties_element.add_element(create_property(*property_attribute))
-        end
-
-        properties_element
-      end
-
-      def create_property(name, value)
-        property_element = REXML::Element.new("property")
-        property_element.add_attribute("name", name)
-        property_element.add_attribute("value", value)
-
-        property_element
-      end
-
-      def create_testcase(filename, offense)
-        testcase_element = REXML::Element.new("testcase", nil, CONTEXT)
-        testcase_element.add_attribute("name", filename.to_s)
-        testcase_element.add_attribute("file", filename.to_s)
-        testcase_element.add_attribute("lineno", offense.line_number.to_s)
-
-        testcase_element.add_element(create_failure(filename, offense))
-
-        testcase_element
-      end
-
-      def create_failure(filename, offense)
-        message = offense.message
-        type = offense.simple_name
-
-        failure_element = REXML::Element.new("failure", nil, CONTEXT)
-        failure_element.add_attribute("message", "#{type}: #{message}")
-        failure_element.add_attribute("type", type.to_s)
-
-        cdata_element = REXML::CData.new("#{type}: #{message} at #{filename}:#{offense.line_number}:#{offense.column}")
-        failure_element.add_text(cdata_element)
+      private
 
-        failure_element
+      def xml_escape(string)
+        string.gsub(Regexp.union(ESCAPE_MAP.keys), ESCAPE_MAP)
       end
     end
   end

data/lib/erb_lint/reporters/multiline_reporter.rb

@@ -8,9 +8,14 @@ module ERBLint
       private
 
       def format_offense(filename, offense)
+        details = "#{offense.message}#{Rainbow(" (not autocorrected)").red if autocorrect}"
+        if show_linter_names
+          details = "[#{offense.simple_name}] " + details
+        end
+
         <<~EOF
 
-          #{offense.message}#{Rainbow(" (not autocorrected)").red if autocorrect}
+          #{details}
           In file: #{filename}:#{offense.line_number}
         EOF
       end

data/lib/erb_lint/runner.rb

@@ -57,7 +57,7 @@ module ERBLint
       if no_unused_disable_enabled? && enable_inline_configs?
         @no_unused_disable = ERBLint::Linters::NoUnusedDisable.new(
           @file_loader,
-          @config.for_linter(ERBLint::Linters::NoUnusedDisable)
+          @config.for_linter(ERBLint::Linters::NoUnusedDisable),
         )
         @no_unused_disable.run(processed_source, @offenses)
         @offenses.concat(@no_unused_disable.offenses)

data/lib/erb_lint/runner_config_resolver.rb

@@ -37,7 +37,7 @@ 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"])
         Array(config_path).reverse_each do |path|

data/lib/erb_lint/utils/block_map.rb

@@ -60,7 +60,7 @@ module ERBLint
         end
 
         def inspect
-          "\#<#{self.class.name} type=#{type.inspect} nodes=#{nodes.inspect}>"
+          "#<#{self.class.name} type=#{type.inspect} nodes=#{nodes.inspect}>"
         end
 
         def &(other)
@@ -102,7 +102,7 @@ module ERBLint
             node.type,
             extract_map_locations(node)
               .map { |loc| find_entry(loc) }
-              .compact.map(&:node)
+              .compact.map(&:node),
           )
         end
 
@@ -111,7 +111,7 @@ module ERBLint
             :begin,
             (extract_map_locations(node) + rescue_locations(node))
               .map { |loc| find_entry(loc) }
-              .compact.map(&:node)
+              .compact.map(&:node),
           )
         end
 
@@ -120,7 +120,7 @@ module ERBLint
             node.type,
             (extract_map_locations(node) + when_locations(node))
               .map { |loc| find_entry(loc) }
-              .compact.map(&:node)
+              .compact.map(&:node),
           )
         end
 

data/lib/erb_lint/utils/offset_corrector.rb

@@ -42,15 +42,12 @@ module ERBLint
         range = to_range(node_or_range)
 
         @processed_source.to_source_range(
-          bound(@offset + range.begin_pos)..bound(@offset + (range.end_pos - 1))
+          bound(@offset + range.begin_pos)..bound(@offset + (range.end_pos - 1)),
         )
       end
 
       def bound(pos)
-        [
-          [pos, @bound_range.min].max,
-          @bound_range.max,
-        ].min
+        pos.clamp(@bound_range.min, @bound_range.max)
       end
 
       private

data/lib/erb_lint/utils/severity_levels.rb

@@ -5,8 +5,14 @@ module ERBLint
     module SeverityLevels
       SEVERITY_NAMES = [:info, :refactor, :convention, :warning, :error, :fatal].freeze
 
-      SEVERITY_CODE_TABLE = { I: :info, R: :refactor, C: :convention,
-                              W: :warning, E: :error, F: :fatal, }.freeze
+      SEVERITY_CODE_TABLE = {
+        I: :info,
+        R: :refactor,
+        C: :convention,
+        W: :warning,
+        E: :error,
+        F: :fatal,
+      }.freeze
 
       def severity_level_for_name(name)
         SEVERITY_NAMES.index(name || :error) + 1

data/lib/erb_lint/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ERBLint
-  VERSION = "0.5.0"
+  VERSION = "0.7.0"
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: erb_lint
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Justin Chan
 - Shopify Developers
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-08-25 00:00:00.000000000 Z
+date: 2024-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -73,14 +73,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: smart_properties
   requirement: !ruby/object:Gem::Requirement
@@ -141,10 +141,12 @@ description: ERB Linter tool.
 email:
 - ruby@shopify.com
 executables:
+- erb_lint
 - erblint
 extensions: []
 extra_rdoc_files: []
 files:
+- exe/erb_lint
 - exe/erblint
 - lib/erb_lint.rb
 - lib/erb_lint/all.rb
@@ -182,6 +184,7 @@ files:
 - lib/erb_lint/processed_source.rb
 - lib/erb_lint/reporter.rb
 - lib/erb_lint/reporters/compact_reporter.rb
+- lib/erb_lint/reporters/gitlab_reporter.rb
 - lib/erb_lint/reporters/json_reporter.rb
 - lib/erb_lint/reporters/junit_reporter.rb
 - lib/erb_lint/reporters/multiline_reporter.rb
@@ -195,12 +198,12 @@ files:
 - lib/erb_lint/utils/ruby_to_erb.rb
 - lib/erb_lint/utils/severity_levels.rb
 - lib/erb_lint/version.rb
-homepage: https://github.com/Shopify/erb-lint
+homepage: https://github.com/Shopify/erb_lint
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -215,8 +218,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.18
-signing_key: 
+rubygems_version: 3.5.21
+signing_key:
 specification_version: 4
 summary: ERB lint tool
 test_files: []