typeprof 0.15.1 → 0.20.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52c9e6c0c338fb19da0264929bce36b903cdedf7be3b6a031deef525e28be8d4
-  data.tar.gz: 8c17fe8549a7c44c8a11a1db9a40384b05f4025e5ec23140fee09eaf349d855c
+  metadata.gz: b3938be1edd2b64861739d4ea2f801972c32fc67b4b791837e2b238d9be3a5bb
+  data.tar.gz: 8ba23caae4ab25ea713a1b4fca1850cbc44954aaecabcfd9a3e7a3db18c6ea4b
 SHA512:
-  metadata.gz: 74d8eddbd6010287d33c9891a59112f7f9edf1aa2f3ea24d07142e1d81e1c03508b1362a3630f092138352616a8258e973784d926293882894ba933123851f88
-  data.tar.gz: 77bc3c7f268b11663f561829c4b1a2c4917e137c0e56c3b4e734f29862c011e7095b2d1939a352534f78003159d90f07f8de81ce1304819f4f79e5d5ac6f7242
+  metadata.gz: e946bed7229effa1d0d95fd665875b39344d8aa959e6fa126631b914e8f9ead55a2a5cababd2ea390f1275b04d1e73bec2b4969c3ccc549acfdeb09512ed8626
+  data.tar.gz: e31d656a00087bb096c91e2c3da129e7d81ee480e99d67685b1c458a5cbf1a2e97c3ea0feef1657b1a895fc44bd2011ba3fd6ef8b387833967e99c1c728b6e4b

data/.github/workflows/main.yml

@@ -7,7 +7,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby-version: [2.7, 3.0, head]
+        ruby-version: [2.7, 3.0,head]
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    typeprof (0.15.1)
-      rbs (>= 1.3.1)
+    typeprof (0.20.1)
+      rbs (>= 1.6.2)
 
 GEM
   remote: https://rubygems.org/
@@ -11,7 +11,7 @@ GEM
     docile (1.4.0)
     power_assert (2.0.0)
     rake (13.0.1)
-    rbs (1.3.3)
+    rbs (1.6.2)
     simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
@@ -19,7 +19,7 @@ GEM
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.3)
     stackprof (0.2.17)
-    test-unit (3.4.2)
+    test-unit (3.4.4)
       power_assert
 
 PLATFORMS

data/doc/ide.md

@@ -0,0 +1,81 @@
+# How to use TypeProf for IDE
+
+First, try it with an already-configured repository!
+
+1. `rbenv install 3.1.0-dev`
+2. `git clone https://github.com/mame/rbswiki`
+3. `cd rbswiki && bundle install`
+4. `rbs collection install`
+5. install [VSCode extension for TypeProf](https://marketplace.visualstudio.com/items?itemName=mame.ruby-typeprof) to your VSCode
+6. open the `rbswiki` folder by VSCode
+7. open `lib/rbswiki/wiki.rb`
+
+If everything goes well, you will see guessed signatures for each method:
+
+![Screenshot](typeprof-for-ide.png)
+
+### Troubleshooting
+
+* Make sure that you are using ruby 3.1.0-dev.
+
+```
+$ ruby -v
+ruby 3.1.0dev (2021-09-28T11:03:54Z master 545e01645f) [x86_64-linux]
+```
+
+* Check if typeprof version is 0.20.0 or later.
+
+```
+$ bundle exec typeprof --version
+typeprof 0.20.0
+```
+
+* Check if TypeProf can analyze `lib/rbswiki/wiki.rb` within one second.
+
+```
+$ bundle exec typeprof lib/rbswiki/wiki.rb
+warning: rbs collection is experimental, and the behavior may change until RBS v2.0
+# TypeProf 0.20.0
+
+# Classes
+module RBSWiki
+  class Wiki
+    @content: Hash[String, String]
+...
+```
+
+* See the log of "Ruby TypeProf" in vscode's "OUTPUT" panel.
+
+![Log of TypeProf for IDE](typeprof-for-ide-log.png)
+
+## How to configure TypeProf for your code
+
+1. Write `gem "typeprof"` to your `Gemfile`, and run `bundle install`
+2. Write `rbs_collection.yaml`, and run `rbs collection install`
+3. Test if TypeProf works well by running `bundle exec typeprof your_code.rb`
+4. Open your repository with vscode
+
+### Troubleshooting
+
+*TBD*
+
+## Protips, limitation, unimplemented features, ...
+
+TypeProf for IDE is extremely preliminary! Please give it a try with a warm heart...
+
+* Write a simple (type-level) test in each file with `if $0 == __FILE__` guard to guide TypeProf to infer method signatures.
+* Use `require` only for loading gems. To load your code, use `require_relative` instead of `require`. (Or, create `bin/typeprof` and pass `-Ilib`. TBD for details)
+* Currently, TypeProf for IDE loads `typeprof.rbs` at the top folder. (I'll need to improve it to read `sig/` directory)
+* TypeProf for IDE analyzes each file within one second. Unfortunately, it takes very long to analyze big code, or complex code, or code that requires a big gem. In this case, TypeProf for IDE cannot show any guesses. Splitting a file or manually writing RBS may make the analysis faster. (TBD for details)
+* Unfortunately, TypeProf may report some false positive errors that you cannot stop. I'll create an option to configure error level.
+* TypeProf for IDE tries to invoke TypeProf as follows:
+    * If your repository has `bin/typeprof` executable, it is invoked.
+    * Otherwise, it will try to invoke a command specified in VS`typeprof.server.path`.
+    * Otherwise, it will try to invoke `bundle exec typeprof`.
+    * Otherwise, it will try to invoke `typeprof`.
+    * Otherwise, TypeProf for IDE gives up.
+* Some people says TypeProf for IDE works with vim! (TBD for details)
+
+## How to develop TypeProf for IDE
+
+See `../vscode/development.md`.

data/exe/typeprof

@@ -3,4 +3,8 @@
 require_relative "../lib/typeprof"
 
 config = TypeProf::CLI.parse(ARGV)
-TypeProf.analyze(config)
+if config.options[:lsp]
+  TypeProf.start_lsp_server(config)
+else
+  TypeProf.analyze(config)
+end