@codingame/monaco-editor-wrapper 5.3.1 → 5.4.0-full-workbench.1

package/dist/assets/JakeBecker.elixir-ls-0.19.0.vsix/README.md

@@ -0,0 +1,219 @@
+# ElixirLS: Elixir support and debugger for VS Code
+[![Actions Status](https://img.shields.io/github/actions/workflow/status/elixir-lsp/vscode-elixir-ls/main.yml?branch=master)](https://github.com/elixir-lsp/vscode-elixir-ls/blob/HEAD/github/actions/workflow/status/elixir-lsp/vscode-elixir-ls/main.yml?branch=master)
+[![Visual Studio Marketplace Installs](https://img.shields.io/visual-studio-marketplace/i/JakeBecker.elixir-ls?label=Visual%20Studio%20Marketplace%20Installs)](https://marketplace.visualstudio.com/items?itemName=JakeBecker.elixir-ls)
+[![Open VSX Installs](https://img.shields.io/open-vsx/dt/elixir-lsp/elixir-ls?label=Open%20VSX%20Installs)](https://open-vsx.org/extension/elixir-lsp/elixir-ls)
+[![Slack](https://img.shields.io/badge/slack-join-orange.svg)](https://elixir-lang.slack.com/archives/C7D272G6N)
+
+Provides Elixir language server and debug adapter. This extension is powered by the [Elixir Language Server (ElixirLS)](https://github.com/elixir-lsp/elixir-ls), an Elixir implementation of Microsoft's IDE-agnostic [Language Server Protocol](https://microsoft.github.io/language-server-protocol/) and [Debug Adapter Protocol](https://microsoft.github.io/debug-adapter-protocol/). Visit its page for more information. For a guide to debugger usage in Elixir, read [this blog post](https://medium.com/@JakeBeckerCode/debugging-elixir-in-vs-code-400e21814614).
+
+Features include:
+
+- Code completion
+- Debugger support [VSCode debugging docs](https://code.visualstudio.com/docs/editor/debugging)
+- Test discovery, running and debugging via Test Explorer [VSCode test API announcment](https://code.visualstudio.com/updates/v1_59#_testing-apis)
+- Automatic, incremental Dialyzer analysis
+- Automatic suggestion for @spec annotations based on Dialyzer's inferred success typings
+- Diagnostic reporting of build warnings and errors
+- Go-to-definition and Go-to-implementation
+- Task provider with collection of mix tasks [VSCode tasks](https://code.visualstudio.com/docs/editor/tasks)
+- Smart automatic closing of code blocks
+- Documentation lookup on hover
+- Function signature provider
+- Code formatter (Triggered by `Alt + Shift + F` hotkey or enabling `editor.formatOnSave`)
+- Find references to functions and modules
+- Document and Workspace symbols provider
+- Multi-root workspaces
+
+![Screenshot](https://raw.githubusercontent.com/elixir-lsp/elixir-ls/master/images/screenshot.png)
+
+## This is the main vscode-elixir-ls repo
+
+The [elixir-lsp](https://github.com/elixir-lsp)/[vscode-elixir-ls](https://github.com/elixir-lsp/vscode-elixir-ls) repo began as a fork when the original repo at [JakeBecker](https://github.com/JakeBecker)/[vscode-elixir-ls](https://github.com/JakeBecker/vscode-elixir-ls) became inactive for an extended period of time. So we decided to start an active fork to merge dormant PR's and fix issues where possible. We also believe in an open and shared governance model to share the work instead of relying on one person to shoulder the whole burden.
+
+The original repository has now been deprecated in favor of this one. Future updates to the original [VS Code ElixirLS extension](https://marketplace.visualstudio.com/items?itemName=JakeBecker.elixir-ls) will come from this repo.
+
+## Default settings
+
+ElixirLS is opinionated and sets the following default settings for Elixir files:
+
+```jsonc
+{
+  // Based on Elixir formatter's style
+  "editor.insertSpaces": true,
+  // Note: While it is possible to override this in your VSCode configuration, the Elixir Formatter
+  // does not support a configurable tab size, so if you override this then you should not use the
+  // formatter.
+  "editor.tabSize": 2,
+  "files.trimTrailingWhitespace": true,
+  "files.insertFinalNewline": true,
+  "files.trimFinalNewlines": true,
+
+  // Provides smart completion for "do" and "fn ->" blocks. Does not run the Elixir formatter.
+  "editor.formatOnType": true,
+
+  // Misc
+  "editor.wordBasedSuggestions": false,
+  "editor.trimAutoWhitespace": false
+}
+```
+
+You can, of course, change these in your user settings, or on a per project basis in `.vscode/settings.json`.
+
+## Advanced Configuration
+
+### Add support for emmet
+
+`emmet` is a plugin that makes it easier to write HTML: https://code.visualstudio.com/docs/editor/emmet
+
+Open VSCode and hit Ctrl+Shift+P (or Cmd+Shift+P) and type "Preference: Open Settings (JSON)"
+Add or edit your `emmet.includedLanguages` to include the new Language ID:
+
+```json
+"emmet.includeLanguages": {
+  "html-eex": "html"
+}
+```
+
+## Supported versions
+
+See [ElixirLS](https://github.com/elixir-lsp/elixir-ls) for details on the supported Elixir and Erlang versions.
+
+## Troubleshooting
+
+If you run into issues with the extension, try these debugging steps:
+
+- Make sure you have `hex` and `git` installed.
+- Make sure `github.com` and `hex.pm` are accessible. You may need to configure your HTTPS proxy. If your setup uses TLS man-in-the-middle inspection, you may need to set `HEX_UNSAFE_HTTPS=1`.
+- If ElixirLS fails to start, you can try cleaning the `Mix.install` directory. (The location on your system can be obtained by calling `Path.join(Mix.Utils.mix_cache(), "installs")` from an `iex` session.)
+- Restart ElixirLS with a custom command `restart`
+- Run `mix clean` or `mix clean --deps` in ElixirLS with the custom command `mixClean`.
+- Restart your editor (which will restart ElixirLS).
+- After stopping your editor, remove the entire `.elixir_ls` directory, then restart your editor.
+  - NOTE: This will cause you to have to re-run the entire dialyzer build
+
+You may need to set `elixirLS.mixEnv`, `elixirLS.mixTarget`, and `elixirLS.projectDir` if your project requires it. By default, ElixirLS compiles code with `MIX_ENV=test`, `MIX_TARGET=host`, and assumes that `mix.exs` is located in the workspace root directory.
+
+If you get an error like the following immediately on startup:
+
+```
+[Warn  - 1:56:04 PM] ** (exit) exited in: GenServer.call(ElixirLS.LanguageServer.JsonRpc, {:packet, %{...snip...}}, 5000)
+    ** (EXIT) no process: the process is not alive or there's no process currently associated with the given name, possibly because its application isn't started
+```
+
+and you installed Elixir and Erlang from the Erlang Solutions repository, you may not have a full installation of Erlang. This can be solved with `sudo apt-get install esl-erlang`. (This was originally reported in [#208](https://github.com/elixir-lsp/elixir-ls/issues/208).)
+
+On fedora if you only install the elixir package you will not have a full erlang installation, this can be fixed by running `sudo dnf install erlang` (This was reported in [#231](https://github.com/elixir-lsp/elixir-ls/issues/231).)
+
+If you are seeing the message "Invalid beam file or no abstract code", you need to make sure that your Mix project is set to use the `elixirc` compiler option `--debug-info`, which can be done by adding the following line to your `mix.exs` `project` section:
+
+```
+elixirc_options: [debug_info: Mix.env() == :dev]
+```
+
+For example:
+
+```
+defmodule MyApp.MixProject do
+  use Mix.Project
+
+  def project do
+    [
+      app: :my_app,
+      version: "0.1.0",
+      elixir: "~> 1.11",
+      elixirc_paths: elixirc_paths(Mix.env()),
+      elixirc_options: [debug_info: Mix.env() == :dev],
+    ...
+```
+
+### Check ElixirLS Output
+
+Check the output log by opening `View > Output` and selecting "ElixirLS" in the dropdown.
+
+![View ElixirLS Output](https://github.com/elixir-lsp/vscode-elixir-ls/raw/HEAD/images/viewing-elixir-ls-output.gif)
+
+### Check the Developer Tools
+
+Check the developer console by opening `Help > Toggle Developer Tools` and include any errors that look relevant.
+
+## Contributing
+
+### Installation
+
+```shell
+# Clone this repo recursively to ensure you get the elixir-ls submodule
+git clone --recursive git@github.com:elixir-lsp/vscode-elixir-ls.git
+
+# Fetch vscode-elixir-ls dependencies
+cd vscode-elixir-ls
+npm install
+
+# Fetch elixir-ls dependencies
+cd elixir-ls
+mix deps.get
+MIX_ENV=prod mix compile
+```
+
+To launch the extension from VS Code, run the "Launch Extension local" launch configuration from [Run and Debug view](https://code.visualstudio.com/docs/editor/debugging#_run-view) or press F5.
+
+Alternatively, you can build and install the extension locally using the `vsce` command and the `code` CLI.
+
+```shell
+# Navigate to vscode-elixir-ls project root
+cd ..
+
+# Build the extension
+npx vsce package
+
+# Install it locally
+code --install-extension *.vsix --force
+```
+
+Note that if you have the extension installed from the Visual Studio Marketplace and are also installing a locally
+built package, you may need to disable the [Extensions: Auto Check Updates](https://code.visualstudio.com/docs/editor/extension-gallery#_extension-autoupdate) setting to prevent your
+local install from being replaced with the Marketplace version.
+
+### `elixir-ls` submodule
+
+Most of the functionality of this extension comes from ElixirLS, which is included as a Git submodule in the `elixir-ls` folder. Make sure you clone the repo using `git clone --recursive` or run `git submodule init && git submodule update` after cloning.
+
+Including `elixir-ls` as a submodule makes it easy to develop and test code changes for ElixirLS itself. If you want to modify ElixirLS, not just its VS Code client code, you'll want to change the code in the `elixir-ls` subdirectory. Most often you don't need to explicitly build it. The ElixirLS launch script should be able to pick up changes and rebuild accordingly via `Mix.install`.
+
+When you're ready to contribute your changes back to ElixirLS, you need to fork the [ElixirLS](https://github.com/elixir-lsp/elixir-ls) repo on Github and push any changes you make to the ElixirLS submodule to your fork. Here is an example of how that might look:
+
+```shell
+# Enter the submodule directory. Now, if you run git commands, they run in the submodule
+cd vscode-elixir-ls/elixir-ls
+
+# Create your feature branch
+git checkout -b my_new_branch
+
+# Add your forked elixir-ls repository as a remote
+git remote add my_fork git@github.com:<your_github_username>/elixir-ls.git
+
+# Make changes in the elixir-ls folder, commit them, and push to your forked repo
+git commit ...
+git push my_fork my_new_branch
+
+# Visit https://github.com/elixir-lsp/elixir-ls/compare to start a new Pull Request
+```
+
+### Running the tests locally
+
+You should ensure that the tests run locally before submitting a PR, and if relevant add automated tests in the PR.
+
+```shell
+rm -rf out
+npm run compile
+npm test
+```
+
+Alternatively, you can use the `test.sh`/`test.bat` script which does the above.
+
+## Telemetry
+
+This extension collects telemetry information emitted by ElixirLS language server and debug adapter for feature insight and performance and health monitoring. Collected telemetry data include usage, performance, environment info and error reports. Data is anonymised and not personally identifiable. Data is sent to Azure Application Insights via [@vscode/extension-telemetry](https://www.npmjs.com/package/@vscode/extension-telemetry). The extension respects VSCode `telemetry.telemetryLevel` setting. For transparency [telemetry.json](https://github.com/elixir-lsp/vscode-elixir-ls/blob/HEAD/telemetry.json) details all collected information. If you would like inspect what is being collected or change your telemetry settings, please refer to [VSCode Telemetry documentation](https://code.visualstudio.com/docs/getstarted/telemetry).
+
+## Acknowledgements and related projects
+
+There is another VS Code extension for Elixir, [VSCode Elixir](https://github.com/fr1zle/vscode-elixir). It's powered by [Elixir Sense](https://github.com/msaraiva/elixir_sense), another language "smartness" server similar to ElixirLS. Much of this extension's client code (such as syntax highlighting) was copied directly from VSCode Elixir, for which they deserve all the credit.

package/dist/assets/JuanBlanco.solidity-0.0.165.vsix/README.md

@@ -0,0 +1,416 @@
+# Solidity support for Visual Studio code
+[![Version](https://vsmarketplacebadges.dev/version/juanblanco.solidity.png)](https://marketplace.visualstudio.com/items?itemName=juanblanco.solidity)  [![Downloads](https://vsmarketplacebadges.dev/downloads-short/juanblanco.solidity.png)](https://marketplace.visualstudio.com/items?itemName=juanblanco.solidity) [![Installs](https://vsmarketplacebadges.dev/installs-short/juanblanco.solidity.png)](https://marketplace.visualstudio.com/items?itemName=juanblanco.solidity) [![Rating](https://vsmarketplacebadges.dev/rating-short/juanblanco.solidity.png)](https://marketplace.visualstudio.com/items?itemName=juanblanco.solidity#review-details)
+
+Solidity is the language used in Ethereum to create smart contracts, this extension provides: 
+
+* Syntax highlighting
+* Snippets
+* Compilation of the current contract (Press <kbd>F1</kbd> Solidity : Compile Current Solidity Contract), or <kbd>F5</kbd>
+* Compilation of all the contracts (Press <kbd>F1</kbd> Solidity : Compile all Solidity Contracts), or <kbd>Ctrl</kbd> + <kbd>F5</kbd> or <kbd>Cmd</kbd> + <kbd>F5</kbd>
+* Code completion for all contracts / libraries in the current file and all referenced imports
+* Goto definition
+* Find all references in project
+* Hover information
+* Code actions / quick fixes (change compiler, format address, add sdpx license.. )
+* Mono repo support (identifies the project by finding the files: remappings.txt, foundry.toml, brownie-config.yaml, truffle-config.js, hardhat.config.js)
+* Default project structure (solidity files needs to be in the `src/` directory, and libraries in the `lib/` directory). Libraries will follow the same structure.
+* Compilation supporting EIP82 (dappfile and dependency packages)
+* Support for different solidity versions (Remote and local)
+* Download source code and Abi from Etherscan
+* Code generation using [Nethereum](https://github.com/Nethereum/Nethereum), it includes currently the default template for Nethereum service, dtos generation. 
+  (Open 'contractName.json' after compilation from the bin folder. Press <kbd>F1</kbd> and press Solidity: Code generate from compilation output..)
+  Auto generation of Nethereum files on compilation
+* Linting using [Solhint](https://github.com/protofire/solhint) or [Ethlint](https://github.com/duaraghav8/Ethlint)
+
+# Instructions
+
+
+## Using a different version of the solidity compiler
+
+Sometimes you may want to use a different compiler than the one provided. You can find all the different versions in the solc-bin repository https://binaries.soliditylang.org/ 
+
+Currently we support four ways supported to use a different version of the solidity compiler. Remote, Local, NodeModule and Embedded
+
+You can change the compiler, in your user settings or workspace settings.
+
+![image](https://user-images.githubusercontent.com/562371/112019635-85d13d80-8b27-11eb-9e91-dc74dcf9e2fa.png)
+
+
+
+### Remote download
+When selecting remote download the compiler gets downloaded from the solc-bin repository. 
+
+You will need to change the following user setting, with the version required, for example `'latest'` or `'v0.8.18+commit.87f61d96'`, for your workspace user setting (current project) or global user setting (all projects)
+
+```
+"solidity.compileUsingRemoteVersion" : "latest"
+```
+![Screenshot](https://github.com/juanfranblanco/vscode-solidity/raw/HEAD/screenshots/change-compiler-version-gui-setting.png)
+
+You can simply change this setting using the context menu:
+
+![Screenshot](https://github.com/juanfranblanco/vscode-solidity/raw/HEAD/screenshots/change-compiler-version-contextmenu.png) 
+
+![Screenshot](https://github.com/juanfranblanco/vscode-solidity/raw/HEAD/screenshots/change-compiler-version-selectversion.png) 
+
+#### Using a code action
+If your code is targetting a specific version for solidity, and see the issue highlighted you can also trigger the menu directly from the import.
+
+![Screenshot](https://github.com/juanfranblanco/vscode-solidity/raw/HEAD/screenshots/solidity-change-workspacecompiler-codeaction.gif)
+
+### Using a Local file
+
+If you want to keep a compiler version locally, you can download the compiler from https://binaries.soliditylang.org/ and change your user settings to use this.
+
+```
+"solidity.compileUsingLocalVersion" : "C:\\Users\\JuanFran\\Downloads\\soljson-v0.8.18%2Bcommit.87f61d96.js"
+```
+
+The simplest way to download a compiler is to use the context menu, this will download your desired version at the root of the project and configure your workspace accordingly.
+
+![image](https://user-images.githubusercontent.com/562371/112136733-435f3d80-8bc7-11eb-91e5-e1d04a51cd72.png)
+
+### Npm / node installation
+Another option, is to use the solc npm package in your project, if this is enabled it will try to find the compiler in your configured node_modules at root.
+
+You can install solc using npm at the root of your project as follows.
+```
+npm install solc 
+```
+
+The default module package is "solc", but you may want to use other node module containing a compiler, this can be configured in the settings:
+![image](https://user-images.githubusercontent.com/562371/112137067-b668b400-8bc7-11eb-90bc-73e972da98d6.png)
+
+
+### Compiling a specific contract using a different compiler than the default one.
+
+There might be scenarios, that you want to use a different compiler for a specific file, using one of the other configured compilers. 
+
+![image](https://user-images.githubusercontent.com/562371/112020727-7f8f9100-8b28-11eb-91ca-0a43ef491e57.png)
+
+![image](https://user-images.githubusercontent.com/562371/112020877-a3eb6d80-8b28-11eb-895d-bbee7665e38d.png)
+
+
+
+## ERC, ERC drafts and Smart contracts snippets / reference
+
+It is pretty hard sometimes to find interfaces or information about an EIP (ERC) or specific libraries to simply get started working with Solidity. 
+The solidity extension now includes ERC approved and most drafts (wip) to help get you started.
+
+Just type ```erc``` and select the erc example or interface you want.
+
+![Screenshot](https://github.com/juanfranblanco/vscode-solidity/raw/HEAD/screenshots/ercautocomplete1.png)
+![Screenshot](https://github.com/juanfranblanco/vscode-solidity/raw/HEAD/screenshots/ercautocomplete2.png)
+
+### Smart contract project interfaces 
+In a similar to way to ERCs and as we work towards to more interoperable smart contracts, being able to quickly examine those interfaces that you want to integrate is a time saver.
+
+The current release includes the interfaces for Uniswap V2 (to get started), just type ```uni``` to list them all.
+![Screenshot](https://github.com/juanfranblanco/vscode-solidity/raw/HEAD/screenshots/unigen1.png) 
+![Screenshot](https://github.com/juanfranblanco/vscode-solidity/raw/HEAD/screenshots/unigen2.png)
+
+Note: If an ERC or your project is not included, please create a pull request. Note: Only established projets will be included.
+
+## Compiler optimization
+Optimize for how many times you intend to run the code. Lower values will optimize more for initial deployment cost, higher values will optimize more for high-frequency usage. The default value is **200**.
+```"solidity.compilerOptimization": 200``` 
+
+## Project structure and Remappings
+
+## Mono repo support
+Mono repo support, enables to have different projects in the same workspace as opposed to having open different workspaces in the same window.
+
+To provide mono repo support the project is idenfifed by by finding one of the different files used by different tools, for example remappings.txt, foundry.toml, brownie-config.yaml, truffle-config.js, hardhat.config.js. Solidity does not have a standard project file yet, or many not have it ever, so this is the best solution.
+
+Mono repo support is enabled by default now in the settings, but if wanted it can be disabled.
+
+### Dependencies for both "Node_modules" and "Lib" (Default)
+
+If you're using a library like [`@openzeppelin/contracts`](https://github.com/OpenZeppelin/openzeppelin-contracts), the OpenZeppelin Contracts will be found in your node_modules folder, or you might be using a library like [`Solmate`](https://github.com/transmissions11/solmate) and you might put it in your `lib` folder.
+So the user settings will be the following, assuming your solidity project is at root. 
+
+This is the default now, so you don't need to set it.
+
+```
+  "solidity.packageDefaultDependenciesContractsDirectory": "",
+  "solidity.packageDefaultDependenciesDirectory": ["node_modules", "lib"],
+```
+
+If you have a deeper structure, like
+
+```
+Solution
+└───solidity_project
+│   │
+|   │   xx.sol
+│   └───node_modules
+│   
+└───Nethereum_Project
+|   │   xx.cs
+|   │   yy.cs
+|
+└───Web3Js_Project
+|   │   xx.js
+|   │   yy.js
+```
+
+Your user settings configuration will need to represent the full structure:
+
+```
+  "solidity.packageDefaultDependenciesContractsDirectory": "",
+  "solidity.packageDefaultDependenciesDirectory": "solidity_project/node_modules"
+```
+
+## Dappsys (old ERC)
+
+The project  / library dependency structure can use the DappSys library model, this was the default mode before as it was part of an ERC:
+
+![Screenshot](https://github.com/juanfranblanco/vscode-solidity/raw/HEAD/screenshots/simpleProjectStructure.PNG)
+
+Libraries will have the same name as their folder they are included.
+Solidity files will be in the 'src' folder.
+Libraries will be included in the 'lib' folder.
+
+Currently there is no name conflicting resolution, so the first library found matching a name, will be the first one used.
+
+The user settings for this structure is:
+
+```
+  "solidity.packageDefaultDependenciesContractsDirectory": "src",
+  "solidity.packageDefaultDependenciesDirectory": "lib"
+```
+
+## Resolving imports from different contract directories shortcuts
+There are projects that may have their contracts in the "contracts" directory or you may have a mixture of them that are both in "contracts", "src" or just not specific shortcut. For this the extension internally tries to resolve these generic shortcuts if an import is not found. The default are ["contract", "src", ""]
+
+This behaves in the same way as ```"solidity.packageDefaultDependenciesDirectory": "lib"```. If you see there is a need for other folder names shortcuts, raise an issue.
+
+### Remappings
+Another option is to use remappings to define where your dependency libraries are, this can be achieved using the settings or creating a "remappings.txt" file in the root folder. For more info on remappings check the solidity documentation here https://docs.soliditylang.org/en/latest/path-resolution.html?highlight=remapping#import-remapping
+
+If you want to use the solidity user settings for your workspace / global remappings, please include them in the ```solidity.remappings```
+
+```
+"solidity.remappings": [
+    "@chainlink/=/Users/patrick/.brownie/packages/smartcontractkit/chainlink-brownie-contracts@0.2.2",
+    "@openzeppelin/=/Users/patrick/.brownie/packages/OpenZeppelin/openzeppelin-contracts@4.3.2"
+  ]
+```
+
+Or if you want to include them in the remappings.txt file, just put the file at the root of your project folder. Note: These will override your solidity settings if included
+![image](https://user-images.githubusercontent.com/562371/136204736-be94e8d8-1954-4981-891c-278145b27cdf.png)
+
+#### Platform specific remappings
+
+There are situations when cross-platform paths are needed, in this case you can use the ```solidity.remappingsWindows``` or ```solidity.remappingsUnix``` settings.
+
+```
+  "solidity.remappingsWindows": [
+    "@openzeppelin/=C:/Users/<USERNAME>/.brownie/packages/OpenZeppelin/openzeppelin-contracts@4.4.2"
+  ],
+  
+  "solidity.remappingsUnix": [
+    "@openzeppelin/=/Users/<USERNAME>/.brownie/packages/OpenZeppelin/openzeppelin-contracts@4.4.2"
+  ]
+  <<<OR>>> 
+  "solidity.remappingsUnix": [
+    "@openzeppelin/=/home/<USERNAME>/.brownie/packages/OpenZeppelin/openzeppelin-contracts@4.4.2"
+  ]
+```
+
+## Code completion
+
+Autocomplete is generally supported across for smart contracts, structs, functions, events, variables, using, inheritance. Autocomplete should happen automatically or press Ctrl+Space or Command+Space in areas like "import".
+
+![Screenshot](https://github.com/juanfranblanco/vscode-solidity/raw/HEAD/screenshots/simpleDemoAutocomplete.gif)
+
+## Auto compilation and error highlighting
+
+Auto compilation of files and error highlighting can be enabled or disabled using user settings. Also a default delay is implemented for all the validations (compilation and linting) as solidity compilation can be slow when you have many dependencies.
+
+```
+"solidity.enabledAsYouTypeCompilationErrorCheck": true,
+"solidity.validationDelay": 1500
+```
+
+## Go To definition
+To navigate to a definition, just press F12 or Ctrl + click to find a definition and navigate to it.
+
+## Hover information
+To find more information about a method, function, variable, contract etc, you can just hover over it with your mouse. Natspecs and comments are extracted for all types to provide you all the documentation required.
+
+![Screenshot](https://github.com/juanfranblanco/vscode-solidity/raw/HEAD/screenshots/solidity-hover.gif)
+
+## Goto references
+To find all usages of a specific type, method, etc you can press Shift + F12 or right click to find all references
+
+![Screenshot](https://github.com/juanfranblanco/vscode-solidity/raw/HEAD/screenshots/solidity-references.gif)
+
+## Code actions / quick fixes
+The extension provides some code actions and quick fixes, like change compiler, format address, add sdpx license, feel free to make pull requests with new ones!
+
+![Screenshot](https://github.com/juanfranblanco/vscode-solidity/raw/HEAD/screenshots/solidity-corrections.gif)
+
+## Download source code and ABI from Etherscan
+To download verified source code from Etherscan, you can right click on the folder area or in a soldity file. First select what chain the smart contract it(for example Ethereum) and then input the smart contract address. The source code will be saved in the root folder of your project. Please note that remappings will be generated for multiple files, so these might conflict with existing ones.
+
+![Screenshot](https://github.com/juanfranblanco/vscode-solidity/raw/HEAD/screenshots/solidity-etherscan-download.gif)
+
+## Solparse-Exp
+The extension uses https://github.com/juanfranblanco/solparse-exp as the main parser, this continues the work that many have done over the years. Tim Coulter, @cgewecke, @duaraghav8 @federicobond, as a Peg solidity parser in javascript.
+
+## Linting
+
+There are two linters included with the extension, solhint and solium / ethlint. You can chose your preferred linter using this setting, or disable it by typing ''
+
+![Screenshot](https://github.com/juanfranblanco/vscode-solidity/raw/HEAD/screenshots/select-linter.png)
+
+### Solhint
+
+To lint Solidity code you can use the Solhint linter https://github.com/protofire/solhint, the linter can be configured it using the following user settings:
+
+```json
+"solidity.linter": "solhint",
+"solidity.solhintRules": {
+  "avoid-sha3": "warn"
+}
+```
+
+This extension supports `.solhint.json` configuration file. It must be placed to project root 
+directory. After any changes in `.solhint.json` it will be synchronized with current IDE 
+configuration. 
+
+This is the default linter now.
+
+NOTE: Solhint plugins are not supported yet.
+
+### Solium / Ethlint
+
+Solium is also supported by the extension https://github.com/duaraghav8/Solium, you can configure it using the following user settings:
+
+```json
+"solidity.linter": "solium",
+"solidity.soliumRules": {
+    "quotes": ["error", "double"],
+    "indentation": ["error", 4]
+},
+```
+# Formatting using Prettier and the Prettier Solidity Plugin
+Formatting is provided thanks to the Prettier plugin for Solidity for more info check https://prettier.io/ and https://github.com/prettier-solidity/prettier-plugin-solidity
+
+Formatting uses the default formatting settings provided by prettier, if you want to provide your custom settings create a **.prettierrc** file as follows
+
+```json
+{
+  "overrides": [
+    {
+      "files": "*.sol",
+      "options": {
+        "printWidth": 80,
+        "tabWidth": 4,
+        "useTabs": true,
+        "singleQuote": false,
+        "bracketSpacing": true,
+        "explicitTypes": "always"
+      }
+    }
+  ]
+}
+```
+> :information_source: Settings are applied immediately on the latest version of the plugin. If your settings are not reflected immediately consider updating to the latest version, if it still doesn't work please restart visual studio code.
+
+If you would like to format on save, add this entry to your user / workspace settings:
+
+```"editor.formatOnSave": true```
+
+# Formatting using forge fmt
+Formatting can also be performed with `forge fmt` by [Foundry](https://getfoundry.sh/). You can configure it using a `foundry.toml` in your project directory as [explained in the Foundry book](https://book.getfoundry.sh/reference/config/formatter?highlight=fmt#formatter) and then choosing `forge` as your formatter in the extension settings:
+
+![image](https://user-images.githubusercontent.com/89424366/199959085-d7393779-801b-45d7-aebe-a9c4d25b1571.png)
+
+
+# Code generation Nethereum
+The extension integrates with the Nethereum code generator to create Contract integration definitions. You can either generate the api for a single contract, all compiled contracts, or automatically every time you compile a smart contract solidity file.
+
+The simplest way to code generate a the contract definition for a smart contract is to right click and select the project / language you require:
+
+![Screenshot](https://github.com/juanfranblanco/vscode-solidity/raw/HEAD/screenshots/compile-codegnerate-nethereum.png)
+
+## Automatic code generation and the Nethereum Code generation settings file.
+If you want to automatically code generate your api, every time to you compile, you can do this creating a file "nethereum-gen.settings" at the root of your project, with the following contents. You can create it automatically using the context menu too.
+
+```json
+{
+    "projectName": "Solidity.Samples",
+    "namespace": "Solidity.Samples",
+    "lang":0,
+    "autoCodeGen":true,
+    "projectPath": "../SoliditySamples"
+}
+```
+
+
+"lang" indicates what language to generate the code, 0 = CSharp, 1 = Vb.Net and 3 = FSharp
+
+The "projectName" and "namespace" settings will be used for the manual code generation also.
+
+Use the "projectPath" to set the relative path of your .Net project, this allows to work in a "solution" mode so you can work as an both in Visual Studio Code and Visual Studio (Fat) with your .Net project, or two windows of vscode.
+
+## Abi contract code generation
+You may have only the abi of a smart contract and want to code generate the contract definition. Just create a file containing the abi, with the extension ```.abi``` and another with the ```.bin``` content (if needed) and use this context menu. 
+
+![Screenshot](https://github.com/juanfranblanco/vscode-solidity/raw/HEAD/screenshots/abigeneration.png)
+
+
+## Single smart contract manual code generation
+To code generate the Nethereum contract api from a single smart contract, you need to select the compiled "json" output file from the "bin" folder, press F1 and start typing "Solidity: Code generate" and select what language you want to generate for the current selected file.
+
+## All smart contracts manual code generation
+To code generate the Nethereum contract for all smart contracts already compiled, just press F1, and start typing "Solidity: Code generate" and select the option for all contracts for your desired language.
+
+### (Deprecated) Analysis of smart contracts with Mythx
+Mythx analysis tool, has been moved to its own stand alone extension, [please download it here](https://marketplace.visualstudio.com/items?itemName=MythX.mythxvsc).
+
+## Contributing / Issues / Requests
+
+For ideas, issues, additions, modifications please raise an issue, if your change is significant please head to the Netherum discord for a chat https://discord.gg/u3Ej2BReNn. 
+Note: All contributions will be under the same project license.
+
+# Credits
+
+Many thanks to:
+
+Christian Reitwiessner and the Ethereum team for Solidity https://github.com/ethereum/solidity, for their amazing and none stop work. Thanks to them Ethereum and all the other EVM compatible chains are they way they are. This extension piggybacks on their work.
+
+Raghav Dua and everyone that contributed to Solium, the solidity linter, and the solidity parser.
+
+Ilya Drabenia for creating the Solhint linter and the integration into the extension.
+
+Nexus team for the original creation of the dappfile to structure contracts in projects https://github.com/nexusdev/dapple.
+
+Beau Gunderson for contributing the initial integration of solium  https://github.com/juanfranblanco/vscode-solidity/issues/24, the initial server and error mappings.
+
+Mattia Richetto, Klaus Hott Vidal and Franco Victorio for creating the Prettier Solidity plugin and of course all the developers of Prettier. Please go to https://github.com/prettier-solidity/prettier-plugin-solidity for help and collaboration.
+
+Bram Hoven for starting the multiple package dependency support for different environments (node_modules, lib)
+
+Piotr Szlachciak for refactoring the syntaxes
+
+James Lefrere for further refactoring the syntaxes.
+
+Forest Fang for providing the first implementation of the "Go to definition", allowing you to navigate to structs, contracts, functions calls, etc and we have used for years.
+
+Bernardo Vieira for adding the capability to read the solium settings from a file in the workspace root directory.
+
+Mirko Garozzo and Rocky Bernstein for the work on creating and integrating the Mythx api to analyse smart contracts (OBSOLETE NOW)
+
+Nick Addison, Elazar Gershuni, Joe Whittles, Iñigo Villalba, Thien Toan, Jonathan Carter, Stefan Lew, Nikita Savchenko, Josh Stevens, Paul Berg for their contributions.
+
+Sebastian Bürgel for keeping reminding me of the offline installation suppport
+
+David Krmpotic and Ralph Pichler for the original Sublime extension
+https://github.com/davidhq/SublimeEthereum
+
+
+
+Everyone for their support and feedback!