VSCode Ethereum Security Bundle

A meta-extension bundling vscode marketplace plugins for secure Ethereum smart contract development.

• What's the story?
• What's included?
  • I want (extension-name-here) to be part of this awesome bundle! Where to go?
  • (extension-name-here) is sh*t! How to get it removed from the bundle?
• Alright, it's installed, any other settings and tweaks you want to share?
• Other useful extensions, not bunled with this one

📚What's the story?

• You are developing or auditing smart contracts for the Ethereum ecosystem.
• (optional) You love git and your home is github❤ .
• You are battling with all the different IDE's that claim to support smart contract languages but they do not seem to be the right fit ⚡😐.
• The IDE's by default do not sufficiently support you doing a good job out.
• The options provided by the IDE's marketplace is just overwhelming.

This meta-extension aims to help you getting your IDE up to speed. It does not contribute any new functionality by its own, but installs a curated set of useful extensions for ethereum developers from the vscode marketplace. 🤓

🎁 What's included?

Alright, this is supposed to be a community curated extension. If you feel like an extension is missing or should be removed from the bundle? Vote for it by creating an issue and we'll remove/add it if the vote succeeds! Together we can make this work for everyone :)

Solidity

Language support

• juanblanco.solidity - Solidity language support and more!
• tintinweb.solidity-visual-auditor - Security centric syntax and semantic highlighting, a detailed class outline and advanced Solidity code insights for Solidity developers and auditors.
• tintinweb.solidity-metrics - Create fancy solidity code metrics reports.

Tool integrations

• MythX.mythxvsc - VS Code extension for MythX, the smart contract security scanning service.
• tintinweb.vscode-solidity-flattener - Flatten Solidity contracts from truffle projects from within vscode (context menu for solidity files in the vscode file explorer).

Vyper

Language support

• tintinweb.vscode-vyper - Ethereum Vyper Language Support and Visual Auditor

LLL

Language support

• tintinweb.vscode-LLL - Ethereum LLL Language Support

General Purpose

Efficiency

• streetsidesoftware.code-spell-checker - Spellcheck your code.
• gimenete.github-linker - Right-Click and copy a github link of the selected code fragment to clipboard.

Review

• ryu1kn.partial-diff - Create partial diffs of selected text in the vscode text editor.
• tintinweb.vscode-inline-bookmarks - Easily add customizable inline bookmarks based on trigger words. Perfect for code audits or to keep track of notes and todo's.

Tool integrations

• eg2.vscode-npm-script - NPM integration for vscode. Install dependencies directly by right-clicking package.json in your vscode file explorer.
• eamodio.gitlens - Git support. Especially useful when reviewing diffs.

⚙ Tweaks

Cool, you've come this far therefore I expect you're genuinely interested in either the individual extensions or you just installed the one-click bundle :) Either way, you're welcome!

Here's a quick walk-through and some tweaks on how to get the best out of vscode and the extensions.

Note: json settings shown below are meant to be merged into your config.

VSCode

How do I un/install extensionbs?

AppMenu -> Preferences -> Extensions

How do I access vscode and extension settings?

AppMenu -> Preferences -> Settings

How do I disable telemetry in vscode?

• Open settings.json (via vscode settings)
• Add this to settings.json:

{
    "telemetry.enableCrashReporter": false,
    "telemetry.enableTelemetry": false,
}

Make vscode auto-save files automatically after a delay

• It can be annoying that you are editing a file and always have to manually save it for it to be synced to the file-system. The following auto-saves files after a delay automatically.
• Add this to settings.json:

{
  "files.autoSave": "afterDelay",
}

• And disable confirmation when deleting

{
  "explorer.confirmDelete": false,
}

How do I extend the terminal scrollback cache?

• Some tools may produce a large amount of output lines and it can be annoying that the integrated terminal's scrollback is very limited.

• Add this to settings.json:

{
  "terminal.integrated.scrollback": 6000,
}

Selection Highlighting

• Grey selection highlight
• Orange selection border for other occurences of the selection in the editor (nice for comparison)

{
  "workbench.colorCustomizations": {
        "editor.selectionBackground": "#977f5746",
        "editor.selectionHighlightBackground": "#cf9b4d28",
        "editor.selectionHighlightBorder":"#ff5e0096"
    },
}

Make vscode diff editor ignore whitespaces by default

• we don't care too much about whitespaces right now :D

{
  diffEditor.ignoreTrimWhitespace
}

Solidity

Disable the auto-linting

• Add this to settings.json:

{
  "solidity.enabledSolium": false,
  "solidity.linter": "",
}

Git & Gitlens

• Gitlens code-lenses can be annoying (inline code actions). Thankfully they can be disabled (together with telemetry. data privacy ftw). We also enable git commit fetching for the git extension:

{
  "gitlens.codeLens.enabled": false,
  "gitlens.advanced.telemetry.enabled": false,
  "git.autofetch": true,
}

Other useful extensions

• Indent-Rainbow
• Bookmarks
• Git Graph
• ES Lint
• XML Tools
• Material Icon Theme
• Markdown All in One

Notes

• You can uninstall individual extensions at any point.
• Uninstalling the extension pack will uninstall all the referenced extensions.

Credits

♥ Thanks to the awesome Ethereum community for building all these extensions, you rock!

Release Notes

see CHANGELOG