Sorbet type checking

[JamieMagee]

Code improvement description

Sorbet is a type checker for Ruby. It allows for gradual addition of types to an existing codebase and can work for both static and runtime type checking.

Currently, this issue is mainly a placeholder.

• Migrate Layout/DotPosition from trailing to leading

  Sorbet made 1 intentional compatibility break with Ruby syntax relating to multiline method calls which match Ruby keywords. Unfortunately, this happens quite often for RSpec's matchers. For example and, or, etc.

  The fix is to switch from enforcing trailing dot position to leading with Rubocop, to ensure compatibility with Sorbet. This can be done automatically, but is going to result in a very large diff.

  • https://srb.help/2001
  • Break compatibility with Ruby syntax sorbet/sorbet#1993
  • Set Layout/DotPosition to leading #7789

• The above change is going to result in a rather large git diff. To preserve the usefulness of git blame a .git-blame-ignore-revs file should be added at the root of the repository with the git object ID of the above commit.

  • https://github.blog/changelog/2022-03-24-ignore-commits-in-the-blame-view-beta/
  • Add .git-blame-ignore-revs-file and ignore style change #7992

• Install Sorbet and its dependencies.

  • https://sorbet.org/docs/adopting#step-1-install-dependencies
  • Add sorbet dependencies #8007

• Initialise Sorbet

  • https://sorbet.org/docs/adopting#step-2-initialize-sorbet-in-our-project
  • Initialize sorbet #8012

• Fix any initial errors

  • https://sorbet.org/docs/adopting#step-4-fix-constant-resolution-errors

• Enforce static type checking as part of the build process

  • https://sorbet.org/docs/adopting#step-5-enable-type-checking
  • Add sorbet workflow #8017

• Install and enable the Sorbet RuboCop rules

  • https://github.com/Shopify/rubocop-sorbet
  • Add rubocop-sorbet #8016

• Add the Sorbet Visual Studio Code extension to the list of recommended extensions, as well as the Dev Container configuration

  • https://marketplace.visualstudio.com/items?itemName=sorbet.sorbet-vscode-extension
  • Add Sorbet VSCode extension #8018

[JamieMagee]

At this point, I think all of the initialization and setup is complete. Now the work of adding types begins.

[yeikel]

Something I noticed is that the Sorbet scan always runs. Perhaps it should only run if there are changes to Ruby files?

Example : Sorbet

In this example, the job took 2m~ of CI time with no benefits

[JamieMagee]

I don't think it's a huge issue right now, but it could be scoped. I think *.rb, Gemfile, Gemfile.lock and *.gemspec files can influence type checking.