rubocop-md 1.2.2 → 1.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e1a8d57e542393892dbdf2f9ffd7229d82e1996e900dd33edec55c0b94371ef
-  data.tar.gz: 5503ee8519df1ead15a2ae9602ffc4e960a6d6ddd2d36f32e0dea39c6ac87eef
+  metadata.gz: 62c192c00a24695544108e88c6d66c9de0216457dfb6516731fcdd0d9d456c29
+  data.tar.gz: 87d380ab217bcb15a137fe65342c003d73247bd33f1ed8afd0c1b1961d35f8ae
 SHA512:
-  metadata.gz: 3e0c6ff91ac90e928919e12774f4b1013e67b2957e1b3dfc958ef177f1c74ec3f2eb494ffe58c1a98946a69bc1eace0f79dd5664055f448388fedd02cbe7e824
-  data.tar.gz: d24bc990a119f44ddb136047bcf3423934d8252ee340cdc09b9500cf42da09aa352f0a58e8f22d249f9449cad2fb71681f5689c65af760697b493222899e7814
+  metadata.gz: 7e9f8ebc5ec8cfcbbc652b712630ad9be5b0b047447f843a43b3aa29e9119bb951b619992f95be68f231300296fc2036019a82a3b7e44d472fbf1662262d86e9
+  data.tar.gz: 5955808a8f1320dec6c18be33104cf6550f36db71e1d5b0f350d211a9e9be179815c3f50b1d118a90bd61c8ba5c43b6d36a449d596e57f37a60883dad483a896

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 ## master (unreleased)
 
+## 1.2.4 (2024-10-16)
+
+- Fix RuboCop warnings.
+
+## 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.

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
 
@@ -55,7 +55,7 @@ rubocop -r "rubocop-md" -a ./lib
 
 Code in the documentation does not make sense to be checked for some style guidelines (eg `Style/FrozenStringLiteralComment`).
 
-We described such rules in the [default config](config/default.yml), but if you use the same settings in your project’s `.rubocop.yml` file, `RoboCop` will override them.
+We described such rules in the [default config](config/default.yml), but if you use the same settings in your project’s `.rubocop.yml` file, `RuboCop` will override them.
 
 Fortunately, `RuboCop` supports directory-level configuration and we can do the next trick.
 
@@ -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

@@ -39,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

data/lib/rubocop/markdown/rubocop_ext.rb

@@ -2,18 +2,19 @@
 
 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
 
@@ -59,27 +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|
-        next if RuboCop::Markdown::MARKDOWN_OFFENSE_COPS.include?(offense.cop_name)
-
-        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)
 
@@ -96,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.2"
+    VERSION = "1.2.4"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-md
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.2.4
 platform: ruby
 authors:
 - Vladimir Dementyev
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-12-01 00:00:00.000000000 Z
+date: 2024-10-17 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.