slim_lint 0.20.1 → 0.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70c5fb4937778a7f451600310d934305853a938b8bf08df3e3c08b28f680b2a4
-  data.tar.gz: a1b2e962a79cf35c060768d562997e04bb0835a8d474cd1c85b54c22c98b3af7
+  metadata.gz: 7405eb29d09bb96a9c1f50007d6734f69a2abfea213bddbd9cadd15e7ac99651
+  data.tar.gz: 1e55ce9b3466a9232a52a8a70ff7d4c8b31584f7bf06805d18c6965887935210
 SHA512:
-  metadata.gz: d0105fb2ef8ba6551b8a98f55677d939f922405150477cdaff62118caabb8d99f1c07426283e590e9ffb6fc9098bdd01c4214db612659f37fb4a087dd506836a
-  data.tar.gz: 8559c4cf8e7850a11657b9cffa9ff09fa6c08c4283f33638f7b604c63859ac24c52ff9c8e3366c7900a678240ae5876d71eb58de2bd2a8853138ec4e7a56af30
+  metadata.gz: a163d473bb03269ecd4a648c992219e2e26b2bd06948d8bf7b660b54d6eceb9d2c4b675c807676c1aa1122d40a4929d125bdc587b956660dcde0b8b1cc9f3f95
+  data.tar.gz: 04405a47e956df8d2be5ea0520e411ddfc3da5f0c2bf498649d0d8268d1fe97cadf96384875975836e72454bc8c0157c5b1da52e631194d5c15fd69bacc89484

data/config/default.yml

@@ -18,6 +18,10 @@ linters:
   ControlStatementSpacing:
     enabled: true
 
+  EmbeddedEngines:
+    enabled: false
+    forbidden_engines: []
+
   EmptyControlStatement:
     enabled: true
 
@@ -47,12 +51,14 @@ linters:
       - Layout/BlockAlignment
       - Layout/EmptyLineAfterGuardClause
       - Layout/EndAlignment
+      - Layout/FirstArgumentIndentation
       - Layout/FirstArrayElementIndentation
       - Layout/FirstParameterIndentation
       - Layout/HashAlignment
       - Layout/IndentationConsistency
       - Layout/IndentationWidth
       - Layout/InitialIndentation
+      - Layout/LineEndStringConcatenationIndentation
       - Layout/LineLength
       - Layout/MultilineArrayBraceLayout
       - Layout/MultilineAssignmentLayout
@@ -72,6 +78,7 @@ linters:
       - Style/IdenticalConditionalBranches
       - Style/IfUnlessModifier
       - Style/Next
+      - Style/WhileUntilDo
       - Style/WhileUntilModifier
 
   Tab:

data/lib/slim_lint/linter.rb

@@ -49,6 +49,8 @@ module SlimLint
     # @param node [#line] node to extract the line number from
     # @param message [String] error/warning to display to the user
     def report_lint(node, message)
+      return if disabled_for_line?(node.line)
+
       @lints << SlimLint::Lint.new(self, @document.file, node.line, message)
     end
 
@@ -60,5 +62,32 @@ module SlimLint
       @ruby_parser ||= SlimLint::RubyParser.new
       @ruby_parser.parse(source)
     end
+
+    def disabled_for_line?(line)
+      disabled_lines.include?(line)
+    end
+
+    def disabled_lines
+      @disabled_lines ||= begin
+        currently_disabled = false
+        @document.source_lines.each_with_index.reduce([]) do |lines, pair|
+          line = pair[0]
+          line_number = pair[1] + 1
+
+          if line =~ %r{/ slim-lint:disable #{linter_name}}
+            currently_disabled = true
+          elsif line =~ %r{/ slim-lint:enable #{linter_name}}
+            currently_disabled = false
+          elsif currently_disabled
+            lines << line_number
+          end
+          lines
+        end
+      end
+    end
+
+    def linter_name
+      @linter_name ||= self.class.name.split('::').last
+    end
   end
 end

data/lib/slim_lint/linter/embedded_engines.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module SlimLint
+  # Checks for forbidden embedded engines.
+  class Linter::EmbeddedEngines < Linter
+    include LinterRegistry
+
+    MESSAGE = 'Forbidden embedded engine `%s` found'
+
+    on_start do |_sexp|
+      forbidden_engines = config['forbidden_engines']
+      dummy_node = Struct.new(:line)
+      document.source_lines.each_with_index do |line, index|
+        forbidden_engines.each do |forbidden_engine|
+          next unless line =~ /^#{forbidden_engine}.*:\s*$/
+
+          report_lint(dummy_node.new(index + 1), MESSAGE % forbidden_engine)
+        end
+      end
+    end
+  end
+end

data/lib/slim_lint/options.rb

@@ -73,6 +73,11 @@ module SlimLint
                 'List of file names to exclude') do |files|
         @options[:excluded_files] = files
       end
+
+      parser.on('--stdin-file-path file', String,
+                'Pipe source from STDIN, using file in offense reports.') do |file|
+        @options[:stdin_file_path] = file
+      end
     end
 
     # Register informational flags.

data/lib/slim_lint/reporter/emacs_reporter.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module SlimLint
+  # Outputs lints in format: {filename}:{line}:{column}: {kind}: {message}.
+  class Reporter::EmacsReporter < Reporter
+    def display_report(report)
+      sorted_lints = report.lints.sort_by { |l| [l.filename, l.line] }
+
+      sorted_lints.each do |lint|
+        print_location(lint)
+        print_type(lint)
+        print_message(lint)
+      end
+    end
+
+    private
+
+    def print_location(lint)
+      log.info lint.filename, false
+      log.log ':', false
+      log.bold lint.line, false
+      log.log ':', false
+      # TODO: change 1 to column number when linter will have this info.
+      log.bold 1, false
+      log.log ':', false
+    end
+
+    def print_type(lint)
+      if lint.error?
+        log.error ' E: ', false
+      else
+        log.warning ' W: ', false
+      end
+    end
+
+    def print_message(lint)
+      if lint.linter
+        log.success("#{lint.linter.name}: ", false)
+      end
+
+      log.log lint.message
+    end
+  end
+end

data/lib/slim_lint/reporter/json_reporter.rb

@@ -45,6 +45,7 @@ module SlimLint
         location: {
           line: offense.line,
         },
+        linter: offense.linter&.name,
       }
     end
   end

data/lib/slim_lint/runner.rb

@@ -15,13 +15,17 @@ module SlimLint
     # @return [SlimLint::Report] a summary of all lints found
     def run(options = {})
       config = load_applicable_config(options)
-      files = extract_applicable_files(config, options)
-
       linter_selector = SlimLint::LinterSelector.new(config, options)
 
-      lints = files.map do |file|
-        collect_lints(file, linter_selector, config)
-      end.flatten
+      if options[:stdin_file_path].nil?
+        files = extract_applicable_files(config, options)
+        lints = files.map do |file|
+          collect_lints(File.read(file), file, linter_selector, config)
+        end.flatten
+      else
+        files = [options[:stdin_file_path]]
+        lints = collect_lints($stdin.read, options[:stdin_file_path], linter_selector, config)
+      end
 
       SlimLint::Report.new(lints, files)
     end
@@ -49,14 +53,14 @@ module SlimLint
     # @param file [String] path to file to lint
     # @param linter_selector [SlimLint::LinterSelector]
     # @param config [SlimLint::Configuration]
-    def collect_lints(file, linter_selector, config)
+    def collect_lints(file_content, file_name, linter_selector, config)
       begin
-        document = SlimLint::Document.new(File.read(file), file: file, config: config)
+        document = SlimLint::Document.new(file_content, file: file_name, config: config)
       rescue SlimLint::Exceptions::ParseError => e
-        return [SlimLint::Lint.new(nil, file, e.lineno, e.error, :error)]
+        return [SlimLint::Lint.new(nil, file_name, e.lineno, e.error, :error)]
       end
 
-      linter_selector.linters_for_file(file).map do |linter|
+      linter_selector.linters_for_file(file_name).map do |linter|
         linter.run(document)
       end.flatten
     end

data/lib/slim_lint/version.rb

@@ -2,5 +2,5 @@
 
 # Defines the gem version.
 module SlimLint
-  VERSION = '0.20.1'
+  VERSION = '0.22.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slim_lint
 version: !ruby/object:Gem::Version
-  version: 0.20.1
+  version: 0.22.0
 platform: ruby
 authors:
 - Shane da Silva
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-26 00:00:00.000000000 Z
+date: 2021-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -44,6 +44,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -104,6 +118,7 @@ files:
 - lib/slim_lint/linter/comment_control_statement.rb
 - lib/slim_lint/linter/consecutive_control_statements.rb
 - lib/slim_lint/linter/control_statement_spacing.rb
+- lib/slim_lint/linter/embedded_engines.rb
 - lib/slim_lint/linter/empty_control_statement.rb
 - lib/slim_lint/linter/empty_lines.rb
 - lib/slim_lint/linter/file_length.rb
@@ -127,6 +142,7 @@ files:
 - lib/slim_lint/reporter.rb
 - lib/slim_lint/reporter/checkstyle_reporter.rb
 - lib/slim_lint/reporter/default_reporter.rb
+- lib/slim_lint/reporter/emacs_reporter.rb
 - lib/slim_lint/reporter/json_reporter.rb
 - lib/slim_lint/ruby_extract_engine.rb
 - lib/slim_lint/ruby_extractor.rb
@@ -140,7 +156,7 @@ homepage: https://github.com/sds/slim-lint
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -155,8 +171,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.1
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Slim template linting tool
 test_files: []