aboutsummaryrefslogtreecommitdiffstats
path: root/lua/lspconfig/configs/solidity.lua
diff options
context:
space:
mode:
authorJustin M. Keyes <justinkz@gmail.com>2024-10-01 05:39:12 -0700
committerGitHub <noreply@github.com>2024-10-01 05:39:12 -0700
commitbedb2a0df105f68a624a49b867f269b6d55a2c89 (patch)
tree877aa3ef8277575a7ffea1ff8f280eeb69b47489 /lua/lspconfig/configs/solidity.lua
parentdocs: CONTRIBUTING.md cleanup (diff)
downloadnvim-lspconfig-bedb2a0df105f68a624a49b867f269b6d55a2c89.tar
nvim-lspconfig-bedb2a0df105f68a624a49b867f269b6d55a2c89.tar.gz
nvim-lspconfig-bedb2a0df105f68a624a49b867f269b6d55a2c89.tar.bz2
nvim-lspconfig-bedb2a0df105f68a624a49b867f269b6d55a2c89.tar.lz
nvim-lspconfig-bedb2a0df105f68a624a49b867f269b6d55a2c89.tar.xz
nvim-lspconfig-bedb2a0df105f68a624a49b867f269b6d55a2c89.tar.zst
nvim-lspconfig-bedb2a0df105f68a624a49b867f269b6d55a2c89.zip
refactor: rename "server_configurations" => "configs" #3330
Problem: The name `server_configurations` is extremely verbose and irritatingly formal and dogmatic. This overlong name is a constant nuisance when reading, writing, and coding. It's also not even correct: these configurations are just as much "client" configurations as they are "server" configurations. Solution: - Rename to a shorter name. - Leave placeholder files for any old URLs that link to the old location.
Diffstat (limited to 'lua/lspconfig/configs/solidity.lua')
-rw-r--r--lua/lspconfig/configs/solidity.lua49
1 files changed, 49 insertions, 0 deletions
diff --git a/lua/lspconfig/configs/solidity.lua b/lua/lspconfig/configs/solidity.lua
new file mode 100644
index 00000000..4e254bd9
--- /dev/null
+++ b/lua/lspconfig/configs/solidity.lua
@@ -0,0 +1,49 @@
+local util = require 'lspconfig.util'
+
+return {
+ default_config = {
+ cmd = { 'solidity-ls', '--stdio' },
+ filetypes = { 'solidity' },
+ root_dir = util.root_pattern('.git', 'package.json'),
+ settings = { solidity = { includePath = '', remapping = {} } },
+ },
+ docs = {
+ description = [[
+https://github.com/qiuxiang/solidity-ls
+
+npm i solidity-ls -g
+
+Make sure that solc is installed and it's the same version of the file. solc-select is recommended.
+
+Solidity language server is a LSP with autocomplete, go to definition and diagnostics.
+
+If you use brownie, use this root_dir:
+root_dir = util.root_pattern('brownie-config.yaml', '.git')
+
+on includePath, you can add an extra path to search for external libs, on remapping you can remap lib <> path, like:
+
+```lua
+{ solidity = { includePath = '/Users/your_user/.brownie/packages/', remapping = { ["@OpenZeppelin/"] = 'OpenZeppelin/openzeppelin-contracts@4.6.0/' } } }
+```
+
+**For brownie users**
+Change the root_dir to:
+
+```lua
+root_pattern("brownie-config.yaml", ".git")
+```
+
+The best way of using it is to have a package.json in your project folder with the packages that you will use.
+After installing with package.json, just create a `remappings.txt` with:
+
+```
+@OpenZeppelin/=node_modules/OpenZeppelin/openzeppelin-contracts@4.6.0/
+```
+
+You can omit the node_modules as well.
+]],
+ default_config = {
+ root_dir = [[root_pattern("package.json", ".git")]],
+ },
+ },
+}