Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/arrterian/nix-env-selector
Allows switch environment for Visual Studio Code using Nix Package Manager.
https://github.com/arrterian/nix-env-selector
ide nix nix-env nix-shell switch-environment visual-studio-code vsc vscode-extension workspace workspace-env
Last synced: 2 months ago
JSON representation
Allows switch environment for Visual Studio Code using Nix Package Manager.
- Host: GitHub
- URL: https://github.com/arrterian/nix-env-selector
- Owner: arrterian
- License: mit
- Created: 2019-09-26T15:36:28.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-03-02T00:48:42.000Z (11 months ago)
- Last Synced: 2024-05-21T08:25:54.065Z (8 months ago)
- Topics: ide, nix, nix-env, nix-shell, switch-environment, visual-studio-code, vsc, vscode-extension, workspace, workspace-env
- Language: Clojure
- Homepage:
- Size: 5.5 MB
- Stars: 215
- Watchers: 4
- Forks: 29
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# 🇺🇦 Support Ukraine 🇺🇦
Hi folks,
My name is Roman Valihura. I'm the author of this extension. I'm Ukrainian.
I was born in Ukraine. I'm living here at the moment.
As you all know Russia invaded my country.
Russia has already killed thousands of civilians and continues the war and terror in Ukraine.
I have the luck that my region is pretty far from the frontline. But even here, I'm living in the air-alarm reality.
The reality where you should wake up in the middle of the night and go into the shelter. Because a rocket flies over your region.
Like a lot of Ukrainians now I became a volunteer in this hard time for my country.
We with a team producing Individual First Aid Kits for the Ukrainian army.
If you have a wish and ability to support the activity, you can make a donation on our website, which we made to collect funds for producing First Aid Kits.
More datails on the [aidkit.shop](https://aidkit.shop)
Thank you for your attention!
# Nix Environment Selector
Extension that lets you use environments declared in .nix files in Visual Studio Code.
## Motivation
Nix package manager provides a way of creating isolated
environments with a specific configuration of packages.
These environments are usually activated in the terminal
and are not convenient to use within an IDE.
One option is to run `nix-shell` on the command line and then
launch `code` within the activated shell.
However, this process can quickly become tedious.
`Nix Environment Selector` provides an alternative: can automatically apply the environment.
## Getting started
- Install [Nix package manager](https://nixos.org/nix/).
- Restart VS Code (to make sure that `nix-shell` is in the PATH)
- [Install the extension](https://marketplace.visualstudio.com/items?itemName=arrterian.nix-env-selector).
- Create the Nix environment config (like `default.nix` or `shell.nix`) in
the root of your project's workspace.
- Open Command Palette (Ctrl + Shift + P)
and run `Nix-Env: Select Environment` command.
- Choose the Nix environment you'd like to apply.
- Wait for the environment to build.
- Restart VS Code to apply the built environment.
## Example
### Haskell project
To run a Haskell application you need to have **GHC** (Haskell compiler) installed.
With Nix package manager we can create an isolated environment containing only
the GHC version and the dependencies that the project needs without
polluting the user's environment.
Environment configuration in `shell.nix`:
```nix
{ pkgs ? import { } }:
with pkgs;
let
haskellDeps = ps: with ps; [
base
lens
mtl
random
];
haskellEnv = haskell.packages.ghc865.ghcWithPackages haskellDeps;
in mkShell {
buildInputs = [
haskellEnv
haskellPackages.cabal-install
gdb
];
}
```
Now let's try to open our project in Visual Studio Code.
As you can see VS Code can't find the GHC compiler. Let's apply
the environment declared in `shell.nix`.
Bingo 🎉🎉🎉. Everything is working now 😈
## Configuration
You can configure the extension in `.vscode/settings.json`
file (located in the root of the workspace). Here are the configuration settings:
| Setting | Default | Description |
| ----------------------------- | ------- | ------------------------------------------------------------- |
| `nixEnvSelector.nixFile` | null | Path to the Nix config file |
| `nixEnvSelector.packages` | [] | List packages using as `-p` nix-shell args |
| `nixEnvSelector.args` | null | Custom args string for nix-shell. EX: `-A --pure` |
| `nixEnvSelector.nixShellPath` | null | Custom path for nix-shell executable |
## Supported Platforms
- MacOS
- Linux
- Windows (with `Remote - WSL` extension)
## Support
If you like the extension and want to support author, click the button bellow.
## License
[MIT](LICENSE)