yoda-language-server 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c06ab67892292a50ff422a252b794cf49f38dad60a8b32e7faf14936a2b648e
-  data.tar.gz: 20546678432670fae9b613a6d55e23f6ee3b2c544d6a6b62ff3ff80d6bd3e376
+  metadata.gz: 18cb55e5cd8509c2745109f37bd32b94347a2f6740bf982dbcc7d2d436070410
+  data.tar.gz: cd748b6986f9f673646c50b69806c8459023e2ed398fe3ced988b2e0b6c654eb
 SHA512:
-  metadata.gz: 0eac21b1b1b73f3d3864c2cdb37c2f8df39c9be6841518b59282d5b89c8b64d54972c9c8b9318d35273250c9c740465d7c2156098e0629ee0df831a05ad41e2a
-  data.tar.gz: 9b9991e147783643687d6c259c45c9ab45cfa009df5a60a23f1dce36571c5dc9a61d8a12bb70d57a79f30bf2288ed24933ea84e4a54c0df583b820ed54357cc6
+  metadata.gz: 4a66918e474a09349c98587414d01f71efcd232724ce9a9854634eeb79ed0ca83a4f848a9bd2250f99540b3b80a5649512610ed16f3a85f2be7de748a2bdf827
+  data.tar.gz: 7b3021e01a8b3415154f7746a6009d1043065f094070119c588c203e4b839340fbf0950bfe7e2aa7cba3d9b7c4ea12951efed6f9efeab729dde08673513768e0

data/.github/workflows/test.yml

@@ -0,0 +1,23 @@
+name: Test
+
+on:
+  push:
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ["2.6", "2.7", "3.0", "3.1"]
+    runs-on: ubuntu-latest
+    steps: 
+      - uses: actions/checkout@v2
+      - name: Install dependency packages
+        run: |
+          sudo apt update --quiet --yes
+          sudo apt install libgdbm6 libgdbm-dev
+      - uses: ruby/setup-ruby@v1
+        with: 
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: bundle exec rake

data/.gitignore

@@ -14,4 +14,4 @@
 /yarn-error.log
 
 /core/
-Gemfile.lock
+/Gemfile.lock

data/.rspec

@@ -1,3 +1,4 @@
 --format documentation
 --color
 --require spec_helper
+--exclude-pattern "spec/support/sample_projects/**/*_spec.rb"

data/Gemfile

@@ -4,3 +4,5 @@ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in yoda.gemspec
 gemspec
+
+gem 'simplecov', require: false, group: :test

data/README.md

@@ -1,11 +1,21 @@
 # Yoda [![Build Status](https://travis-ci.org/tomoasleep/yoda.svg?branch=master)](https://travis-ci.org/tomoasleep/yoda)
 
-Yoda is a Language Server (http://langserver.org/) for Ruby and provides autocompletion and code analysis (go-to-definition, code information, etc...).  
+Yoda is a Language Server (http://langserver.org/) for Ruby.
+Yoda infers signatures of your Ruby program and its dependencies from various data sources (RBS and YARD documentation) and provides autocompletion and code analysis (go-to-definition, code information, etc...).  
 
 **Note: Yoda is alpha version. Please use with caution. Contributions are welcome!**
 
 ## Instation and Usage
 
+## Getting Started
+
+```bash
+rake install # Install language server
+rake vscode:install # Install vscode plugin
+```
+
+### Install language server
+
 Yoda is hosted on RubyGems.
 
 ```
@@ -23,9 +33,9 @@ $ yoda infer path-to-your-code:line_num:char_num # Show information of the code
 $ yoda complete <path-to-your-code>:<line-num>:<char-num> # Show completion at the specified position.
 ```
 
-## Installation of Editor Plugin
+### Installation of Editor Plugin
 
-### Atom
+#### Atom
 
 ```
 apm install tomoasleep/yoda
@@ -33,9 +43,11 @@ apm install tomoasleep/yoda
 
 ### VSCode
 
-TBW
+```
+rake vscode:install
+```
 
-### Vim/NeoVim
+#### Vim/NeoVim
 
 Please use language server client such as [LanguageClient-neovim](https://github.com/autozimu/LanguageClient-neovim).
 Here is a configuration example for LanguageClient-neovim.
@@ -46,7 +58,7 @@ let g:LanguageClient_serverCommands = {
     \ }
 ```
 
-### Emacs
+#### Emacs
 
 TBW
 
@@ -68,16 +80,16 @@ Your project codes are parsed at startup but does not stored in indexes.
 - autocompletion
   - [x] method completion
   - [x] constant completion
-  - [ ] (local, class, instance) variable completion
-  - :small_red_triangle: comment completion
+  - [x] (local, class, instance) variable completion
+  - comment completion
     - [x] YARD tag completion
     - [x] YARD type literal completion
-    - [ ] parameter completion
+    - [x] parameter completion
 - [x] jump to definition
 - [x] hover
 - [x] signature help
-- [ ] find references
-- [ ] workspace symbols
+- [x] find references
+- [x] workspace symbols
 - [ ] diagnostics
 
 ## Development

data/Rakefile

@@ -4,3 +4,35 @@ require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec
+
+namespace :vscode do
+  desc "Install dependencies of vscode extension"
+  task :deps do
+    Dir.chdir(File.expand_path("./client/vscode", __dir__)) do
+      sh "npm ci"
+    end
+  end
+
+  desc "Build vscode extension"
+  task build: :deps do
+    Dir.chdir(File.expand_path("./client/vscode", __dir__)) do
+      # See: https://code.visualstudio.com/api/working-with-extensions/publishing-extension
+      sh "npm run package"
+    end
+  end
+
+  desc "Test vscode extension"
+  task test: :deps do
+    Dir.chdir(File.expand_path("./client/vscode", __dir__)) do
+      sh "npm test"
+    end
+  end
+
+  desc "Install vscode extension"
+  task install: :build do
+    Dir.chdir(File.expand_path("./client/vscode", __dir__)) do
+      # See: https://code.visualstudio.com/docs/editor/extension-marketplace#_install-from-a-vsix
+      sh "code --install-extension yoda-*.vsix"
+    end
+  end
+end

data/bin/bench

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+if Dir.exist?(File.join(__dir__, "..", ".git"))
+  $LOAD_PATH.unshift(File.expand_path('../lib', __dir__))
+end
+
+require 'yoda'
+require 'stackprof'
+
+StackProf.run(mode: :cpu, raw: true, out: 'tmp/stackprof-yoda.dump') do
+  Yoda::Runner::Setup.run(File.expand_path('~/src/github.com/increments/Qiita'))
+end

data/bin/local

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+if Dir.exist?(File.join(__dir__, "..", ".git"))
+  $LOAD_PATH.unshift(File.expand_path('../lib', __dir__))
+end
+
+exec(ARGV.join(' '))

data/client/atom/.gitignore

@@ -0,0 +1 @@
+node_modules/

data/{package.json → client/atom/package.json}

@@ -1,6 +1,6 @@
 {
   "name": "yoda",
-  "main": "./client/atom/main.js",
+  "main": "./main.js",
   "version": "0.0.0",
   "description": "Ruby completion engine",
   "keywords": [],

data/client/vscode/.gitignore

@@ -1,4 +1,4 @@
 out
 node_modules
 .vscode-test/
-.vsix
+*.vsix

data/client/vscode/.vscode/launch.json

@@ -2,17 +2,6 @@
 {
     "version": "0.1.0",
     "configurations": [
-        {
-            "name": "Extension",
-            "type": "extensionHost",
-            "request": "launch",
-            "runtimeExecutable": "${execPath}",
-            "args": ["--extensionDevelopmentPath=${workspaceRoot}" ],
-            "stopOnEntry": false,
-            "sourceMaps": true,
-            "outFiles": [ "${workspaceRoot}/out/**/*.js" ],
-            "preLaunchTask": "npm: watch"
-        },
         {
             "name": "Language Server E2E Test",
             "type": "extensionHost",

data/client/vscode/.vscode/settings.json

@@ -5,5 +5,9 @@
     },
     "search.exclude": {
         "out": true // set this to false to include "out" folder in search results
+    },
+    "yoda.trace.server": {
+        "format": "message",
+        "verbosity": "verbose"
     }
-}
+}

data/client/vscode/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Tomoya Chiba
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/client/vscode/README.md

@@ -1,65 +1,14 @@
-# yoda README
-
-This is the README for your extension "yoda". After writing up a brief description, we recommend including the following sections.
+# yoda
 
 ## Features
 
-Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file.
-
-For example if there is an image subfolder under your extension project workspace:
-
-\!\[feature X\]\(images/feature-x.png\)
-
-> Tip: Many popular extensions utilize animations. This is an excellent way to show off your extension! We recommend short, focused animations that are easy to follow.
 
 ## Requirements
 
-If you have any requirements or dependencies, add a section describing those and how to install and configure them.
-
-## Extension Settings
-
-Include if your extension adds any VS Code settings through the `contributes.configuration` extension point.
-
-For example:
-
-This extension contributes the following settings:
-
-* `myExtension.enable`: enable/disable this extension
-* `myExtension.thing`: set to `blah` to do something
-
-## Known Issues
-
-Calling out known issues can help limit users opening duplicate issues against your extension.
+Install yoda.
 
 ## Release Notes
 
-Users appreciate release notes as you update your extension.
-
-### 1.0.0
-
-Initial release of ...
-
-### 1.0.1
-
-Fixed issue #.
-
-### 1.1.0
-
-Added features X, Y, and Z.
-
------------------------------------------------------------------------------------------------------------
-
-## Working with Markdown
-
-**Note:** You can author your README using Visual Studio Code.  Here are some useful editor keyboard shortcuts:
-
-* Split the editor (`Cmd+\` on OSX or `Ctrl+\` on Windows and Linux)
-* Toggle preview (`Shift+CMD+V` on OSX or `Shift+Ctrl+V` on Windows and Linux)
-* Press `Ctrl+Space` (Windows, Linux) or `Cmd+Space` (OSX) to see a list of Markdown snippets
-
-### For more information
-
-* [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown)
-* [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/)
+### 0.0.1
 
-**Enjoy!**
+Initial release