rubocop-md 1.2.1 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e4b62aa5ac22f5dd82b132acd7439582c1d7e4a925d8a44cfeb48f250d579aa
-  data.tar.gz: 5acca30ab4a740b8bb9fdd25bd1b769f96504a63c8f6e4d3460ddfe61c66dbcf
+  metadata.gz: c7c6dbb228497df06f33f4c2c5f91b9fc719aa1026428b8ca86e596f4658ffcb
+  data.tar.gz: c42e2dea6fe018ec5e0f23dd39caeaff927408729ee69c911f7220446017d1c0
 SHA512:
-  metadata.gz: eb68e5947593be1fce3b2c7131d7a445615b3a9a47c86db9e5b5e31ba966e0c4f7030c20578e140cfe1f55b824e1224a6a2ef3206317db51fa7bd89b60d93e52
-  data.tar.gz: '0138f08797108912f2fdcc4b68fbff18e1def69a35a133d94a4cdc409f1a12f695ca8d155df4f3349fa99da0a551b9863a47e61b9984609ef2d815e553969a20'
+  metadata.gz: d3a4dd5d3e3eb894db690a40f699303f4350664516cd83475127786e8348086b0e23d8209fb2187aa0df33e287f4a6f72f840efe7b9dc7214b0113180299e59f
+  data.tar.gz: 5cd2b8c3675fd5fa84676c00d75ce2872dbc193ab4f55fc01283450c5bc3ad3774c80156b712332db467585baa8e3913064f5c14095102eb2bb979b572e1e51e

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 ## master (unreleased)
 
+## 1.2.3 (2024-09-12)
+
+- Do no try linting `.mdx` files by default.
+
+## 1.2.2 (2023-12-01) ❄️
+
+- Fix analyzing code blocks with backticks.
+
 ## 1.2.1 (2023-10-20)
 
 - Fix incompatibility when loading the plugin from YAML and using other RuboCop options.

data/README.md

@@ -1,5 +1,5 @@
 [![Gem Version](https://badge.fury.io/rb/rubocop-md.svg)](http://badge.fury.io/rb/rubocop-md)
-![Test](https://github.com/rubocop-hq/rubocop-md/workflows/Test/badge.svg)
+![Test](https://github.com/rubocop/rubocop-md/workflows/Test/badge.svg)
 
 # Rubocop Markdown
 
@@ -158,7 +158,7 @@ To install this gem onto your local machine, run `bundle exec rake install`.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/rubocop-hq/rubocop-md.
+Bug reports and pull requests are welcome on GitHub at https://github.com/rubocop/rubocop-md.
 
 ## License
 

data/config/default.yml

@@ -1,111 +1,86 @@
+inherit_mode:
+  merge:
+    - Include
+    - Exclude
+
 Markdown:
   WarnInvalid: true
   Autodetect: true
 
-Layout/CommentIndentation:
-  Exclude:
-    - '**/*.md'
-    - '**/*.markdown'
+# Keep in sync with MARKDOWN_EXTENSIONS
+Layout/CommentIndentation: &markdown_excludes
+  Exclude:
+    - "**/*.md"
+    - "**/*.livemd"
+    - "**/*.markdown"
+    - "**/*.mdown"
+    - "**/*.mdwn"
+    - "**/*.mkd"
+    - "**/*.mkdn"
+    - "**/*.mkdown"
+    - "**/*.ronn"
+    - "**/*.scd"
+    - "**/*.workbook"
 
 Layout/LeadingCommentSpace:
-  Exclude:
-    - '**/*.md'
-    - '**/*.markdown'
+  <<: *markdown_excludes
 
 Layout/TrailingBlankLines:
-  Exclude:
-    - '**/*.md'
-    - '**/*.markdown'
+  <<: *markdown_excludes
 
 Layout/TrailingEmptyLines:
-  Exclude:
-    - '**/*.md'
-    - '**/*.markdown'
+  <<: *markdown_excludes
 
 Layout/EmptyLineBetweenDefs:
-  Exclude:
-    - '**/*.md'
-    - '**/*.markdown'
+  <<: *markdown_excludes
 
 Lint/DuplicateRequire:
-  Exclude:
-    - '**/*.md'
-    - '**/*.markdown'
+  <<: *markdown_excludes
 
 Lint/DuplicateMethods:
-  Exclude:
-    - '**/*.md'
-    - '**/*.markdown'
+  <<: *markdown_excludes
 
 Lint/RedundantCopDisableDirective:
-  Exclude:
-    - '**/*.md'
-    - '**/*.markdown'
+  <<: *markdown_excludes
 
 Lint/RedundantCopEnableDirective:
-  Exclude:
-    - '**/*.md'
-    - '**/*.markdown'
+  <<: *markdown_excludes
 
 Lint/RedundantRequireStatement:
-  Exclude:
-    - '**/*.md'
-    - '**/*.markdown'
+  <<: *markdown_excludes
 
 Lint/UnusedMethodArgument:
-  Exclude:
-    - '**/*.md'
-    - '**/*.markdown'
+  <<: *markdown_excludes
 
 Lint/UnusedBlockArgument:
-  Exclude:
-    - '**/*.md'
-    - '**/*.markdown'
+  <<: *markdown_excludes
 
 Lint/UselessAssignment:
-  Exclude:
-    - '**/*.md'
-    - '**/*.markdown'
+  <<: *markdown_excludes
 
 Lint/UselessMethodDefinition:
-  Exclude:
-    - '**/*.md'
-    - '**/*.markdown'
+  <<: *markdown_excludes
 
 Lint/UselessAccessModifier:
-  Exclude:
-    - '**/*.md'
-    - '**/*.markdown'
+  <<: *markdown_excludes
 
 Lint/Void:
-  Exclude:
-    - '**/*.md'
-    - '**/*.markdown'
+  <<: *markdown_excludes
 
 Naming/FileName:
-  Exclude:
-    - '**/*.md'
-    - '**/*.markdown'
+  <<: *markdown_excludes
 
 Style/AsciiComments:
-  Exclude:
-    - '**/*.md'
-    - '**/*.markdown'
+  <<: *markdown_excludes
 
 Style/Documentation:
-  Exclude:
-    - '**/*.md'
-    - '**/*.markdown'
+  <<: *markdown_excludes
 
 Style/CommentAnnotation:
-  Exclude:
-    - '**/*.md'
-    - '**/*.markdown'
+  <<: *markdown_excludes
 
 Style/FrozenStringLiteralComment:
-  Exclude:
-    - '**/*.md'
-    - '**/*.markdown'
+  <<: *markdown_excludes
 
 Layout/LineLength:
   IgnoredPatterns:

data/lib/rubocop/markdown/preprocess.rb

@@ -7,12 +7,18 @@ module RuboCop
     # Transform source Markdown file into valid Ruby file
     # by commenting out all non-code lines
     class Preprocess
-      # This is a regexp to extract code blocks from .md files.
+      # This is a regexp to parse code blocks from .md files.
       #
       # Only recognizes backticks-style code blocks.
       #
       # Try it: https://rubular.com/r/YMqSWiBuh2TKIJ
-      MD_REGEXP = /^([ \t]*`{3,4})([\w[[:blank:]]+]*\n)([\s\S]+?)(^[ \t]*\1[[:blank:]]*\n?)/m.freeze
+      MD_REGEXP = /
+        ^([[:blank:]]*`{3,4}) # Match opening backticks
+        ([\w[[:blank:]]+]*)?\n # Match the code block syntax
+        ([\s\S]+?) # Match everything inside the code block
+        (^[[:blank:]]*\1[[:blank:]]*\n?) # Match closing backticks
+        |(^.*$) # If we are not in a codeblock, match the whole line
+      /x.freeze
 
       MARKER = "<--rubocop/md-->"
 
@@ -26,26 +32,6 @@ module RuboCop
         rbx
       ].freeze
 
-      class Walker # :nodoc:
-        STEPS = %i[text code_start code_attr code_body code_end].freeze
-
-        STEPS.each do |step|
-          define_method("#{step}?") do
-            STEPS[current_step] == step
-          end
-        end
-
-        attr_accessor :current_step
-
-        def initialize
-          @current_step = 0
-        end
-
-        def next!
-          self.current_step = current_step == (STEPS.size - 1) ? 0 : current_step + 1
-        end
-      end
-
       class << self
         # Revert preprocess changes.
         #
@@ -53,11 +39,15 @@ module RuboCop
         # using preproccessed source buffer.
         #
         # We have to restore it.
-        def restore!(file)
+        def restore_and_save!(file)
           contents = File.read(file)
-          contents.gsub!(/^##{MARKER}/m, "")
+          restore!(contents)
           File.write(file, contents)
         end
+
+        def restore!(src)
+          src.gsub!(/^##{MARKER}/m, "")
+        end
       end
 
       attr_reader :config
@@ -68,31 +58,34 @@ module RuboCop
 
       # rubocop:disable Metrics/MethodLength
       def call(src)
-        parts = src.split(MD_REGEXP)
-
-        walker = Walker.new
-
-        parts.each do |part|
-          if walker.code_body? && maybe_ruby?(@syntax) && valid_syntax?(@syntax, part)
-            next walker.next!
+        src.gsub(MD_REGEXP) do |full_match|
+          m = Regexp.last_match
+          open_backticks = m[1]
+          syntax = m[2]
+          code = m[3]
+          close_backticks = m[4]
+          markdown = m[5]
+
+          if markdown
+            # We got markdown outside of a codeblock
+            comment_lines(markdown)
+          elsif ruby_codeblock?(syntax, code)
+            # The codeblock we parsed is assumed ruby, keep as is and append markers to backticks
+            "#{comment_lines(open_backticks + syntax)}\n#{code}#{comment_lines(close_backticks)}"
+          else
+            # The codeblock is not relevant, comment it out
+            comment_lines(full_match)
           end
-
-          if walker.code_attr?
-            @syntax = part.gsub(/(^\s+|\s+$)/, "")
-            next walker.next!
-          end
-
-          comment_lines! part
-
-          walker.next!
         end
-
-        parts.join
       end
       # rubocop:enable Metrics/MethodLength
 
       private
 
+      def ruby_codeblock?(syntax, src)
+        maybe_ruby?(syntax) && valid_syntax?(syntax, src)
+      end
+
       # Check codeblock attribute to prevent from parsing
       # non-Ruby snippets and avoid false positives
       def maybe_ruby?(syntax)
@@ -124,10 +117,8 @@ module RuboCop
         config["Markdown"]&.fetch("Autodetect", true)
       end
 
-      def comment_lines!(src)
-        return if src =~ /\A\n\z/
-
-        src.gsub!(/^(.)/m, "##{MARKER}\\1")
+      def comment_lines(src)
+        src.gsub(/^/, "##{MARKER}")
       end
     end
   end

data/lib/rubocop/markdown/rubocop_ext.rb

@@ -2,21 +2,25 @@
 
 module RuboCop
   module Markdown # :nodoc:
-    # According to Linguist.
-    # See https://github.com/github/linguist/blob/96ca71ab99c2f9928d5d69f4c08fd2a51440d045/lib/linguist/languages.yml#L3065-L3083
+    # See https://github.com/github-linguist/linguist/blob/8c380f360ce00b95fa08d14ce0ebccd481af1b33/lib/linguist/languages.yml#L4088-L4098
+    # Keep in sync with config/default.yml
     MARKDOWN_EXTENSIONS = %w[
       .md
+      .livemd
       .markdown
       .mdown
       .mdwn
-      .mdx
       .mkd
       .mkdn
       .mkdown
       .ronn
+      .scd
       .workbook
     ].freeze
 
+    # A list of cops that could produce offenses in commented lines
+    MARKDOWN_OFFENSE_COPS = %w[Lint/Syntax].freeze
+
     class << self
       attr_accessor :config_store
 
@@ -56,25 +60,29 @@ RuboCop::Runner.prepend(Module.new do
     super
   end
 
-  def inspect_file(*args)
-    super.tap do |(offenses, *)|
-      # Skip offenses reported for ignored MD source (trailing whitespaces, etc.)
-      marker_comment = "##{RuboCop::Markdown::Preprocess::MARKER}"
-      offenses.reject! do |offense|
-        offense.location.source_line.start_with?(marker_comment)
-      end
-    end
-  end
-
   def file_finished(file, offenses)
     return super unless RuboCop::Markdown.markdown_file?(file)
 
     # Run Preprocess.restore if file has been autocorrected
     if @options[:auto_correct] || @options[:autocorrect]
-      RuboCop::Markdown::Preprocess.restore!(file)
+      RuboCop::Markdown::Preprocess.restore_and_save!(file)
     end
 
-    super(file, offenses)
+    super
+  end
+end)
+
+RuboCop::Cop::Commissioner::InvestigationReport.prepend(Module.new do
+  # Skip offenses reported for ignored MD source (trailing whitespaces, etc.)
+  def offenses
+    @offenses ||= begin
+      marker_comment = "##{RuboCop::Markdown::Preprocess::MARKER}"
+      offenses_per_cop.flatten(1).reject do |offense|
+        next if RuboCop::Markdown::MARKDOWN_OFFENSE_COPS.include?(offense.cop_name)
+
+        offense.location.source_line.start_with?(marker_comment)
+      end
+    end
   end
 end)
 
@@ -91,6 +99,6 @@ RuboCop::ProcessedSource.prepend(Module.new do
     # only process Markdown files
     src = RuboCop::Markdown::Preprocess.new(path).call(src) if
       path && RuboCop::Markdown.markdown_file?(path)
-    super(src, *args)
+    super
   end
 end)

data/lib/rubocop/markdown/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Markdown
-    VERSION = "1.2.1"
+    VERSION = "1.2.3"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-md
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.3
 platform: ruby
 authors:
 - Vladimir Dementyev
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-10-21 00:00:00.000000000 Z
+date: 2024-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.45'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.45'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -83,16 +83,16 @@ files:
 - lib/rubocop/markdown/preprocess.rb
 - lib/rubocop/markdown/rubocop_ext.rb
 - lib/rubocop/markdown/version.rb
-homepage: https://github.com/rubocop-hq/rubocop-md
+homepage: https://github.com/rubocop/rubocop-md
 licenses:
 - MIT
 metadata:
-  bug_tracker_uri: http://github.com/rubocop-hq/rubocop-md/issues
-  changelog_uri: https://github.com/rubocop-hq/rubocop-md/blob/master/CHANGELOG.md
-  documentation_uri: https://github.com/rubocop-hq/rubocop-md/blob/master/README.md
-  homepage_uri: https://github.com/rubocop-hq/rubocop-md
-  source_code_uri: http://github.com/rubocop-hq/rubocop-md
-post_install_message:
+  bug_tracker_uri: http://github.com/rubocop/rubocop-md/issues
+  changelog_uri: https://github.com/rubocop/rubocop-md/blob/master/CHANGELOG.md
+  documentation_uri: https://github.com/rubocop/rubocop-md/blob/master/README.md
+  homepage_uri: https://github.com/rubocop/rubocop-md
+  source_code_uri: http://github.com/rubocop/rubocop-md
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -107,8 +107,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.20
-signing_key:
+rubygems_version: 3.4.19
+signing_key: 
 specification_version: 4
 summary: Run Rubocop against your Markdown files to make sure that code examples follow
   style guidelines.