elixir_sense
elixir_sense copied to clipboard
Provides context-aware information for code completion, documentation, go/jump to definition, signature info and more
ElixirSense
An API for Elixir projects that provides context-aware information for code completion, documentation, go/jump to definition, signature info and more.
Usage
defp deps do
[
{:elixir_sense, github: "elixir-lsp/elixir_sense"},
]
end
Testing
$ mix deps.get
$ mix test
A few of the tests require a source installation of Elixir which you can accomplish with asdf (use ref:v1.12.3
) or kiex
To run the tests that require a source installation of Elixir run:
mix test --include requires_source
For coverage:
mix coveralls
Credits
- This project probably wouldn't even exist without all the work done by Samuel Tonini and all contributors from alchemist-server.
- The Expand feature was inspired by the mex tool by Luc Fueston. There's also a very nice post where he describes the whole process of Building A Macro-Expansion Helper for IEx.
- This project includes modified source code from Elixir project IEx autocomplete Copyright (c) 2012 Plataformatec, which powers introspection and suggestions features
- This project includes modified source code from ExDoc project ExDoc Copyright (c) 2012 Plataformatec, which powers documentation retrieval and formatting
License (The MIT License)
Copyright (c) 2017 Marlus Saraiva
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.