VS Code Tips: Difference between revisions

Content deleted Content added
 
(7 intermediate revisions by the same user not shown)
Line 7:
The TUFLOW plugin provides syntax highlighting support. <b>Thanks to Daniel Copelin for creating the TUFLOW plugin.</b> One feature of VS Code is that it includes an explorer window from a root folder, so it is easy to navigate the files within a project.<br>
==Install TUFLOW Plugin==
The <u>[https://marketplace.visualstudio.com/items?itemName=danielcopelin.tuflow TUFLOW pluginPlugin]</u> can be installed like any other VS Code plugins. In the VS Code application:
<ol>
<li>Select 'Extensions' from the toolbar on the right-hand side.
Line 20:
*Select File > Open Folder and navigate to the model folder. This will open the model folder into the 'Explorer' panel.
*Now, from the Explorer panel, it is possible to navigate through the model folders and edit control files.
*Using the '<u>[https://wikimarketplace.tuflowvisualstudio.com/w/index.phpitems?titleitemName=VS_Code_Tips&action=submit#Open_FileFr43nk.seito-openfile Open File]'</u> plugin, it is possible to easily navigate between files.
<br>
{{Video|name=Animation_file_navigation.mp4|width=900}}
Line 27:
 
==Running TUFLOW==
To run TUFLOW through VS Code, the <u>[https://marketplace.visualstudio.com/items?itemName=NilsSoderman.batch-runner Batch Runner]</u> extension is required. Once installed, TUFLOW can be run by either:
*Right clicking the batch file in the explorer panel and selecting 'Run Batch File', or
<br>
Line 41:
In addition to the TUFLOW plugin, some useful plugins for working with TUFLOW include: <br>
===Open File===
:*Open File by Frank Stuetzer or similar is a free plugin available for download <u>[https://marketplace.visualstudio.com/items?itemName=Fr43nk.seito-openfile here]</u>.
:*Right-click on a filename and select 'Open file under cursor'. If the file is found by VS Code, then the selected file will open in a new tab.
:*To open multiple files, hold down Alt while selecting the filenames, then right click and select 'Open file under cursor'. If the files are found by VS Code, then the selected files will each open in a new tab.
<br>{{Video|name=Animation_OpenFile.mp4|width=900}}
<br>
 
===Path Autocomplete===
:*Path Autocomplete by Mihai Vilcu is a free plugin available for download <u>[https://marketplace.visualstudio.com/items?itemName=ionutvmi.path-autocomplete here]</u>.
:*Adds auto-complete when it determines a filename is being written. For this feature to work, set the 'triggerOutsideStrings' to true (as described in the plugin details). <br>
<ol>
Line 53 ⟶ 54:
:<li>Toggle on the 'Trigger Outside Strings' in the settings on the right.
</ol>
:*An example of its functionality is shown below.
<br>{{Video|name=Animation_path_autocomplete.mp4|width=900}}
<br>
 
===Geo Data Viewer===
:*Geo Data Viewer by Random Fractals inc is a free plugginplugin available for download <u>[https://marketplace.visualstudio.com/items?itemName=RandomFractalsInc.geo-data-viewer here]</u>.
:*Has the ability to view a map of GIS layers right inside of VS Code. This is helpful for double checking that the layer looks correct without loading it into a GIS application.
:*An example of its functionality is shown below.
<b>Note:</b> This extension only supports certain file formats, including Shapefile. It does not support GeoPackage or GeoTiff files.
<br>{{Video|name=Animation_geo_data_viewer.mp4|width=900}}
<br>