==================
Visual Studio Code
==================

Extensions
==========

To increase your productivity, the following extensions are recommended depending on what you're doing:

.. list-table:: General extensions
   :widths: auto
   :header-rows: 1

   * - Name
     - Description
     - Install

   * - reStructuredText
     - linter, preview, IntelliSense and more
     - `Install <vscode:extension/lextudio.restructuredtext>`__

   * - Code Spell Checker
     - Spelling checker for source code
     - `Install <vscode:extension/streetsidesoftware.code-spell-checker>`__

   * - GitLens
     - Supercharge the Git capabilities built into Visual Studio Code
     - `Install <vscode:extension/eamodio.gitlens>`__

   * - Paste Image
     - paste image from clipboard directly
     - `Install <vscode:extension/mushan.vscode-paste-image>`__

   * - Task Explorer
     - Manage tasks
     - `Install <vscode:extension/spmeesseman.vscode-taskexplorer>`__

   * - Visual Studio IntelliCode
     - AI-assisted development
     - `Install <vscode:extension/visualstudioexptteam.vscodeintellicode>`__


.. list-table:: Extensions for Python
   :widths: auto
   :header-rows: 1

   * - Name
     - Description
     - Install

   * - Python
     - Linting, Debugging, Intellisense and more
     - `Install <vscode:extension/ms-python.python>`__

   * - Python Docstring Generator
     - Automatically generates detailed docstrings for python functions
     - `Install <vscode:extension/njpwerner.autodocstring>`__

   * - Python Indent
     - Correct python indentation.
     - `Install <vscode:extension/kevinrose.vsc-python-indent>`__


Paste Image configuration
-------------------------

If you're writing RST documentation, add the following lines in the local project settings
(``.vscode/settings.json``) for the `Paste Image` extension to automatically save clipped
image in the `img` folder of the current directory. Use :kbd:`Ctrl+Alt+V` to paste the image.

.. code-block:: json

   {
     "pasteImage.path": "${currentFileDir}/img",
     "pasteImage.insertPattern": ".. figure:: ${imageSyntaxPrefix}${imageFilePath}${imageSyntaxSuffix}"
   }


Integrate Cmder terminal
========================

Create ``CMDER_ROOT`` environment variable pointing to the Cmder installation directory.

Create the file ``%CMDER_ROOT%\vendor\bin\vscode_init.cmd`` with the content from https://gitlab.hevs.ch/snippets/3

Create the file ``%CMDER_ROOT%\vendor\bin\vscode_init_args.cmd.default.cmd``
with the content https://gitlab.hevs.ch/snippets/4

Finally add the following in VSCode settings:

.. code-block:: json

   {
     "terminal.integrated.shell.windows": "cmd.exe",
     "terminal.integrated.shellArgs.windows": [
       "/k",
       "%CMDER_ROOT%\\vendor\\bin\\vscode_init.cmd"
     ]
   }

(`Source <https://github.com/cmderdev/cmder/wiki/Seamless-VS-Code-Integration>`_)

:tag:`VSCode`
:tag:`Tool`