rbs-src 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7ade9d16159cd243f1f3849c3cecf99ff9e9bcb8988380778a19d56ab09f0e1
-  data.tar.gz: 85bd20a7118741b61d5e0186893a8f990a8f257c03a19fbc3a3410f056cb1257
+  metadata.gz: 8228a38c388aa1705ca70c266e411b621b45a7d86f296117bdfcb376befab15c
+  data.tar.gz: 1b0f0daf59afe755d0fada717eb9573fead9936a3e1c5f9728b5ad72a9ca7496
 SHA512:
-  metadata.gz: 0c238d9c2c9a514bd62259176db2790507dc9543e9b0bd93d5530956d722158dc0f1bfd6f63ee5db037e0f3f89e581446f7935349d4336b4934c8aed774514cd
-  data.tar.gz: 177efc73a82a9de0bb01ed8155db0f843acaeedfb37bffb82e3de05db9140f21893e8ef1f0d47694e183d1eda9f0184d9b887e443ad9ba31f2eaf23274e7800f
+  metadata.gz: 6c255dec49483e1822ff3c21ccd3078023a898aa11a4701e0be60b876d3f18558087fc1bdd2a2a44825fb125d07785af5e355e55347115fbff5c898e736725f5
+  data.tar.gz: acfebcd0ae86f99e212c83c0df51f7b05466e149748c4edd6c8604b6b197c620ec69222186a1d5b6c1f1b0e620f9f220aebb3bbee49c96099623adacee62e89c

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rbs-src (0.6.0)
+    rbs-src (0.7.0)
       rainbow (~> 3.1.1)
 
 GEM

data/README.md

@@ -45,9 +45,15 @@ Load gem dependencies from `rbs_collection.lock.yaml` and set up all repositorie
 
 If the git repository content is edited, it runs `git stash` and `git reset --hard`.
 
+It accepts `--output` option to write the dependencies to a file.
+
+    $ rbs-src setup --output
+
+You can load the dependencies to your type checkers from the file.
+
 #### For Steep users
 
-You need to edit your Steepfile to let the type checker stop using rbs-collection.
+The recommended setup for Steep is the following:
 
 ```ruby
 # Steepfile
@@ -55,20 +61,33 @@ You need to edit your Steepfile to let the type checker stop using rbs-collectio
 target ... do
   # Existing config...
 
-  # Add `#signature` call to support loading RBS files from symlinked directory
-  signature "sig/rbs-src/*/*.rbs"
-  signature "sig/rbs-src/*/[^_]*/**/*.rbs"
+  # Assume we use `rbs-src setup --output` to generate `rbs_src.dep` file
+  if (dep_path = Pathname("rbs_src.dep")).file?
+    # Stop loading libraries through rbs-collection
+    disable_collection()
 
-  # Stop loading libraries through rbs-collection
-  disable_collection()
+    signature "sig/rbs-src/*/*.rbs"
+    signature "sig/rbs-src/*/[^_]*/**/*.rbs"
 
-  # Load standard libraries and gems manually
-  library('abbrev')
-  library('date')
-  # ...
+    dep_path.readlines().each {|lib| library(lib.chomp) }
+  end
 end
 ```
 
+In this setup, you can use Steep without using `rbs-src` until you run `rbs-src setup --output`.
+Once you run `rbs-src setup --output`, it generates `rbs_src.dep` file and `Steepfile` loads the dependencies from the file.
+
+```sh
+# When you install your rbs_collection dependencies
+$ rbs collection install && rbs-src setup --output
+
+# When you update your rbs_collection dependencies
+$ rbs collection update && rbs-src setup --output
+
+# When you stop using rbs-src
+$ rm -rf rbs_src.dep tmp/rbs-src sig/rbs-src
+```
+
 ### rbs-src link
 
 The command clones and set up a symlink of a ruby gem, not loaded from `rbs_collection.lock.yaml`.

data/Steepfile

@@ -6,10 +6,22 @@ target :lib do
   check "lib"                       # Directory name
 
   configure_code_diagnostics(D::Ruby.default)      # `default` diagnostics setting (applies by default)
+
   # configure_code_diagnostics(D::Ruby.strict)       # `strict` diagnostics setting
   # configure_code_diagnostics(D::Ruby.lenient)      # `lenient` diagnostics setting
   # configure_code_diagnostics(D::Ruby.silent)       # `silent` diagnostics setting
   # configure_code_diagnostics do |hash|             # You can setup everything yourself
   #   hash[D::Ruby::NoMethod] = :information
   # end
+
+  # `rbs-src setup -o` generates `rbs_src.dep` file
+  if (dep_path = Pathname("rbs_src.dep")).file?
+    # Stop loading libraries through rbs-collection
+    disable_collection()
+
+    signature "sig/rbs-src/*/*.rbs"
+    signature "sig/rbs-src/*/[^_]*/**/*.rbs"
+
+    dep_path.readlines().each {|lib| library(lib.chomp) }
+  end
 end

data/lib/rbs/src/cli.rb

@@ -132,11 +132,13 @@ module Rbs
           rbs_collection_lock_path = RBS::Collection::Config.to_lockfile_path(RBS::Collection::Config::PATH)
           repository_prefix = Pathname("tmp/rbs-src")
           rbs_prefix = Pathname("sig/rbs-src")
+          output_path= nil #: Pathname?
 
           OptionParser.new do |opts|
             opts.on("--rbs-collection-lock=PATH", "The path to rbs_collection.lock.yaml (default: #{rbs_collection_lock_path})") { rbs_collection_lock_path = Pathname(_1) }
             opts.on("--repo-prefix=PREFIX", "The location to put repository in (default: #{repository_prefix})") { repository_prefix = Pathname(_1) }
             opts.on("--rbs-prefix=PREFIX", "The location to put symlinks in (default: #{rbs_prefix})") { rbs_prefix = Pathname(_1) }
+            opts.on("--output[=PATH]", "-o[PATH]", "The path to write the list of stdlib dependencies (default: rbs_src.dep)") {|path| output_path = Pathname(path || "rbs_src.dep") }
 
             opts.banner = <<~BANNER
               Usage: rbs-src setup [options]
@@ -201,17 +203,27 @@ module Rbs
 
           other_libs.sort_by! { _1[0] }
 
-          unless other_libs.empty?
-            runner.push "You have to load other libraries without rbs-collection:" do
-              if has_gem?("steep")
-                runner.puts "Add the following lines in your Steepfile:"
-
-                other_libs.each do |name, version|
-                  runner.puts "  library('#{name}')"
+          if output_path
+            runner.push "Writing dependencies to #{output_path}:" do
+              output_path.open("w") do |io|
+                other_libs.each do |name, _|
+                  io.puts name
                 end
-              else
-                other_libs.each do |name, version|
-                  runner.puts "-r #{name} \\"
+              end
+            end
+          else
+            unless other_libs.empty?
+              runner.push "You have to load other libraries without rbs-collection:" do
+                if has_gem?("steep")
+                  runner.puts "Add the following lines in your Steepfile:"
+
+                  other_libs.each do |name, version|
+                    runner.puts "  library('#{name}')"
+                  end
+                else
+                  other_libs.each do |name, version|
+                    runner.puts "-r #{name} \\"
+                  end
                 end
               end
             end

data/lib/rbs/src/version.rb

@@ -2,6 +2,6 @@
 
 module Rbs
   module Src
-    VERSION = "0.6.0"
+    VERSION = "0.7.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbs-src
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Soutaro Matsumoto
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-09-14 00:00:00.000000000 Z
+date: 2023-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow
@@ -77,7 +77,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: rbs-src