Skip to content

SnapSettle/VscNix

Repository files navigation

VSCNix

VSCNix is a lightweight VS Code extension that streamlines your Nix workflow by automatically activating your environment when a Nix file is detected in your project.

Warning

Early Development!! Features and configurations are subject to change as the codebase evolves.

🚀 Key Features

  • Smart Detection: Automatically identifies shell.nix or default.nix in your workspace root.
  • One-Click Activation: Prompts to enter the nix-shell environment so your tools and dependencies are immediately available.
  • Integrated Workflow: Ensures your VS Code integrated terminal inherits the Nix environment variables.

🛠 Developers

Set of instructions and rules are defined that must be followed when developing, helping or maintaining this project. Please refer to DEVELOPERS.

📖 How it Works

VSCNix monitors your workspace for Nix configuration files. Upon detection, it utilizes nix-shell to pull in the defined environment, ensuring that your compilers, linters, and libraries are correctly mapped within the VS Code context.

⚙️ Requirements

  • Nix: You must have Nix installed on your host machine.
  • Linux/macOS: Currently optimized for Unix-based systems where Nix is natively supported.

🗺 Roadmap

  • Support for Nix Flakes (flake.nix).
  • Configurable "Auto-Activate" settings.
  • Improved error handling for complex Nix expressions.

About

❄️ Lightweight VS Code extension that streamlines your Nix workflow by automatically activating your environment when a Nix file is detected in your project.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors