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

package/dist/assets/pgourlain.erlang-0.9.8.vsix/README.md

@@ -0,0 +1,101 @@
+# Erlang for Visual Studio Code
+
+This extension adds support for the Erlang language to Visual Studio Code, including editing, building and debugging.
+
+## Editing support
+
+- Syntax highlighting
+- Automatic indentation
+- Erlang IntelliSense
+- Shows errors and warnings dynamically while you type
+- Go To Definition/Peek Definition
+- Hover help for standard functions
+- Hover for project functions showing head clauses
+- CodeLens showing exported functions and references
+- InlayHints showing parameters name in function calls
+  - disable by default : enable in configuration settings
+  - limits : only works with locals calls
+
+![editing](https://github.com/pgourlain/vscode_erlang/raw/HEAD/images/vscode-erlang-editing.gif)
+
+InlayHints in function calls
+
+![inlayHints](https://github.com/pgourlain/vscode_erlang/raw/HEAD/images/vscode-erlang-inlayhints.png)
+- showing parameter name when it doesn't match with caller var name
+
+## Build
+
+![build](https://github.com/pgourlain/vscode_erlang/raw/HEAD/images/vscode-erlang-build.png)
+
+- Standard rebar3 is the default build tool, also rebar is supported. The rebar.config file should be placed in the root directory.
+- Build arguments are configurable, by default "compile" is used
+- You can override the default in configuration file (i.e. workspace settings)
+
+![build](https://github.com/pgourlain/vscode_erlang/raw/HEAD/images/vscode-erlang-build-args.png)
+
+## Debugger
+
+- Variables List shows variables from the current scope
+- Call Stack shows Erlang processes and allows to control them with e.g. Pause and Continue
+- Standard commands Step Over, Step Into, Step Out supported
+- Full breakpoints support:
+  - Regular breakpoints
+  - Function Breakpoints: use format module:function/arity
+  - Conditional Breakpoints
+  - Hit-Count Breakpoints
+
+![debug-inlinevalues](https://github.com/pgourlain/vscode_erlang/raw/HEAD/images/vscode-erlang-inlinevalues.png)
+
+## Running debugger
+
+You can provide a specific command line to 'erl' in launch.json configuration file in "arguments" entry.
+
+![debug1](https://github.com/pgourlain/vscode_erlang/raw/HEAD/images/vscode-erlang-debug-args.png)
+
+The modified code may be automatically build before debugger is started. To set automatic build up you need to:
+
+1. Add to launch.json file the entry "preLaunchTask": "rebar3 compile"
+1. Select **Configure Task** in the alert, choose **Create tasks.json file from template** and then **Others: Example to run an arbitrary command**
+1. This will create tasks.json for you. Change both label and command to "rebar3 compile".
+1. Add entry "problemMatcher": "$erlang"
+
+![debug](https://github.com/pgourlain/vscode_erlang/raw/HEAD/images/vscode-erlang-build-task.png)
+
+Then, before debugging is started, modified files will be recompiled automatically.
+
+## Using this extension in Erlang Docker instance
+
+Clone this repo, and try it :
+- [vscode-remote-try-erlang](https://github.com/pgourlain/vscode-remote-try-erlang)
+
+For more informaiton about vscode and containers :
+- [setup vscode for containers](https://code.visualstudio.com/docs/containers/overview) and [remote container documentation](https://code.visualstudio.com/docs/remote/containers)
+
+## Available commands
+
+Support for Erlang tools, including rebar3, EUnit and Dialyzer
+
+![commands](https://github.com/pgourlain/vscode_erlang/raw/HEAD/images/vscode-erlang-commands.png)
+
+- Dialyzer warnings displayed in Problems tab for easy navigation
+
+## Settings
+
+- `erlang.erlangPath` - Directory location of erl/escript
+- `erlang.erlangArgs` - Arguments passed to Erlang backend
+- `erlang.erlangDistributedNode` - Start the Erlang backend in a distributed Erlang node for extension development
+- `erlang.rebarPath` - Directory location of rebar/rebar3
+- `erlang.rebarBuildArgs` - Arguments to provide to rebar/rebar3 build command
+- `erlang.includePaths` - Include paths are read from rebar.config, and also standard set of paths is used. This setting is for special cases when the default behaviour is not enough
+- `erlang.linting` - Enable/disable dynamic validation of opened Erlang source files
+- `erlang.codeLensEnabled` - Enable/Disable CodeLens
+- `erlang.inlayHintsEnabled` - Enable/Disable InlayHints
+- `erlang.verbose` - Activate technical traces for use in the extension development
+
+## Help
+
+[Some configuration tricks](https://github.com/pgourlain/vscode_erlang/blob/HEAD/HELP.MD)
+
+## Credits
+
+File 'Erlang.tmLanguage' is inspired from <https://github.com/textmate/erlang.tmbundle/blob/master/Syntaxes/Erlang.plist>