Are you an LLM? Read llms.txt for a summary of the docs, or llms-full.txt for the full context.
Skip to content

VS Code

For the full settings schema, see Setup Overview.

Generic LSP Proxy extension

Install the Generic LSP Proxy extension.

Add the following to .vscode/lsp-proxy.json in your project root:

.vscode/lsp-proxy.json
[
  {
    "languageId": "solidity",
    "command": "solidity-language-server",
    "fileExtensions": [
      ".sol"
    ]
  }
]

Additional configuration

Add the following to .vscode/settings.json for additional configuration:

.vscode/settings.json
{
  "solidity-language-server.inlayHints.parameters": true,
  "solidity-language-server.inlayHints.gasEstimates": true,
  "solidity-language-server.lint.enabled": true,
  "solidity-language-server.lint.severity": [],
  "solidity-language-server.lint.only": [],
  "solidity-language-server.lint.exclude": [],
  "solidity-language-server.fileOperations.templateOnCreate": true,
  "solidity-language-server.fileOperations.updateImportsOnRename": true,
  "solidity-language-server.fileOperations.updateImportsOnDelete": true,
  "solidity-language-server.projectIndex.fullProjectScan": true,
  "solidity-language-server.projectIndex.cacheMode": "v2",
  "solidity-language-server.projectIndex.incrementalEditReindex": false
}

Lint options reference

Lint options (severity, rule IDs, only, exclude) are documented in Setup Overview → Lint values.

Example filtered lint setup:

settings.json
{
  "solidity-language-server.lint.severity": ["high", "med"],
  "solidity-language-server.lint.exclude": ["pascal-case-struct"]
}