{"id":13496585,"url":"https://github.com/neovim/neovim-ruby","last_synced_at":"2025-05-14T10:08:41.839Z","repository":{"id":17153581,"uuid":"19920398","full_name":"neovim/neovim-ruby","owner":"neovim","description":"Ruby support for Neovim","archived":false,"fork":false,"pushed_at":"2025-03-30T16:02:42.000Z","size":958,"stargazers_count":354,"open_issues_count":1,"forks_count":18,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-04-09T23:25:24.991Z","etag":null,"topics":["neovim","neovim-clients","neovim-plugin","neovim-remote","ruby","ruby-bindings"],"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/neovim.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2014-05-18T20:33:36.000Z","updated_at":"2025-04-07T08:31:38.000Z","dependencies_parsed_at":"2023-07-12T14:49:03.605Z","dependency_job_id":"1244769a-7c9f-49fb-bff7-45c813e18b6d","html_url":"https://github.com/neovim/neovim-ruby","commit_stats":{"total_commits":914,"total_committers":7,"mean_commits":"130.57142857142858","dds":"0.027352297592997843","last_synced_commit":"dff715e56fa4093fe2326a4a493bed948a33fb15"},"previous_names":["alexgenco/neovim-ruby"],"tags_count":31,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neovim%2Fneovim-ruby","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neovim%2Fneovim-ruby/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neovim%2Fneovim-ruby/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neovim%2Fneovim-ruby/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/neovim","download_url":"https://codeload.github.com/neovim/neovim-ruby/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248305845,"owners_count":21081575,"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":["neovim","neovim-clients","neovim-plugin","neovim-remote","ruby","ruby-bindings"],"created_at":"2024-07-31T19:01:52.186Z","updated_at":"2025-04-11T16:39:14.938Z","avatar_url":"https://github.com/neovim.png","language":"Ruby","readme":"# Neovim Ruby\n\n[![Build Status](https://github.com/neovim/neovim-ruby/workflows/Tests/badge.svg)](https://github.com/neovim/neovim-ruby/actions)\n[![Gem Version](https://badge.fury.io/rb/neovim.svg)](https://badge.fury.io/rb/neovim)\n\nRuby support for [Neovim](https://github.com/neovim/neovim).\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem \"neovim\"\n```\n\nAnd then execute:\n\n```shell\nbundle\n```\n\nOr install it yourself as:\n\n```shell\ngem install neovim\n```\n\n## Usage\n\nNeovim supports the `--listen` option for specifying an address to serve its RPC API. To connect to Neovim over a Unix socket, start it up like this:\n\n```shell\n$ nvim --listen /tmp/nvim.sock\n```\n\nYou can then connect to that socket path to get a `Neovim::Client`:\n\n```ruby\nrequire \"neovim\"\nclient = Neovim.attach_unix(\"/tmp/nvim.sock\")\n```\n\nRefer to the [`Neovim` docs](https://www.rubydoc.info/github/neovim/neovim-ruby/main/Neovim) for other ways to connect to `nvim`, and the [`Neovim::Client` docs](https://www.rubydoc.info/github/neovim/neovim-ruby/main/Neovim/Client) for a summary of the client interface.\n\n### Remote Modules\n\nRemote modules allow users to define custom handlers in Ruby. To implement a remote module:\n\n- Define your handlers in a plain Ruby script that imports `neovim`\n- Spawn the script from lua using `jobstart`\n- Define commands in lua using `nvim_create_user_command` that route to the job's channel ID\n\nFor usage examples, see:\n\n- [`example_remote_module.rb`](spec/acceptance/runtime/example_remote_module.rb)\n- [`example_remote_module.lua`](spec/acceptance/runtime/plugin/example_remote_module.lua)\n- [`remote_module_spec.vim`](spec/acceptance/remote_module_spec.vim)\n\n*Note*: Remote modules are a replacement for the deprecated \"remote plugin\" architecture. See https://github.com/neovim/neovim/issues/27949 for details.\n\n### Vim Plugin Support\n\nThe Neovim gem also acts as a compatibility layer for Ruby plugins written for `vim`. The `:ruby`, `:rubyfile`, and `:rubydo` commands are intended to match their original behavior, and their documentation can be found [here](https://neovim.io/doc/user/if_ruby.html).\n\n## Links\n\n* Source: \u003chttps://github.com/neovim/neovim-ruby\u003e\n* Bugs: \u003chttps://github.com/neovim/neovim-ruby/issues\u003e\n* CI: \u003chttps://github.com/neovim/neovim-ruby/actions\u003e\n* Documentation:\n  * Latest Gem: \u003chttps://rubydoc.info/gems/neovim\u003e\n  * Main: \u003chttps://rubydoc.info/github/neovim/neovim-ruby/main\u003e\n\n## Contributing\n\n1. Fork it (\u003chttps://github.com/neovim/neovim-ruby/fork\u003e)\n2. Create your feature branch (`git checkout -b my-new-feature`)\n3. Commit your changes (`git commit -am 'Add some feature'`)\n4. Push to the branch (`git push origin my-new-feature`)\n5. Create new Pull Request\n","funding_links":[],"categories":["Ruby"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fneovim%2Fneovim-ruby","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fneovim%2Fneovim-ruby","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fneovim%2Fneovim-ruby/lists"}