Before installing the Modest Toolset VSCode extension make sure you have downloaded the Modest Toolset and extracted it somewhere.
Start by installing the Modest Toolset VSCode extension from the VSCode marketplace or by adding the provided vsix file to your workspace, right clicking it and clicking `Install Extension VSIX`.
Start by installing the Modest Toolset VSCode extension from the VSCode marketplace(Not yet available while in beta) or by adding the provided vsix file to your workspace, right clicking it and clicking `Install Extension VSIX`.
After the extension has been installed open a modest file or the extension's sidebar. You will get an error message with a button that will take you to the settings. There you should enter the location where you installed the Modest Toolset. Make sure to provide the path the executable itself, called `modest.exe` on Windows and `modest` on Linux and macOS.
After the extension has been installed open a modest file or the extension's sidebar. You will get an error message with a button that will take you to the settings. There you should enter the location where you installed the Modest Toolset. Make sure to provide the path to the executable itself, called `modest.exe` on Windows and `modest` on Linux and macOS.
!!! WARNING
On macOS you may need to allow the Modest Toolset executable to run in the settings if you are not using a notarized version
...
...
@@ -57,6 +57,7 @@ Features
- Display information about certain words when hovering over it
- Renaming of variable, function and process names
- Code formatting
- Code snippets
- Refactoring support (extract constant/function/process/variable, surround with if/while/etc..) (See section [Refactoring])
- Document symbol highlighting
- Graphical user interface to run tools on files (see section [Sidebar])
...
...
@@ -81,10 +82,10 @@ The sidebar found by clicking the Modest Toolset logo in the bar on the left is
Next to the run button there is a dropdown that is automatically populated with the available tools.
### Open constants and extra parameters
Below the tool selection there is an expandable section containing the constants in your file that do not have an assigned value. The values specified here will be passed to the tool using it's experiment parameter. Below the open constants section there is a section where additional parameters like intervals for sampling expressions may be provided. The open constants and extra paramters are saved for each file seperately.
Below the tool selection there is an expandable section containing the constants in your file that do not have an assigned value. The values specified here will be passed to the tool using it's experiment parameter. Below the open constants section there is a section where additional parameters like intervals for sampling expressions may be provided. The open constants and extra paramters are saved for each file separately.
### Parameters
Below the additional parameters section the tool-specific parameters are shown. The available paramaters are automatically gathered from your Modest Toolset installation. The parameters are saved for each tool seperately.
Below the additional parameters section the tool-specific parameters are shown. The available parameters are automatically gathered from your Modest Toolset installation. The parameters are saved for each tool separately.
## DOT view
When a Modest file is opened a button will apear on the top right which opens the DOT view. This button will open a side-by-side view of the currently opened file and a DOT file generated by the Modest Toolset. You can also `Alt+Click` on the button open the DOT view in a regular, larger window.
...
...
@@ -115,16 +116,16 @@ You can change some aspects of the generated DOT by changing the parameters in t
!!! WARNING
This section is work in progress
There are two ways to view analysis results in the analysis results view. Open results JSON file, or run Modest file.
Second view is called Analysis Results Comparison View. Load results JSON file, or move the results from Analysis Results view.
In the analysis view, save results to a JSON or text file, open the JSON file directly in the editor (open in editor), clear view.
There are two ways to view analysis results in the analysis results view. You can open a results JSON file or you can run a Modest file.
The second view is called the Analysis Results Comparison View. Here you can also open a results JSON file or you can move the results from the Analysis Results view.
In the analysis view, you can save results to a JSON or text file, open the JSON file directly in the editor (open in editor), and clear view.
For each item in the analysis results, copy item which copies a text representation of the item, copy value copies the value if there is one, highlight item is to remember/quickly see where an item was in the tree. Values that can be plotted such as CDF can be plotted by pressing 'Plot value'.
## Refactoring
Refactoring options are accessed by selecting modest code, right clicking, and selecting "Refactor..." in the drop down menu (keyboard shortcut: `Ctrl+Shift+R`).
### Refactoring options
- You can surround your selection with an if, while, for, block -statement or surround it with parenthesis.
- You can surround your selection with an if, while, block -statement or surround it with parenthesis.
- There are also options to extract your selection to a constant, function, process, or variable. This can be extracted to the current scope, or to the main scope (if you are not in the main scope already).
There will be no refactoring options if your selection is empty, or if your selection is entirely within a comment.
