Add rubocop-md to lint markdown snippets with Ruby code (#2003)

Author: Earlopain

.rubocop.yml

@@ -3,6 +3,7 @@ inherit_gem:
 
 require:
   - rubocop-sorbet
+  - rubocop-md
   - rubocop-minitest
   - rubocop-rake
   - ./lib/rubocop/cop/ruby_lsp/use_language_server_aliases
@@ -15,6 +16,7 @@ AllCops:
     - "sorbet/rbi/shims/**/*.rbi"
   Exclude:
     - "vendor/**/*"
+    - "vscode/**/*"
     - "features/**/*"
     - "test/fixtures/**/*"
     - "test/expectations/**/*"

ADDONS.md

@@ -148,6 +148,7 @@ module RubyLsp
         # pre-computed information in the addon. These factory methods are invoked on every request
         Hover.new(client, response_builder, @config, dispatcher)
       end
+    end
 
     class Hover
       # The Requests::Support::Common module provides some helper methods you may find helpful.
@@ -175,9 +176,10 @@ module RubyLsp
       # Listeners must define methods for each event they registered with the dispatcher. In this case, we have to
       # define `on_constant_read_node_enter` to specify what this listener should do every time we find a constant
       def on_constant_read_node_enter(node)
-        # Certain builders are made available to listeners to build LSP responses. The classes under `RubyLsp::ResponseBuilders`
-        # are used to build responses conforming to the LSP Specification.
-        # ResponseBuilders::Hover itself also requires a content category to be specified (title, links, or documentation).
+        # Certain builders are made available to listeners to build LSP responses. The classes under
+        # `RubyLsp::ResponseBuilders` are used to build responses conforming to the LSP Specification.
+        # ResponseBuilders::Hover itself also requires a content category to be specified (title, links,
+        # or documentation).
         @response_builder.push("Hello!", category: :documentation)
       end
     end
@@ -271,7 +273,7 @@ module RubyLsp
           params: Interface::ProgressParams.new(
             token: "progress-token-id",
             value: Interface::WorkDoneProgressBegin.new(kind: "begin", title: "Starting slow work!"),
-          )
+          ),
         )
       end
     end
@@ -324,7 +326,6 @@ module RubyLsp
         )
       end
 
-
       def workspace_did_change_watched_files(changes)
         if changes.any? { |change| change[:uri].end_with?(".my-config.yml") }
           # Do something to reload the config here
@@ -348,7 +349,7 @@ require "ruby_lsp/check_docs"
 # The second argument is the file list of GIF files with the demos of all listeners
 RubyLsp::CheckDocs.new(
   FileList["#{__dir__}/lib/ruby_lsp/ruby_lsp_rails/**/*.rb"],
-  FileList.new("#{__dir__}/misc/**/*.gif")
+  FileList.new("#{__dir__}/misc/**/*.gif"),
 )
 ```
 

DESIGN_AND_ROADMAP.md

@@ -77,7 +77,7 @@ long term roadmap to see what’s planned
 "".upcase
 1.to_s
 {}.merge!({ a: 1 })
-[].concat([])
+[].push(1)
 
 ## Scenarios where can assume the receiver type
 class Foo

Gemfile

@@ -13,6 +13,7 @@ group :development do
   gem "psych", "~> 5.1", require: false
   gem "rake", "~> 13.2"
   gem "rdoc", require: false, github: "Shopify/rdoc", branch: "create_snapper_generator"
+  gem "rubocop-md", "~> 1.2.0", require: false
   gem "rubocop-minitest", "~> 0.35.0", require: false
   gem "rubocop-rake", "~> 0.6.0", require: false
   gem "rubocop-shopify", "~> 2.15", require: false

Gemfile.lock

@@ -71,6 +71,8 @@ GEM
       unicode-display_width (>= 2.4.0, < 3.0)
     rubocop-ast (1.31.2)
       parser (>= 3.3.0.4)
+    rubocop-md (1.2.2)
+      rubocop (>= 1.0)
     rubocop-minitest (0.35.0)
       rubocop (>= 1.61, < 2.0)
       rubocop-ast (>= 1.31.1, < 2.0)
@@ -137,6 +139,7 @@ DEPENDENCIES
   rake (~> 13.2)
   rdoc!
   rubocop (~> 1.63)
+  rubocop-md (~> 1.2.0)
   rubocop-minitest (~> 0.35.0)
   rubocop-rake (~> 0.6.0)
   rubocop-shopify (~> 2.15)