Humanitec VSCode Extension

Overview

Welcome to the Humanitec Platform VSCode Extension! This extension is designed to enhance your experience when working with the Humanitec Platform Orchestrator directly from Visual Studio Code. It provides a set of features to simplify your workflow, making it easier to manage your applications, components, and configurations.

Features

1. Display Available Resource Types

Quickly view all available resource types that developers can use in Score files. This feature provides a comprehensive list, aiding in the efficient selection and utilization of resources in your applications.

2. Validate Score Files

Ensure the correctness of your Score files by leveraging the built-in validation feature. Detect and fix errors early in the development process to simplify your deployment workflow.

3. Open Preconfigured Terminal

Open a preconfigured terminal directly from Visual Studio Code, tailored to your Humanitec Platform environment. This allows you to execute commands and interact with the Terraform or Humanitec CLI seamlessly.

4. Display Resource Graph of Deployed Application

Visualize the resource graph of your deployed application directly within VSCode. Gain insights into the relationships between resources, making it easier to understand and manage your application architecture.

5. Easy Switch Between Orgs/Apps/Envs

Effortlessly switch between different organizations, applications, and environments with a simple and intuitive interface. This feature simplifies the navigation process, allowing you to focus on your development tasks.

Getting Started

Prerequisites

• Visual Studio Code installed
• Humanitec Platform account

Installation

The preferred way to install the extension in VS Code is through the Extensions Manager built into the editor or directly from the Visual Studio Marketplace. This ensures safe, verified installations and easy updates.

Configuration

1. Open Visual Studio Code.
2. Login to the Humanitec Platform by pressing Ctrl/Cmd+Shift+P and using Humanitec: Login command.
3. Open Humanitec side and set context by right-clicking to the element of the Organization structure and choosing Set in workspace option.
4. You're ready to go!

Debug

To run the VSCode Extension from code in debug mode:

1. Open this repository in Visual Studio Code.
2. Build all webview applications:
   1. Navigate to webview/[webview application name].
   2. Run npm install.
   3. Run npm run start (for development) or npm run build (for production).
3. Build the VSCode Extension:
   1. Navigate to the root folder of the repository.
   2. Run npm install.
   3. Run npm run watch (for development) or npm run build (for production).
4. Select the Run and Debug tab from the VSCode sidebar.
5. Click the Start Debugging button.
6. A new VSCode window will open with the debug version of the extension installed.

Feedback and Issues

We welcome your feedback and encourage you to report any issues you encounter. Feel free to open an issue on our GitHub repository.

License

This extension is licensed under the Apache License 2.0.

Happy coding with Humanitec and Visual Studio Code!