{"id":13897548,"url":"https://github.com/tomoasleep/yoda","last_synced_at":"2025-07-28T22:31:03.605Z","repository":{"id":29665378,"uuid":"116495608","full_name":"tomoasleep/yoda","owner":"tomoasleep","description":"Experimental: Static Analyzer and Language Server for Ruby","archived":false,"fork":false,"pushed_at":"2023-07-24T21:57:51.000Z","size":1573,"stargazers_count":25,"open_issues_count":6,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-11-19T17:34:34.730Z","etag":null,"topics":["autocompletion","language-server","ruby","yard"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tomoasleep.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-01-06T15:56:27.000Z","updated_at":"2023-07-26T22:32:15.000Z","dependencies_parsed_at":"2023-02-11T22:02:17.301Z","dependency_job_id":null,"html_url":"https://github.com/tomoasleep/yoda","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tomoasleep%2Fyoda","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tomoasleep%2Fyoda/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tomoasleep%2Fyoda/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tomoasleep%2Fyoda/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tomoasleep","download_url":"https://codeload.github.com/tomoasleep/yoda/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":227961890,"owners_count":17847836,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["autocompletion","language-server","ruby","yard"],"created_at":"2024-08-06T18:03:40.964Z","updated_at":"2024-12-03T16:50:27.216Z","avatar_url":"https://github.com/tomoasleep.png","language":"Ruby","funding_links":[],"categories":["Ruby"],"sub_categories":[],"readme":"# Yoda [![Test](https://github.com/tomoasleep/yoda/actions/workflows/test.yml/badge.svg)](https://github.com/tomoasleep/yoda/actions/workflows/test.yml)\n\nYoda is a Language Server (http://langserver.org/) for Ruby.\nYoda 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...).  \n\n**Note: Yoda is alpha version. Please use with caution. Contributions are welcome!**\n\n## Supporting Features\n\nYoda provides these features by analyzing Ruby code and its dependencies in Gemfile.lock with YARD.\n\n* Code completion (method, constant, variables, etc...)\n* Comment completion (YARD tag, types)\n* Hover code information (method, constant, etc...)\n* Go to definition (method, constant, require file, etc...)\n\n![](https://github.com/tomoasleep/yoda/blob/master/images/method-complete.png)\n\n![](https://github.com/tomoasleep/yoda/blob/master/images/hover-method.png)\n\n## Install VSCode Extension (Recommended)\n\nYoda can be available as VSCode extension at: https://marketplace.visualstudio.com/items?itemName=tomoasleep.yoda\nOn launch of VSCode, Yoda will be installed automatically.\n\n## Other installation methods\n\n### Install language server gem\n\nYoda is hosted on RubyGems.\n\n```\ngem install yoda-language-server\n```\n\nSee `Instation of Editor Plugin` section to install Yoda on your editor.\n\n\nYoda can be also used as a cli tool.\n\n```\n$ yoda setup # You must run this command first for your each project.\n$ yoda infer path-to-your-code:line_num:char_num # Show information of the code at the specified position.\n$ yoda complete \u003cpath-to-your-code\u003e:\u003cline-num\u003e:\u003cchar-num\u003e # Show completion at the specified position.\n```\n\n### Install Editor Plugin\n\n#### Atom\n\n```\napm install tomoasleep/yoda\n```\n\n#### VSCode (from source code)\n\n```\nrake vscode:install\n```\n\n#### Vim/NeoVim\n\nPlease use language server client such as [LanguageClient-neovim](https://github.com/autozimu/LanguageClient-neovim).\nHere is a configuration example for LanguageClient-neovim.\n\n```vim\nlet g:LanguageClient_serverCommands = {\n    \\ 'ruby': ['yoda', 'server'],\n    \\ }\n```\n\n#### Emacs\n\nTBW\n\n## Internal\n\n### YARD utilization\n\nYoda figures structures of your source codes and library codes with YARD.  \nYoda intepret YARD tags such as `@return` tags and `@param` tags and infer code types from these information.\n\n\n### Indexing\n\nYoda built index files for fast inference under `\u003cyour-project-dir\u003e/.yoda` at startup.  \nThese index files contains structures of external sources (gems and standard libraries).  \nYour project codes are parsed at startup but does not stored in indexes.\n\n## Development\n\nAfter checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.\n\nTo install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at https://github.com/tomoasleep/yoda.\n\n## License\n\nThe gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftomoasleep%2Fyoda","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftomoasleep%2Fyoda","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftomoasleep%2Fyoda/lists"}