Skip to content

Commit 68439f8

Browse files
committed
Edits to VSCode Section
1 parent 394e0a9 commit 68439f8

File tree

1 file changed

+41
-5
lines changed

1 file changed

+41
-5
lines changed

RecommendedEditors.md

+41-5
Original file line numberDiff line numberDiff line change
@@ -146,27 +146,63 @@ lacking usability. VS Code seems to be a good choice for front-end and NodeJS
146146
developers. In many regards, Visual Studio Code has a nicer feature set than
147147
Atom.
148148

149-
The following extensions are recommended for use with Visual Studio Code and
150-
KBase projects. Install them by using shift-ctrl/cmd-X or the extensions icon
149+
The following extensions are recommended for use with Visual Studio Code and KBase projects. Install them by using ctrl-shift-p/cmd-shift-p to open the command window and entering "extensions: install extensions" or by clicking the extensions icon
151150
on the left panel.
152151
* [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
153152
* [Python](https://marketplace.visualstudio.com/items?itemName=donjayamanne.python) - this extension properly works with per project tox.ini files, making Visual Studio Code preferable for Python projects
153+
* [Docker](https://marketplace.visualstudio.com/items?itemName=PeterJausovec.vscode-docker)
154154

155155
For emacs users, the following extension adds emacs keybindings:
156156
* [vscode-emacs](https://marketplace.visualstudio.com/items?itemName=hiro-sun.vscode-emacs)
157157

158158

159+
If you would like to use the same editor for Java as well, though this is not yet fully functional for all proejct types:
160+
* https://code.visualstudio.com/docs/languages/java
161+
* [Java-Extension-Pack](https://marketplace.visualstudio.com/items?itemName=vscjava.vscode-java-pack)
162+
Currently it will work well if you first open a java project in eclipse (and make sure all jars are referenced properly) and then later open it in VScode (it can read the files eclipse creates to understand the classpath)
163+
159164
VS Code has a built in Markdown preview - from any markdown file,
160165
pressing ctrl-shift-V ( command-shift-V on Macs) will toggle between markdown
161166
source code and a fully rendered markdown preview.
162167

163-
The standard github support in VS Code seems to work well without additional
164-
extensions.
168+
The standard github support in VS Code works well without additional
169+
extensions, but if you want even more in editor Git:
170+
* [git-lens](https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens)
165171

166-
Sadly there isn't a minimap extension available for VS Code.
172+
Code minimap is a built in feature now.
167173

168174
VS Code has many features built in, these tutorials are a good starting point:
169175

170176
* https://code.visualstudio.com/docs/editor/codebasics
171177
* https://code.visualstudio.com/docs/languages/python
172178
* https://code.visualstudio.com/blogs/2016/02/23/introducing-chrome-debugger-for-vs-code
179+
180+
Configuration in done through Json files, workspace settings will ovveride global settings so if you want different globals than these configurations add them to workspace settings for your project
181+
* For Python you will need to enable Flake8 Support and possibly configure your python path
182+
* If you are editing an app created using the KBase SDK then any modules you install will not be available by default to intellisense so you will need to add the lib directory: "python.autoComplete.extraPaths": ["lib/"]
183+
184+
To open these files use ctrl-shift-p/cmd-shift-p and enter "preferences: open workspace settings" or "preferences: open user settings
185+
186+
an example global Json
187+
```Json
188+
{
189+
"terminal.integrated.fontFamily": "Fira Code",
190+
"editor.fontFamily": "'Fira Code'",
191+
"editor.fontSize": 14,
192+
"editor.fontLigatures": true,
193+
"workbench.iconTheme": "vscode-icons",
194+
"python.pythonPath": "python2",
195+
"python.linting.flake8Enabled": true
196+
}
197+
```
198+
And workspace for SDK App
199+
```Json
200+
{
201+
"python.autoComplete.extraPaths": [
202+
"lib/"
203+
]
204+
}
205+
```
206+
207+
VSCode also comes with an integrated visual debugger, debugging remotely or inside of Docker can take some configuration so there is seperate documentation for doing that
208+
* [remote-debug](remote_debug.md)

0 commit comments

Comments
 (0)