erb_lint 0.1.3 → 0.9.0

data/lib/erb_lint/linters/strict_locals.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module ERBLint
+  module Linters
+    # Enforces the use of strict locals in Rails view partial templates.
+    class StrictLocals < Linter
+      include LinterRegistry
+
+      STRICT_LOCALS_REGEX = /\s+locals:\s+\((.*)\)/
+
+      def initialize(file_loader, config)
+        super
+      end
+
+      def run(processed_source)
+        return unless processed_source.filename.match?(%r{(\A|.*/)_[^/\s]*\.html\.erb\z})
+
+        file_content = processed_source.file_content
+        return if file_content.empty?
+
+        strict_locals_node = processed_source.ast.descendants(:erb).find do |erb_node|
+          indicator_node, _, code_node, _ = *erb_node
+
+          indicator_node_str = indicator_node&.deconstruct&.last
+          next unless indicator_node_str == "#"
+
+          code_node_str = code_node&.deconstruct&.last
+
+          code_node_str.match(STRICT_LOCALS_REGEX)
+        end
+
+        unless strict_locals_node
+          add_offense(
+            processed_source.to_source_range(0...processed_source.file_content.size),
+            <<~EOF.chomp,
+              Missing strict locals declaration.
+              Add <%# locals: () %> at the top of the file to enforce strict locals.
+            EOF
+          )
+        end
+      end
+
+      def autocorrect(_processed_source, offense)
+        lambda do |corrector|
+          corrector.insert_before(offense.source_range, "<%# locals: () %>\n")
+        end
+      end
+    end
+  end
+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

@@ -15,12 +15,17 @@ module ERBLint
       @message = message
       @context = context
       @severity = severity
+      @disabled = false
+    end
+
+    def to_cached_offense_hash
+      ERBLint::CachedOffense.new_from_offense(self).to_h
     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
 
@@ -40,8 +45,30 @@ module ERBLint
       line_range.begin
     end
 
+    attr_writer :disabled
+
+    def disabled?
+      @disabled
+    end
+
     def column
       source_range.column
     end
+
+    def simple_name
+      linter.class.simple_name
+    end
+
+    def last_line
+      source_range.last_line
+    end
+
+    def last_column
+      source_range.last_column
+    end
+
+    def length
+      source_range.length
+    end
   end
 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/json_reporter.rb

@@ -56,14 +56,14 @@ module ERBLint
 
       def format_offense(offense)
         {
-          linter: offense.linter.class.simple_name,
+          linter: offense.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,
+            last_line: offense.last_line,
+            last_column: offense.last_column,
+            length: offense.length,
           },
         }
       end

data/lib/erb_lint/reporters/junit_reporter.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+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
+        puts %(<?xml version="1.0" encoding="UTF-8"?>)
+        puts %(<testsuite name="erblint" tests="#{@stats.processed_files.size}" failures="#{@stats.found}">)
+
+        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?
+            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
+
+        puts %(</testsuite>)
+      end
+
+      private
+
+      def xml_escape(string)
+        string.gsub(Regexp.union(ESCAPE_MAP.keys), ESCAPE_MAP)
+      end
+    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

@@ -5,15 +5,19 @@ module ERBLint
   class Runner
     attr_reader :offenses
 
-    def initialize(file_loader, config)
+    def initialize(file_loader, config, disable_inline_configs = false)
       @file_loader = file_loader
       @config = config || RunnerConfig.default
       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? }
+      linter_classes = LinterRegistry.linters.select do |klass|
+        @config.for_linter(klass).enabled? && klass != ERBLint::Linters::NoUnusedDisable
+      end
       @linters = linter_classes.map do |linter_class|
         linter_class.new(@file_loader, @config.for_linter(linter_class))
       end
+      @no_unused_disable = nil
+      @disable_inline_configs = disable_inline_configs
       @offenses = []
     end
 
@@ -21,14 +25,43 @@ module ERBLint
       @linters
         .reject { |linter| linter.excludes_file?(processed_source.filename) }
         .each do |linter|
-        linter.run(processed_source)
+        linter.run_and_update_offense_status(processed_source, enable_inline_configs?)
         @offenses.concat(linter.offenses)
       end
+      report_unused_disable(processed_source)
+      @offenses = @offenses.reject(&:disabled?)
     end
 
     def clear_offenses
       @offenses = []
       @linters.each(&:clear_offenses)
+      @no_unused_disable&.clear_offenses
+    end
+
+    def restore_offenses(offenses)
+      @offenses.concat(offenses)
+    end
+
+    private
+
+    def enable_inline_configs?
+      !@disable_inline_configs
+    end
+
+    def no_unused_disable_enabled?
+      LinterRegistry.linters.include?(ERBLint::Linters::NoUnusedDisable) &&
+        @config.for_linter(ERBLint::Linters::NoUnusedDisable).enabled?
+    end
+
+    def report_unused_disable(processed_source)
+      if no_unused_disable_enabled? && enable_inline_configs?
+        @no_unused_disable = ERBLint::Linters::NoUnusedDisable.new(
+          @file_loader,
+          @config.for_linter(ERBLint::Linters::NoUnusedDisable),
+        )
+        @no_unused_disable.run(processed_source, @offenses)
+        @offenses.concat(@no_unused_disable.offenses)
+      end
     end
   end
 end

data/lib/erb_lint/runner_config.rb

@@ -63,6 +63,7 @@ module ERBLint
             SpaceInHtmlTag: { enabled: default_enabled },
             TrailingWhitespace: { enabled: default_enabled },
             RequireInputAutocomplete: { enabled: default_enabled },
+            CommentSyntax: { enabled: default_enabled },
           },
         )
       end
@@ -82,7 +83,7 @@ module ERBLint
     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"].concat(global_exclude).uniq! if config_hash["exclude"].is_a?(Array)
       config_hash
     end
 

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/inline_configs.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module ERBLint
+  module Utils
+    class InlineConfigs
+      def self.rule_disable_comment_for_lines?(rule, lines)
+        lines.match?(/# erb_?lint:disable (?<rules>.*#{rule}).*/)
+      end
+
+      def self.disabled_rules(line)
+        line.match(/# erb_?lint:disable (?<rules>.*) %>/)&.named_captures&.fetch("rules")
+      end
+    end
+  end
+end

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.1.3"
+  VERSION = "0.9.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: erb_lint
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.9.0
 platform: ruby
 authors:
 - Justin Chan
-autorequire: 
+- Shopify Developers
 bindir: exe
 cert_chain: []
-date: 2022-06-16 00:00:00.000000000 Z
+date: 2025-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -26,32 +26,18 @@ dependencies:
         version: '0'
 - !ruby/object:Gem::Dependency
   name: better_html
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.0.7
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.0.7
-- !ruby/object:Gem::Dependency
-  name: html_tokenizer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.1
 - !ruby/object:Gem::Dependency
   name: parser
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +72,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
@@ -152,15 +138,19 @@ dependencies:
         version: '0'
 description: ERB Linter tool.
 email:
-- justin.the.c@gmail.com
+- 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
+- lib/erb_lint/cache.rb
+- lib/erb_lint/cached_offense.rb
 - lib/erb_lint/cli.rb
 - lib/erb_lint/corrector.rb
 - lib/erb_lint/file_loader.rb
@@ -169,12 +159,14 @@ files:
 - lib/erb_lint/linter_registry.rb
 - lib/erb_lint/linters/allowed_script_type.rb
 - lib/erb_lint/linters/closing_erb_tag_indent.rb
+- lib/erb_lint/linters/comment_syntax.rb
 - lib/erb_lint/linters/deprecated_classes.rb
 - lib/erb_lint/linters/erb_safety.rb
 - lib/erb_lint/linters/extra_newline.rb
 - lib/erb_lint/linters/final_newline.rb
 - lib/erb_lint/linters/hard_coded_string.rb
 - lib/erb_lint/linters/no_javascript_tag_helper.rb
+- lib/erb_lint/linters/no_unused_disable.rb
 - lib/erb_lint/linters/parser_errors.rb
 - lib/erb_lint/linters/partial_instance_variable.rb
 - lib/erb_lint/linters/require_input_autocomplete.rb
@@ -186,28 +178,30 @@ files:
 - lib/erb_lint/linters/space_around_erb_tag.rb
 - lib/erb_lint/linters/space_in_html_tag.rb
 - lib/erb_lint/linters/space_indentation.rb
+- lib/erb_lint/linters/strict_locals.rb
 - lib/erb_lint/linters/trailing_whitespace.rb
 - lib/erb_lint/offense.rb
 - 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
 - lib/erb_lint/runner.rb
 - lib/erb_lint/runner_config.rb
 - lib/erb_lint/runner_config_resolver.rb
 - lib/erb_lint/stats.rb
 - lib/erb_lint/utils/block_map.rb
-- lib/erb_lint/utils/offset_corrector.rb
+- lib/erb_lint/utils/inline_configs.rb
 - 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: 
 rdoc_options: []
 require_paths:
 - lib
@@ -215,15 +209,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: ERB lint tool
 test_files: []