https://github.com/qiuxiang/solidity-ls

Solidity language server.
https://github.com/qiuxiang/solidity-ls

language-server solidity

Last synced: 2 months ago
JSON representation

Solidity language server.

• Host: GitHub
• URL: https://github.com/qiuxiang/solidity-ls
• Owner: qiuxiang
• Created: 2022-03-01T10:42:07.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-02-10T11:02:51.000Z (11 months ago)
• Last Synced: 2024-10-12T18:27:36.074Z (3 months ago)
• Topics: language-server, solidity
• Language: TypeScript
• Homepage:
• Size: 110 KB
• Stars: 57
• Watchers: 3
• Forks: 7
• Open Issues: 5
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
[npm]: https://www.npmjs.com/package/solidity-ls

[npm-badge]: https://img.shields.io/npm/v/solidity-ls.svg

# solidity-ls [![npm-badge]][npm]



This language server has no error tolerance.

Means that some features will only work if sources are no syntax error.

For example:

```solidity

// should not work

msg.

   ^

// should work

msg.;

   ^

```

# Features

- completion

  - 

      local variables, state variables, functions

      

      

    

  - 

      contracts

      

    

  - 

      globally variables and it's members

      

      

    

  - 

      struct members

      

    

  - 

      external contract functions

      

    

- 

    diagnostics

    

    

  

- 

    hover documention

    

    

  

- 

    references

    

  

- rename

- signature help (basic implementation)

- go to references

- go to definition

## Usage

```

npm i solidity-ls -g

solidity-ls --stdio

```

or

```

npx solidity-ls --stdio

```

### coc.nvim

```

:CocInstall coc-solidity

```

### neovim lsp

More info: https://github.com/neovim/nvim-lspconfig/blob/master/doc/server_configurations.md#solidity

```lua

local lspconfig = require 'lspconfig'

lspconfig.solidity.setup({

  -- on_attach = on_attach, -- probably you will need this.

  -- capabilities = capabilities,

  settings = {

    -- example of global remapping

    solidity = {

        includePath = '',

        remapping = { ["@OpenZeppelin/"] = 'OpenZeppelin/[email protected]/' },

        -- Array of paths to pass as --allow-paths to solc

        allowPaths = {}

    }

  },

})

```

### foundry supports

run `forge remappings > remappings.txt` in project root.