Codewind for VS Code

Create and develop cloud-native, containerized web applications from VS Code.

Installing Codewind

You can install Codewind locally in VS Code. For more information about installing Codewind, see Installing Codewind for VS Code.

Prerequisites

• Install VS Code.
• Install Docker.
• If you use Linux, you also need to install Docker Compose.

Complete the installation:

1. Find Codewind for VS Code in the VS Code Marketplace or by searching for Codewind in the VS Code Extensions view.
2. Open the Codewind view in the Explorer view group or enter Focus on Codewind View into the Command Palette. If you do not see the Codewind view in either the Explorer view or the Command Palette, the extension did not install correctly.
3. Codewind requires the installation of additional Docker images to run. Choose Install when prompted to complete the installation. The installation may take a few minutes to complete. Codewind creates a folder called codewind-workspace within your home directory to contain your projects. On Windows, this is the C:\codewind-workspace directory. When the installation is complete, you can open the codewind-workspace folder or a project within the workspace as your VS Code workspace. The tools offer to open the workspace for you if it’s not open already.

Using Codewind for VS Code

To see the actions available, open the Command Palette and type Codewind.

Features:

• Create New Project and Add Existing Project: Create new projects from application templates or import existing container-ready projects.
• Codewind view: View Codewind projects, including application and build statuses.
• Attach debugger: Debug Microprofile, Spring, and Node.js projects in their containers.
• Show all logs: View application and build logs in the VS Code Output view.
• Open folder as workspace: View and edit project deployment information.
• Open container shell: Open a shell session into a Codewind application container.
• Toggle auto build: Toggle project auto build and manually initiate project builds.
• Enable or disable project and Show project overview: Disable, enable, and delete projects.

Contributing

Submit issues and contributions:

• Submitting issues
• Contributing
• Development Builds
• Jenkins

Developing

• To host the extension yourself so you can develop or debug it, clone this repository and run the Extension launch in dev/.vscode/launch.json. See Developing Extensions for more information.
• If not run using the Extension launch, the tools will pull the latest Codewind release tag, eg. 0.3 (see DEFAULT_CW_TAG). To run against the latest development version of Codewind:
  1. Start Codewind using run.sh or start.sh.
  2. From a terminal, run export CW_TAG=latest (or your Windows equivalent).
  3. Close all instances of VS Code.
  4. Launch VS Code (code) from the same shell so the environment is picked up.
• You can also build the extension .vsix yourself by running vsce package from dev/. Refer to the Jenkinsfile to see the exact steps the build runs.
• The extension bundles dependency executables. These are gitignored, but should be kept up-to-date on your local system with the same versions used in the Jenkinsfile parameters section. Run dev/bin/pull.sh to download the dependencies. Also see dev/bin/README.txt.
• The prebuild script is used in the CI builds to build separate versions of the extension for VS Code and Theia, since each of those has some commands that the other does not. It deletes inapplicable commands from the package.json, and does not modify any ts/js code. Run this before vsce package to get a closer-to-production build, but be ready to revert the changes.

Building Codewind from the source

1. Clone the codewind repository.
2. Clone the codewind-vscode repo.
3. Run codewind/script/build.sh to run the Codewind build, or run codewind/run.sh to build and start Codewind.
4. Run the extension by following the instructions in Developing.