spoom 1.0.3 → 1.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f6a3db37efef69beb451a63043e45e10e8c49cb6c86c774fdc8e01a18aee858
-  data.tar.gz: de6e4f8e97f5802b3843ccde507510d4de081a98f4fdd3b7bf6da62d1b177dcb
+  metadata.gz: 866446fc75971d51c7a71d7ed713cf256f682ffbd0fabfaf97c95b601638876b
+  data.tar.gz: a38dd3b7859929349c2d84b4119e5f8d8d374c0cf5062adbb3904065a1d6f0f2
 SHA512:
-  metadata.gz: 74189496b4e9a126ba649fa529f3061c03e334f01c715b571dc12920f97219ea79e6d7f25811d073fc6daa2fa6db04aeb12030fa119fefe94cb822964710e658
-  data.tar.gz: bcefd877fc949636d850a660e389bd0f395ef3fb38b6eed178f2b09b0bc63685202dff5628ac6f39a54597471e4ea8004356971db9d578a0e07fdde986d05a8e
+  metadata.gz: 257a78cbdf439ee83e23a823ed39918ada7a1b66786967a77604e5dca2bb825aeb8af2f5fcda6c497686f29f9d0c7dba1d051060d984694f22c0064dcbd8c1a9
+  data.tar.gz: 4a66b832da23c6237d1dedc16735cce058306ce66327fd2e074d72a481d55412aa7dc8047f0fa25957e1369747478347b77ccf8cd7c85cdb286fcff6a564a412

data/Gemfile

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 source "https://rubygems.org"
@@ -6,4 +7,7 @@ gemspec
 
 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,261 @@ 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 loc
+```
+
+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
+```
+
+Remove duplicated error lines:
+
+```
+$ spoom tc -u
+```
+
+Format each error line:
+
+```
+$ spoom tc -f '%C - %F:%L: %M'
+```
+
+Where:
+
+* `%C` is the error code
+* `%F` is the file the error is from
+* `%L` is the line the error is from
+* `%M` is the error message
+
+Hide the `Errors: X` at the end of the list:
+
+```
+$ spoom tc --no-count
+```
+
+#### 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
+```
+
+Bump the strictness from a list of files (one file by line):
+
+```
+$ spoom bump --from false --to true -o list.txt
+```
+
+Check if files can be bumped without applying any change:
+
+```
+$ spoom bump --from false --to true --dry
+```
+
+Bump files using a custom instance of Sorbet:
+
+```
+$ spoom bump --from false --to true --sorbet /path/to/sorbet/bin
+```
+
+#### 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 +295,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::Sorbet::BIN_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,31 @@
+# typed: true
 # frozen_string_literal: true
 
 require "sorbet-runtime"
 
+module Spoom
+  extend T::Sig
+
+  SPOOM_PATH = (Pathname.new(__FILE__) / ".." / "..").to_s
+
+  class Error < StandardError; end
+
+  sig do
+    params(
+      cmd: String,
+      arg: String,
+      path: String,
+      capture_err: T::Boolean
+    ).returns([String, T::Boolean])
+  end
+  def self.exec(cmd, *arg, path: '.', capture_err: false)
+    method = capture_err ? "popen2e" : "popen2"
+    Open3.send(method, [cmd, *arg].join(" "), chdir: path) do |_, o, t|
+      [o.read, T.cast(t.value, Process::Status).success?]
+    end
+  end
+end
+
+require "spoom/sorbet"
+require "spoom/cli"
 require "spoom/version"
-require "spoom/sorbet/config"

data/lib/spoom/cli.rb

@@ -0,0 +1,69 @@
+# 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, type: :boolean, default: true, desc: "Use colors"
+      class_option :path, type: :string, default: ".", aliases: :p, desc: "Run spoom in a specific path"
+
+      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