UV Wingman
This is the README for the extension UV Wingman.
This extension aims to help VSCode users manage and interact with UV environments.
UV Wingman aims to add QoL improvements that help programmers use environments without having to memorize all of the UV commands.
Features
UV Wingman dynamically adds status bar items for quick UV command access when a requirements.txt file is open, simplifying UV environment management directly within VSCode.
Supports 7 major terminal shells out of the box:
PowerShell, Command Prompt (cmd), Git Bash, WSL, Bash, Zsh, and Fish.
These can also be accessed from the VSCode command palette:
The supported commands are:
Creating Environments
Command: Create a UV environment from the open requirements file by running: uv env create -f YOUR-REQUIREMENTS.TXT
VS Code Command Palette: >UV Wingman: Build UV Environment from requirements.txt file
Activating Environments
Installing Packages
Writing Requirements Files
Command: Export the active UV environment to a requirements file with: uv pip freeze > YOUR_REQUIREMENTS_FILE
VS Code Command Palette: >UV Wingman: Write a requirements.txt file from the active UV Environment
Deleting Environments
- Command: Remove an existing UV environment by first deactivating, then removing it with:
deactivate then rm -rf .venv
- VS Code Command Palette:
>UV Wingman: Delete UV Environment
JS Files Explained
src/commands.js
Contains the implementation of all command palette actions provided by the extension. This includes registering commands, handling user input, and invoking the appropriate logic for each command. It acts as the central hub for user-triggered features, ensuring that commands are properly integrated with VS Code’s API and the rest of the extension.
src/extension.js
The main entry point for the extension. This file is responsible for activating the extension when VS Code starts or when a relevant event occurs. It registers all commands, sets up event listeners, and manages the extension’s lifecycle. It ensures that all features are initialized and available to the user.
src/statusBarItems.js
Manages the creation and updating of custom status bar items in VS Code. These items provide quick access to frequently used UV actions and display relevant status information. The file handles user interactions with the status bar and updates the UI in response to changes in the workspace or extension state.
src/utils.js
Provides utility functions used throughout the extension. This includes helpers for running terminal commands, checking file existence, formatting output, and other common tasks. By centralizing these utilities, the codebase remains DRY (Don’t Repeat Yourself) and easier to maintain.
src/uv_commands.js
Implements functions that interact directly with the UV package manager. This includes commands for building, installing, writing, and removing environments. The file abstracts the details of invoking UV commands, handling their output, and reporting results back to the user or other parts of the extension.
src/terminalCommands.js
Centralizes all terminal-specific command templates and logic. This file detects the current terminal type (PowerShell, CMD, Git Bash, etc.) and provides the correct command syntax for each operation (such as activating environments, installing packages, or removing directories). By isolating terminal differences here, the rest of the extension can remain terminal-agnostic and easier to maintain.
Release Notes
See CHANGELOG for more information.
Contributing
All contributions are welcome!
Please feel free to fork the repository and create a pull request.
License
Distributed under the MIT License. See LICENSE for more information.
Author
David Saunders - 2024
