slim_lint 0.18.0 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 986eec7f82b19dc099ffdc1b39569f7dfde2eb01243dbcebe7ad13d36366a566
-  data.tar.gz: 1543d58c24572178d4bd0cfe025a350619fb9fd1a3a0407efa79b1b9ed830d1f
+  metadata.gz: ecb7c8e4610ab75806023562750e2ef68bfd0b9457403297a22773af85951935
+  data.tar.gz: ad04da9dd32582ab42c290c85628f391e88a4f8a1eae83ef4d6ad3695d88f1bb
 SHA512:
-  metadata.gz: 82d91f68c230e4e5af4a6b6c3d439dc06816fdce4e258e890bfedbcb2682b8987ee7eed1c41b6b2c0fda63370f25675152d0d4ac0a55287d2706b3b24af55b77
-  data.tar.gz: c4c07a3f6623fba5162b1e9f9bcbf358b6dbc37e500916980289c3022f0627a41da8268406b90d4fb2d768324729d0129c1afd1a8d40990572d2fe87a799422b
+  metadata.gz: ecda5be7f9b2adf7fd5e06d78449df876037953b34a07c658bf999b13af8d4d322afbc4779ac62654e9887c8d9b6621ce224b215871c842cb9fe25c92eb2e769
+  data.tar.gz: bfd2cfa1794ff5406ac546f66013985cc809ec4c5136d04d6a99e12994e7c4e0ea2876f69067239b6e9aa3f6c2ea96031d1ce4e882bd099b2efdb6531b2786ba

data/config/default.yml

@@ -18,6 +18,10 @@ linters:
   ControlStatementSpacing:
     enabled: true
 
+  EmbeddedEngines:
+    enabled: false
+    forbidden_engines: []
+
   EmptyControlStatement:
     enabled: true
 
@@ -42,16 +46,18 @@ linters:
     # WARNING: If you define this list in your own .slim-lint.yml file, you'll
     # be overriding the list defined here.
     ignored_cops:
-      - Layout/AlignArguments
-      - Layout/AlignArray
-      - Layout/AlignHash
-      - Layout/AlignParameters
+      - Layout/ArgumentAlignment
+      - Layout/ArrayAlignment
+      - Layout/BlockAlignment
       - Layout/EmptyLineAfterGuardClause
+      - Layout/EndAlignment
+      - Layout/FirstArrayElementIndentation
       - Layout/FirstParameterIndentation
-      - Layout/IndentArray
+      - Layout/HashAlignment
       - Layout/IndentationConsistency
       - Layout/IndentationWidth
       - Layout/InitialIndentation
+      - Layout/LineLength
       - Layout/MultilineArrayBraceLayout
       - Layout/MultilineAssignmentLayout
       - Layout/MultilineHashBraceLayout
@@ -59,18 +65,18 @@ linters:
       - Layout/MultilineMethodCallIndentation
       - Layout/MultilineMethodDefinitionBraceLayout
       - Layout/MultilineOperationIndentation
-      - Layout/TrailingBlankLines
+      - Layout/ParameterAlignment
+      - Layout/TrailingEmptyLines
       - Layout/TrailingWhitespace
-      - Lint/BlockAlignment
-      - Lint/EndAlignment
       - Lint/Void
       - Metrics/BlockLength
       - Metrics/BlockNesting
-      - Metrics/LineLength
       - Naming/FileName
       - Style/FrozenStringLiteralComment
+      - Style/IdenticalConditionalBranches
       - Style/IfUnlessModifier
       - Style/Next
+      - Style/WhileUntilDo
       - Style/WhileUntilModifier
 
   Tab:

data/lib/slim_lint.rb

@@ -19,7 +19,7 @@ require 'slim_lint/logger'
 require 'slim_lint/version'
 
 # Load all filters (required by SlimLint::Engine)
-Dir[File.expand_path('slim_lint/filters/*.rb', File.dirname(__FILE__))].each do |file|
+Dir[File.expand_path('slim_lint/filters/*.rb', File.dirname(__FILE__))].sort.each do |file|
   require file
 end
 
@@ -37,16 +37,16 @@ require 'slim_lint/runner'
 
 # Load all matchers
 require 'slim_lint/matcher/base'
-Dir[File.expand_path('slim_lint/matcher/*.rb', File.dirname(__FILE__))].each do |file|
+Dir[File.expand_path('slim_lint/matcher/*.rb', File.dirname(__FILE__))].sort.each do |file|
   require file
 end
 
 # Load all linters
-Dir[File.expand_path('slim_lint/linter/*.rb', File.dirname(__FILE__))].each do |file|
+Dir[File.expand_path('slim_lint/linter/*.rb', File.dirname(__FILE__))].sort.each do |file|
   require file
 end
 
 # Load all reporters
-Dir[File.expand_path('slim_lint/reporter/*.rb', File.dirname(__FILE__))].each do |file|
+Dir[File.expand_path('slim_lint/reporter/*.rb', File.dirname(__FILE__))].sort.each do |file|
   require file
 end

data/lib/slim_lint/cli.rb

@@ -3,11 +3,18 @@
 require 'slim_lint'
 require 'slim_lint/options'
 
-require 'sysexits'
-
 module SlimLint
   # Command line application interface.
   class CLI # rubocop:disable Metrics/ClassLength
+    # Exit codes
+    # @see https://man.openbsd.org/sysexits.3
+    EX_OK = 0
+    EX_USAGE = 64
+    EX_DATAERR = 65
+    EX_NOINPUT = 67
+    EX_SOFTWARE = 70
+    EX_CONFIG = 78
+
     # Create a CLI that outputs to the specified logger.
     #
     # @param logger [SlimLint::Logger]
@@ -39,16 +46,16 @@ module SlimLint
 
       if options[:help]
         print_help(options)
-        Sysexits::EX_OK
+        EX_OK
       elsif options[:version] || options[:verbose_version]
         print_version(options)
-        Sysexits::EX_OK
+        EX_OK
       elsif options[:show_linters]
         print_available_linters
-        Sysexits::EX_OK
+        EX_OK
       elsif options[:show_reporters]
         print_available_reporters
-        Sysexits::EX_OK
+        EX_OK
       else
         scan_for_lints(options)
       end
@@ -60,20 +67,20 @@ module SlimLint
       case exception
       when SlimLint::Exceptions::ConfigurationError
         log.error exception.message
-        Sysexits::EX_CONFIG
+        EX_CONFIG
       when SlimLint::Exceptions::InvalidCLIOption
         log.error exception.message
         log.log "Run `#{APP_NAME}` --help for usage documentation"
-        Sysexits::EX_USAGE
+        EX_USAGE
       when SlimLint::Exceptions::InvalidFilePath
         log.error exception.message
-        Sysexits::EX_NOINPUT
+        EX_NOINPUT
       when SlimLint::Exceptions::NoLintersError
         log.error exception.message
-        Sysexits::EX_NOINPUT
+        EX_NOINPUT
       else
         print_unexpected_exception(exception)
-        Sysexits::EX_SOFTWARE
+        EX_SOFTWARE
       end
     end
 
@@ -83,7 +90,7 @@ module SlimLint
     def scan_for_lints(options)
       report = Runner.new.run(options)
       print_report(report, options)
-      report.failed? ? Sysexits::EX_DATAERR : Sysexits::EX_OK
+      report.failed? ? EX_DATAERR : EX_OK
     end
 
     # Outputs a report of the linter run using the specified reporter.

data/lib/slim_lint/file_finder.rb

@@ -38,7 +38,7 @@ module SlimLint
     #
     # @param patterns [Array<String>]
     # @return [Array<String>]
-    def extract_files_from(patterns) # rubocop:disable MethodLength
+    def extract_files_from(patterns) # rubocop:disable Metrics/MethodLength
       files = []
 
       patterns.each do |pattern|

data/lib/slim_lint/linter/control_statement_spacing.rb

@@ -9,7 +9,6 @@ module SlimLint
 
     on [:html, :tag, anything, [],
          [:slim, :output, anything, capture(:ruby, anything)]] do |sexp|
-
       # Fetch original Slim code that contains an element with a control statement.
       line = document.source_lines[sexp.line() - 1]
 

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)]
       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.18.0'
+  VERSION = '0.21.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slim_lint
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.21.0
 platform: ruby
 authors:
 - Shane da Silva
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-10-10 00:00:00.000000000 Z
+date: 2021-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.50.0
+        version: 0.78.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.50.0
+        version: 0.78.0
 - !ruby/object:Gem::Dependency
   name: slim
   requirement: !ruby/object:Gem::Requirement
@@ -44,20 +44,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '5.0'
-- !ruby/object:Gem::Dependency
-  name: sysexits
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -118,6 +104,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
@@ -141,6 +128,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
@@ -154,7 +142,7 @@ homepage: https://github.com/sds/slim-lint
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -169,8 +157,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Slim template linting tool
 test_files: []