rubocop-md 1.2.3 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7c6dbb228497df06f33f4c2c5f91b9fc719aa1026428b8ca86e596f4658ffcb
-  data.tar.gz: c42e2dea6fe018ec5e0f23dd39caeaff927408729ee69c911f7220446017d1c0
+  metadata.gz: 1d414259899409135b2608eb7744f4e27402f05ec2b065949f0c4a8b0fd8cc21
+  data.tar.gz: a9ffb768310fce686b303e10c385eab73318ec9c70af9904d0995dfef003eb85
 SHA512:
-  metadata.gz: d3a4dd5d3e3eb894db690a40f699303f4350664516cd83475127786e8348086b0e23d8209fb2187aa0df33e287f4a6f72f840efe7b9dc7214b0113180299e59f
-  data.tar.gz: 5cd2b8c3675fd5fa84676c00d75ce2872dbc193ab4f55fc01283450c5bc3ad3774c80156b712332db467585baa8e3913064f5c14095102eb2bb979b572e1e51e
+  metadata.gz: 7e8159a8a631840d2d5d1da67606c78ddbc956bb67f7d3c1f218b89eb3a7462afc1d0e488af30d261ae2542cf722f106a394a3ae9c6643ea3529c752a0743546
+  data.tar.gz: 9a3cfdf13a58fb5130d30627ba50f69a6e4643aeb6b92b3dd0e52eb0149aafdf7f9156da2b69d3b1d2bd5e3d75ebc3a3a87f13db7bdaa6f8baf7afdfc1e816e7

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 ## master (unreleased)
 
+## 2.0.0 (2025-02-17)
+
+- Migrate to new RuboCop Plugin architecture.
+
+## 1.2.4 (2024-10-16)
+
+- Fix RuboCop warnings.
+
 ## 1.2.3 (2024-09-12)
 
 - Do no try linting `.mdx` files by default.

data/README.md

@@ -39,23 +39,23 @@ Or install it yourself as:
 
 ### Command line
 
-Just require `rubocop-md` in your command:
+Just require `rubocop-md` plugin in your command:
 
 ```sh
-rubocop -r "rubocop-md" ./lib
+rubocop --plugin "rubocop-md" ./lib
 ```
 
 Autocorrect works too:
 
 ```sh
-rubocop -r "rubocop-md" -a ./lib
+rubocop --plugin "rubocop-md" -a ./lib
 ```
 
 ### Configuration
 
 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.
 
@@ -64,7 +64,7 @@ At first, add `rubocop-md` to your main `.rubocop.yml`:
 ```yml
 # .rubocop.yml
 
-require:
+plugins:
   - "rubocop-md"
 ```
 

data/lib/rubocop/markdown/plugin.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "lint_roller"
+
+module RuboCop
+  module Markdown
+    # A plugin that integrates rubocop-md with RuboCop's plugin system.
+    class Plugin < LintRoller::Plugin
+      def about
+        LintRoller::About.new(
+          name: "rubocop-md",
+          version: VERSION,
+          homepage: "https://github.com/rubocop/rubocop-md",
+          description: "Run RuboCop against your Markdown files to make sure " \
+                       "that code examples follow style guidelines."
+        )
+      end
+
+      def supported?(context)
+        context.engine == :rubocop
+      end
+
+      def rules(_context)
+        LintRoller::Rules.new(
+          type: :path,
+          config_format: :rubocop,
+          value: Pathname.new(__dir__).join("../../../config/default.yml")
+        )
+      end
+    end
+  end
+end

data/lib/rubocop/markdown/rubocop_ext.rb

@@ -24,17 +24,6 @@ module RuboCop
     class << self
       attr_accessor :config_store
 
-      # Merge markdown config into default configuration
-      # See https://github.com/backus/rubocop-rspec/blob/master/lib/rubocop/rspec/inject.rb
-      def inject!
-        path = CONFIG_DEFAULT.to_s
-        hash = ConfigLoader.send(:load_yaml_configuration, path)
-        config = Config.new(hash, path)
-        puts "configuration from #{path}" if ConfigLoader.debug?
-        config = ConfigLoader.merge_with_default(config, path)
-        ConfigLoader.instance_variable_set(:@default_configuration, config)
-      end
-
       def markdown_file?(file)
         MARKDOWN_EXTENSIONS.include?(File.extname(file))
       end
@@ -42,8 +31,6 @@ module RuboCop
   end
 end
 
-RuboCop::Markdown.inject!
-
 RuboCop::Runner.prepend(Module.new do
   # Set config store for Markdown
   def get_processed_source(*args)

data/lib/rubocop/markdown/version.rb

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

data/lib/rubocop/markdown.rb

@@ -11,5 +11,6 @@ module RuboCop
 
     require_relative "markdown/preprocess"
     require_relative "markdown/rubocop_ext" if defined?(::RuboCop::ProcessedSource)
+    require_relative "markdown/plugin"
   end
 end

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-md
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 2.0.0
 platform: ruby
 authors:
 - Vladimir Dementyev
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-13 00:00:00.000000000 Z
+date: 2025-02-17 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: lint_roller
+  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: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.45'
+        version: 1.72.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.45'
+        version: 1.72.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -66,7 +80,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
-description: Run Rubocop against your Markdown files to make sure that code examples
+description: Run RuboCop against your Markdown files to make sure that code examples
   follow style guidelines.
 email:
 - dementiev.vm@gmail.com
@@ -80,6 +94,7 @@ files:
 - config/default.yml
 - lib/rubocop-md.rb
 - lib/rubocop/markdown.rb
+- lib/rubocop/markdown/plugin.rb
 - lib/rubocop/markdown/preprocess.rb
 - lib/rubocop/markdown/rubocop_ext.rb
 - lib/rubocop/markdown/version.rb
@@ -92,7 +107,8 @@ metadata:
   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: 
+  default_lint_roller_plugin: RuboCop::Markdown::Plugin
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -100,7 +116,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -108,8 +124,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.4.19
-signing_key: 
+signing_key:
 specification_version: 4
-summary: Run Rubocop against your Markdown files to make sure that code examples follow
+summary: Run RuboCop against your Markdown files to make sure that code examples follow
   style guidelines.
 test_files: []