spoom 1.0.0 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 120fef71dbc1eb301d6425be852e9bd96554114865f5350c0bb5553fe16fbdaf
-  data.tar.gz: a50b10a8f28d7a96c9167ccf457116b61ef300f06d9dcce44801528355fc22cf
+  metadata.gz: 7a5f19185a1beba98f75c9c96b08c06400c9917c0d85734f1dbf9c9d77e3fa74
+  data.tar.gz: 53f4b8b10f81b19588f58d57c93349721230836e3b98524b52c46a78f4682365
 SHA512:
-  metadata.gz: 4c306c8d3bbe04aa4874fc95d826989d226a5b20d3548048c0e485ae27678e32f79e63c0a7e98e3b743e116622a2161e75f04c0ca75214c1c78ece75977f6ce4
-  data.tar.gz: d5745d54bfc4caf3daf584231647dc299ce572888555304c8f4334aac495fec0d61457e60281a2c0e4992c4ef19d1b923e17151f006a4f436c7cddbf366b733c
+  metadata.gz: aff5a2bc4b3bd01c815ad0d00e76fcc700728ec659135645dce259db72dc97cf8ea2d339827d979bf9f225637b7d23f2ea09d13dd02786229fe5c42caf88886e
+  data.tar.gz: b2760f8f58a7f3cbfd90d59e16f5bb9b76356f13fc3f38a606758652f53caf72004024128e4195451ca32f30c9d03c6bdb553a6a7aea2893c7f0e6a2e6ec2528

data/Gemfile

@@ -1,7 +1,13 @@
+# typed: true
 # frozen_string_literal: true
 
 source "https://rubygems.org"
 
 gemspec
 
-gem 'rubocop-shopify', require: false
+group(:development) do
+  gem('rubocop-shopify', require: false)
+  gem('rubocop-sorbet', require: false)
+  gem('byebug')
+  gem('pry-byebug')
+end

data/README.md

@@ -20,7 +20,218 @@ Or install it yourself as:
 
 ## Usage
 
-### Parsing Sorbet config
+`spoom` provides both a CLI and an API to interact with Sorbet.
+
+### Generate a typing coverage report
+
+Spoom can create a typing coverage report from Sorbet and Git data:
+
+![Coverage Report](docs/report.png)
+
+After installing the `spoom` gem, run the `timeline` command to collect the history data:
+
+```
+$ spoom coverage timeline --save
+```
+
+Then create the HTML page with `report`:
+
+```
+$ spoom coverage report
+```
+
+Your report will be generated under `spoom_report.html`.
+
+See all the [Typing Coverage](#typing-coverage) CLI commands for more details.
+
+### Command Line Interface
+
+#### Sorbet configuration commands
+
+Spoom works with your `sorbet/config` file. No additional configuration is needed.
+
+Show Sorbet config options:
+
+```
+$ spoom config
+```
+
+#### Listing files
+
+List the files (and related strictness) that will be typchecked with the current Sorbet config options:
+
+```
+$ spoom files
+```
+
+#### Errors sorting and filtering
+
+List all typechecking errors sorted by location:
+
+```
+$ spoom tc -s
+```
+
+List all typechecking errors sorted by error code first:
+
+```
+$ spoom tc -s code
+```
+
+List only typechecking errors from a specific error code:
+
+```
+$ spoom tc -c 7004
+```
+
+List only the first 10 typechecking errors
+
+```
+$ spoom tc -l 10
+```
+
+These options can be combined:
+
+```
+$ spoom tc -s -c 7004 -l 10
+```
+
+#### Typing coverage
+
+Show metrics about the project contents and the typing coverage:
+
+```
+$ spoom coverage
+```
+
+Save coverage data under `spoom_data/`:
+
+```
+$ spoom coverage --save
+```
+
+Save coverage data under a specific directory:
+
+```
+$ spoom coverage --save my_data/
+```
+
+Show typing coverage evolution based on the commits history:
+
+```
+$ spoom coverage timeline
+```
+
+Show typing coverage evolution based on the commits history between specific dates:
+
+```
+$ spoom coverage timeline --from YYYY-MM-DD --to YYYY-MM-DD
+```
+
+Save the typing coverage evolution as JSON under `spoom_data/`:
+
+```
+$ spoom coverage timeline --save
+```
+
+Save the typing coverage evolution as JSON in a specific directory:
+
+```
+$ spoom coverage timeline --save my_data/
+```
+
+Run `bundle install` for each commit of the timeline (may solve errors due to different Sorbet versions):
+
+```
+$ spoom coverage timeline --bundle-install
+```
+
+Generate an HTML typing coverage report:
+
+```
+$ spoom coverage report
+```
+
+Change the colors used for strictnesses (useful for colorblind folks):
+
+```
+$ spoom coverage report \
+  --color-true "#648ffe" \
+  --color-false "#fe6002" \
+  --color-ignore "#feb000" \
+  --color-strict "#795ef0" \
+  --color-strong "#6444f1"
+```
+
+Open the HTML typing coverage report:
+
+```
+$ spoom coverage open
+```
+
+#### Change the sigil used in files
+
+Bump the strictness from all files currently at `typed: false` to `typed: true` where it does not create typechecking errors:
+
+```
+$ spoom bump --from false --to true
+```
+
+Bump the strictness from all files currently at `typed: false` to `typed: true` even if it creates typechecking errors:
+
+```
+$ spoom bump --from false --to true -f
+```
+
+#### Interact with Sorbet LSP mode
+
+**Experimental**
+
+Find all definitions for `Foo`:
+
+```
+$ spoom lsp find Foo
+```
+
+List all symbols in a file:
+
+```
+$ spoom lsp symbols <file.rb>
+```
+
+List all definitions for a specific code location:
+
+```
+$ spoom lsp defs <file.rb> <line> <column>
+```
+
+List all references for a specific code location:
+
+```
+$ spoom lsp refs <file.rb> <line> <column>
+```
+
+Show hover information for a specific code location:
+
+```
+$ spoom lsp hover <file.rb> <line> <column>
+```
+
+Show signature information for a specific code location:
+
+```
+$ spoom lsp sig <file.rb> <line> <column>
+```
+
+Show type information for a specific code location:
+
+```
+$ spoom lsp sig <file.rb> <line> <column>
+```
+
+### API
+
+#### Parsing Sorbet config
 
 Parses a Sorbet config file:
 
@@ -41,6 +252,47 @@ puts config.paths   # "a", "b"
 puts config.ignore  # "c"
 ```
 
+List all files typchecked by Sorbet:
+
+```ruby
+config = Spoom::Sorbet::Config.parse_file("sorbet/config")
+puts Spoom::Sorbet.srb_files(config)
+```
+
+#### Parsing Sorbet metrics
+
+Display metrics collected during typechecking:
+
+```ruby
+puts Spoom::Sorbet.srb_metrics(capture_err: false)
+```
+
+#### Interacting with LSP
+
+Create an LSP client:
+
+```rb
+client = Spoom::LSP::Client.new(
+  Spoom::Config::SORBET_PATH,
+  "--lsp",
+  "--enable-all-experimental-lsp-features",
+  "--disable-watchman",
+)
+client.open(".")
+```
+
+Find all the symbols matching a string:
+
+```rb
+puts client.symbols("Foo")
+```
+
+Find all the symbols for a file:
+
+```rb
+puts client.document_symbols("file://path/to/my/file.rb")
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. Don't forget to run `bin/sanity` before pushing your changes.

data/Rakefile

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 require "bundler/gem_tasks"
 require "rake/testtask"
@@ -5,6 +6,7 @@ require "rake/testtask"
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
   t.libs << "lib"
+  t.warning = false
   t.test_files = FileList["test/**/*_test.rb"]
 end
 

data/exe/spoom

@@ -0,0 +1,7 @@
+#! /usr/bin/env ruby
+# typed: true
+# frozen_string_literal: true
+
+require_relative "../lib/spoom"
+
+Spoom::Cli::Main.start(ARGV)

data/lib/spoom.rb

@@ -1,6 +1,14 @@
+# typed: true
 # frozen_string_literal: true
 
 require "sorbet-runtime"
 
+module Spoom
+  class Error < StandardError; end
+end
+
+require "spoom/config"
+
+require "spoom/sorbet"
+require "spoom/cli"
 require "spoom/version"
-require "spoom/sorbet/config"

data/lib/spoom/cli.rb

@@ -0,0 +1,68 @@
+# typed: true
+# frozen_string_literal: true
+
+require "thor"
+
+require_relative 'cli/helper'
+
+require_relative "cli/bump"
+require_relative "cli/config"
+require_relative "cli/lsp"
+require_relative "cli/coverage"
+require_relative "cli/run"
+
+module Spoom
+  module Cli
+    class Main < Thor
+      extend T::Sig
+      include Helper
+
+      class_option :color, desc: "Use colors", type: :boolean, default: true
+      class_option :path, desc: "Run spoom in a specific path", type: :string, default: ".", aliases: :p
+      map T.unsafe(%w[--version -v] => :__print_version)
+
+      desc "bump", "bump Sorbet sigils from `false` to `true` when no errors"
+      subcommand "bump", Spoom::Cli::Bump
+
+      desc "config", "manage Sorbet config"
+      subcommand "config", Spoom::Cli::Config
+
+      desc "coverage", "collect metrics related to Sorbet coverage"
+      subcommand "coverage", Spoom::Cli::Coverage
+
+      desc "lsp", "send LSP requests to Sorbet"
+      subcommand "lsp", Spoom::Cli::LSP
+
+      desc "tc", "run Sorbet and parses its output"
+      subcommand "tc", Spoom::Cli::Run
+
+      desc "files", "list all the files typechecked by Sorbet"
+      def files
+        in_sorbet_project!
+
+        path = exec_path
+        config = Spoom::Sorbet::Config.parse_file(sorbet_config)
+        files = Spoom::Sorbet.srb_files(config, path: path)
+
+        say("Files matching `#{sorbet_config}`:")
+        if files.empty?
+          say(" NONE")
+        else
+          tree = FileTree.new(files, strip_prefix: path)
+          tree.print(colors: options[:color], indent_level: 2)
+        end
+      end
+
+      desc "--version", "show version"
+      def __print_version
+        puts "Spoom v#{Spoom::VERSION}"
+      end
+
+      # Utils
+
+      def self.exit_on_failure?
+        true
+      end
+    end
+  end
+end

data/lib/spoom/cli/bump.rb

@@ -0,0 +1,59 @@
+# typed: strict
+# frozen_string_literal: true
+
+require 'find'
+require 'open3'
+
+module Spoom
+  module Cli
+    class Bump < Thor
+      extend T::Sig
+      include Helper
+
+      default_task :bump
+
+      desc "bump DIRECTORY", "change Sorbet sigils from one strictness to another when no errors"
+      option :from, type: :string, default: Spoom::Sorbet::Sigils::STRICTNESS_FALSE
+      option :to, type: :string, default: Spoom::Sorbet::Sigils::STRICTNESS_TRUE
+      option :force, desc: "change strictness without type checking", type: :boolean, default: false, aliases: :f
+      sig { params(directory: String).void }
+      def bump(directory = ".")
+        from = options[:from]
+        to = options[:to]
+        force = options[:force]
+
+        unless Sorbet::Sigils.valid_strictness?(from)
+          say_error("Invalid strictness #{from} for option --from")
+          exit(1)
+        end
+
+        unless Sorbet::Sigils.valid_strictness?(to)
+          say_error("Invalid strictness #{to} for option --to")
+          exit(1)
+        end
+
+        files_to_bump = Sorbet::Sigils.files_with_sigil_strictness(directory, from)
+
+        Sorbet::Sigils.change_sigil_in_files(files_to_bump, to)
+
+        return [] if force
+
+        output, no_errors = Sorbet.srb_tc(path: File.expand_path(directory), capture_err: true)
+
+        return [] if no_errors
+
+        errors = Sorbet::Errors::Parser.parse_string(output)
+
+        files_with_errors = errors.map do |err|
+          path = err.file
+          File.join(directory, path) if path && File.file?(path)
+        end.compact.uniq
+
+        Sorbet::Sigils.change_sigil_in_files(files_with_errors, from)
+      end
+
+      no_commands do
+      end
+    end
+  end
+end