README.md

devonfw VS Code extensions

The extensions included in this pack involve several aspects as Remote Development, Team Collaboration, Project Management, Genarative AI to assist in coding, devonfw projects development, support for other interesting languages and technologies, code running, testing, linting and IDE configuration:

IMPORTANT: Please, remember to disable any of the following extensions in your workspace in case you are not allowed to use third party tools that require send code fragments to external services. More info at https://code.visualstudio.com/docs/editor/extension-marketplace#_manage-extensions.

• Remote Development

  • Visual Studio Code Remote Development Extension Pack

• Team Collaboration

  • VS Live Share Extension Pack
    • Please read the following instructions https://docs.microsoft.com/en-us/visualstudio/liveshare/use/vscode

• Project Management

  • Project Manager

• Gen AI

  • Twinny

    • In order to use Twinny and run a LLM for free and locally without external communication, please follow the next steps:

      1. Set up Ollama as the backend by default: Install Ollama
      2. Select your model from the Ollama library (e.g., codellama:7b-instruct for chats and codellama:7b-code for auto complete).

      $ ollama run codellama:7b-instruct
      $ ollama run codellama:7b-code

      3. Open VS Code (if already open a restart might be needed) and press Ctrl/Command + Shift + T to open the side panel.

      You should see the 🤖 icon indicating that twinny is ready to use.

      4. See Keyboard shortcuts to start using while coding 🎉

      For other providers and other configuration alternatives, please check official documentation.

• Code and documentation helpers

  • Path Intellisense

  • Prettier - Code formatter

    • In order to avoid TS lint errors, you must set the prettier.singleQuote and prettier.semi variables to true in the VS Code User Settings (Keyboard shortcut Ctrl+, in Windows and Linux or Cmd+, in macOS or press F1 and start writing User settings).
    • Another useful feature to avoid TS lint errors is to set the prettier.trailingComma variable to all to trail commas wherever possible.
    • Besides this, a .prettierrc JSON file can be included in the root folder of any Angular project with the following configuration:

    {
      "singleQuote": true,
      "trailingComma": "all",
      "arrowParens": "always",
      "semi": true
    }

    • Last but not least, the prettier configuration can be also included in every JavaScript/TypeScript project inside the package.json file adding its own key:

    "prettier": {
      "singleQuote": true,
      "trailingComma": "all",
      "arrowParens": "always",
      "semi": true
    }

    • Refer to the official documentation https://prettier.io/docs/en/configuration.html for further details.

  • Document This

  • Search Docsets

  • TODO Highlight

  • FreeMarker

  • Polacode

    • Please follow the instructions to configure properly this extension.

  • Dependency Analytics

    • This extension assumes that you have the binaries npm and mvn on your PATH.

  • Print

  • Error Lens

• Code linting

  • ESLint
  • SonarLint
  • Accessibility linting for HTML, Angular, React, Markdown, Vue, and React Native axe Accessibility Linter

• Code runners

  • Code Runner

• JavaScript and TypeScript

  • Angular Snippets

  • Angular Language Service

  • ES7 React/Redux/GraphQL/React-Native snippets

  • Jest

    • In Linux/Mac environments and you use nvm as node.js version manager, if you get an error of kind /usr/bin/env: ‘node’: No such file or directory you can use the following setting to fix it:

    "jest.nodeEnv": {
      "PATH": "add here your local environment path with nvm"
    },

  • Import Cost

  • Nx Console for monorepos. More info at https://nx.dev/latest/angular/getting-started/console.

  • Pretty TypeScript Errors

• SCSS and CSS

  • Stylelint
  • SCSS IntelliSense

• Git

  • Git History
  • GitHub Pull Requests
  • Git Graph

• Swagger and API definition

  • OpenAPI (Swagger) Editor
  • REST Client

• UML

  • PlantUML

• Rust

  • rust-analyzer

• Python

  • Python
  • Pylance
  • Jupyter

• C++

  • C/C++

• .NET

  • .NET Extension Pack
  • C# Dev Kit

• Java

  • Java Extension Pack
  • Spring Boot Extension Pack
  • Community Server Connectors
  • Lombok
  • In order to make Java work properly you must set the java.home variable in the VS Code User Settings (Keyboard shortcut Ctrl+, in Windows and Linux or Cmd+, in macOS or press F1 and start writing User settings)
  • In order to check the Java extensions for VS Code and test others available you can press F1 and choose Java: Extension Guide.

• Docker

  • Docker

• Kubernetes

  • Kubernetes

• Themes

  • Cobalt2 Theme Official - Press F1, choose Color Theme option and select Cobalt.
  • Noctis - collection of light & dark themes - Press F1, choose Color Theme option and select one of multiple schemes beginning with Noctis.
  • GitHub Theme - Press F1, choose Color Theme option and select one of multiple schemes beginning with GitHub.
  • vscode-icons - Press F1, choose File Icon Theme option and select VSCode Icons.

• AsciiDoc

  • AsciiDoc

• XML

  • XML

• YAML

  • YAML

• Miscellaneous

  • SpellChecker
  • LineCount
  • Lorem ipsum
  • Resource Monitor
  • Draw.io Diagram Editor
    • Embedded version of the Draw.io graphical diagram editor. Uses an offline version of Draw.io by default.

Requirements

Microsoft Visual Studio Code

In order to install this package Microsoft Visual Studio Code 1.51.0 at least must be installed. It is recommended to upgrade VS Code in any case.

Python support

The new Python extensions enable VS Code as a 1st class citizen Python IDE. We recommend to use tools like pyenv (here for Linux/macOS or here for Windows) to install multiple Python versions and make it local to every project.

C/C++ support

See C/C++ for Visual Studio Code for a Guide on how to configure and use the extension enabling C/C++ support for Visual Studio Code. This provides support for cross-platform C and C++ development using VS Code on Windows, Linux, and macOS.

AsciiDoc support

AsciiDoc extension comes with Asciidoctor.js library for preview bundled. If you want to use the Ruby version of Asciidoctor you need to change the AsciiDoc.use_asciidoctor_js setting to false.

In order to be able to use the AsciiDoc Ruby version you have to install Ruby on your system and the Asciidoctor tool running the following command in the terminal:

gem install asciidoctor