Enable RuboCop in vscode & jekyll directories

[sambostock]

Motivation

The vscode and jekyll directories are not being checked by RuboCop.

• vscode/activation.rb should be checked, as it is Ruby
• Both directories contain Ruby within Markdown code snippets. If we care about linting those in the main directory, then we should also lint them here.

Implementation

The Include config is updated so the additional directories are linted.

This identifies a number of offenses, which have been corrected.

Notably, rubocop-md treats Markdown code blocks without a language specified as Ruby by default. We could change this behaviour, but it's clearer to explicitly mark the snippets as txt when there is no matching language.

[graphite-app]

How to use the Graphite Merge Queue

Add the label graphite-merge to this PR to add it to the merge queue.

You must have a Graphite account in order to use the merge queue. Sign up using this link.

An organization admin has enabled the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

[andyw8]

Nice

[sambostock]

I don't know what to do about

jekyll/add-ons.markdown:274:3: C: RubyLsp/UseRegisterWithHandlerMethod: Created a handler without registering the associated on_call_node_enter event.
  def on_call_node_enter(node) ...
  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
jekyll/add-ons.markdown:301:3: C: RubyLsp/UseRegisterWithHandlerMethod: Created a handler without registering the associated on_call_node_leave event.
  def on_call_node_leave(node); end
  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

but it's the repo's own cops failing, so I'm guessing we should be addressing them?

[sambostock]

RuboCop was complaining that vscode/activation.rb should be

# typed: strict

which enforces sigs on all methods. The file currently has no method definitions, but if it ever gained any, we couldn't attach any sigs without sorbet-runtime, so strict is clearly too high.

We could use

# typed: true

to simply benefit from type checking, but then Sorbet complains about

env = ENV.filter_map do |k, v|
  utf_8_value = v.dup.force_encoding(Encoding::UTF_8)
  "#{k}RUBY_LSP_VS#{utf_8_value}" if utf_8_value.valid_encoding?
end
env.unshift(RUBY_VERSION, Gem.path.join(","), !!defined?(RubyVM::YJIT))
#    Expected `String` but found `T::Boolean` ^^^^^^^^^^^^^^^^^^^^^^^^^ 
$stderr.print("RUBY_LSP_ACTIVATION_SEPARATOR#{env.join("RUBY_LSP_FS")}RUBY_LSP_ACTIVATION_SEPARATOR")

because it thinks env must be a T::Array[String]. We could do

env.unshift(RUBY_VERSION, Gem.path.join(","), defined?(RubyVM::YJIT) ? "true" : "false")

but technically, we don't need to (interpolating a boolean works fine), so it seemed simplest to just disable the Sorbet cops.

[vinistock]

Yeah, all we have under vscode for Ruby are the activation scripts. There's no point in adopting Sorbet, let's please keep it disabled.

[vinistock]

The linting error doesn't make much sense because it's not really intended to run on Markdown. Let's just add a comment as the body of those methods saying what people are supposed to do in them.