wqptaste.blogg.se

Feel free to fork the repo and submit pull requests. DevelopmentĬode contributions are always appreciated.

GitHub Issues are the best place to ask questions, report problems, and suggest improvements. Contributing to Solargraph Bug Reports and Feature Requests See for more tips and tutorials about Solargraph. Language client developers should refer to. Clients can connect using either stdio or TCP. The language server protocol is the recommended way for integrating Solargraph into editors and IDEs. Version: 0.61.0 # formatting Integrating Other Editors rubocop:version=0.61.0 # diagnostics formatter: You can download documentation for other Ruby versions from the command line. The Solargraph gem ships with documentation for Ruby 2.2.2. In strict mode, it performs type inference to determine whether the tags match the types it detects from code. Type CheckingĪs of version 0.33.0, Solargraph includes a type checker that uses a combination of YARD tags and code analysis to report missing type definitions. If your project automatically requires bundled gems (e.g., require 'bundler/require'), Solargraph will add all of the Gemfile's default dependencies to the map. When editing code, a require call that references a gem will pull the documentation into the code maps and include the gem's API in code completion and intellisense. The first time you run it might take a while if you have a lot of gems installed). (YARD is included as one of Solargraph's gem dependencies. You can make sure your gems are documented by running yard gems from the command line. Solargraph is capable of providing code completion and documentation for gems that have YARD documentation. Rails Supportįor better Rails support, please consider using solargraph-rails Gem Support The path to the global configuration can be overridden with the SOLARGRAPH_GLOBAL_CONFIG environment variable. If not present, any global configuration at ~/.config/solargraph/config.yml will apply. solargraph.yml file at the root of the project. Solargraph's behavior can be controlled via optional configuration files. Plug-ins and extensions are available for the following editors: