solidity-extension

Solidity Extension for Visual Studio Code

Important: Beware of fake extensions.
Always check the publisher and verify publishing history.
Available on VSCode Marketplace and OpenVSX.

Solidity is the primary language for Ethereum smart contracts.
This Visual Studio Code extension delivers a modern, productive developer experience—for dApps, audits, enterprise monorepos, and everything in between.

🌟 Core Features

🚀 Intelligent Code Completion

Autocomplete contracts, functions, variables, events, and more.

🔁 One-click Compiler Version Switching

Change your Solidity compiler version easily from the status bar or context menu. No manual configuration required.

🛠 Quick Fixes for Common Errors

Receive instant fixes for frequent issues (e.g., license headers, version mismatches, invalid addresses).

⬇️ Download Source Code from Etherscan

Retrieve verified contracts and ABIs with a single click from Etherscan.

💡 Inline Documentation ("Hover")

Hover over code to see instant NatSpec comments and in-code documentation.

✨ Feature Highlights

• Syntax highlighting for Solidity (*.sol)
• Powerful snippets and contract templates
• Compile single or multiple contracts directly from the editor
• Smart autocomplete (contracts, libs, imports, vars, & more)
• Go to definition & find all references
• Inline (“hover”) documentation for functions, types, variables
• Quick fixes: compiler version, SPDX, license header, address formatting
• Monorepo and multi-project workspace support
• Auto-detection of project layout (src/, lib/, etc.)
• EIP82 (dappfile) compatible for dependency/compilation
• Switch between remote, local file, embedded, or npm Solidity compilers
• Etherscan: Download source/ABI with one click
• Code generation for C#, F#, or VB.NET via Nethereum
• Lint using Solhint or Solium/Ethlint
• Standalone language server (LSP) mode

Get started today and instantly boost your Solidity experience in VSCode!

🖥️ Standalone Language Server

Install globally and run anywhere as an LSP:

npm install -g vscode-solidity-server
vscode-solidity-server --stdio

🚦 Usage Overview

Compiler Version Switching

• Download any Solidity compiler via solc-bin
• Change version via VSCode settings or context menu
• Select remote, local file, embedded, or npm-based compilers

Example settings

"solidity.compileUsingRemoteVersion": "latest"
// or
"solidity.compileUsingLocalVersion": "C:\\...\\soljson-v0.8.xx.js"

Context menu supports one-click download & switch.

npm/Node-based Compilation

Install solc with npm:

npm install solc

Compile with Custom Compilers

Right-click any .sol file to compile it with your preferred version—ideal for multiple versions or monorepo setups.

📄 ERCs, Snippets, & Templates

• Type erc to generate common ERC contract standards
• Type uni for Uniswap contract templates

Missing a template? PRs welcome!

📁 Project Layout & Remappings

• Default: contracts in src/, dependencies in lib/
• Supports both node_modules and lib/ imports
• Remappings via remappings.txt or solidity.remappings in your settings

Perfect for mono repos and modular project structures.

🎯 Editor Integrations

• Autocomplete: contracts, functions, events, imports
• Go to Definition: navigate instantly
• Hover Docs: instant NatSpec view
• Find References: workspace-wide search
• Quick Fixes: for common Solidity errors

🧹 Error Checking & Linting

Enable as-you-type error checking:

"solidity.enabledAsYouTypeCompilationErrorCheck": true,
"solidity.validationDelay": 1500

• Lint via Solhint or Solium/Ethlint (auto-detects .solhint.json)
• Choose your linter:

"solidity.linter": "solhint",
"solidity.solhintRules": { "avoid-sha3": "warn" }

🎨 Formatting

• Format Solidity with prettier-plugin-solidity (configure your .prettierrc)
• Optionally add auto-format via Foundry's forge fmt (foundry.toml required)
• Enable on-save format:

"editor.formatOnSave": true

⚡ Code Generation

• Generate C#, F#, or VB.NET code for apps (via Nethereum)
• Supports multiple .nethereum-gen.multisettings files

Example .nethereum-gen.multisettings

[
  {
    "paths": ["out/ERC20.sol/Standard_Token.json"],
    "generatorConfigs": [
      {
        "baseNamespace": "Contracts",
        "basePath": "output/MyProject.Contracts",
        "codeGenLang": 0,
        "generatorType": "ContractDefinition"
      }
    ]
  }
]

Create as many configs as you want:
project1.nethereum-gen.multisettings, game.nethereum-gen.multisettings, etc.

🤝 Community & Feedback

• Report issues: GitHub Issues
• Join us on Discord for real-time support
• All contributions, feedback, and improvements are welcome—see license for details

🏅 Credits

Thanks to the Solidity, Prettier, Solhint, Solium/Ethlint, and Nethereum communities, plus every contributor. Your ideas, bug reports, and PRs make Solidity better for everyone.