nix-community/nix-direnv
1
0
Fork 0
mirror of https://github.com/nix-community/nix-direnv.git synced 2025-12-25 02:11:03 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #424 from nix-community/treefmt

Browse source 
replace lint with treefmt
This commit is contained in:
Jörg Thalheim 2023-11-29 07:53:04 +01:00 • committed by GitHub
commit bf686af698
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
12 changed files with 215 additions and 141 deletions
Download patch file Download diff file Expand all files Collapse all files

7
.mergify.yml
View file

@ -1,12 +1,7 @@
queue_rules:
- name: default
merge_conditions:
- check-success=Evaluate flake.nix
- check-success=check lint [x86_64-linux]
- check-success=devShell default [x86_64-linux]
- check-success=package default [x86_64-linux]
- check-success=package test-runner-stable [x86_64-linux]
- check-success=package test-runner-unstable [x86_64-linux]
- check-success=buildbot/nix-eval
- check-success=tests (ubuntu-latest, stable)
- check-success=tests (ubuntu-latest, unstable)
defaults:

166
README.md
View file

@ -2,29 +2,30 @@
![Test](https://github.com/nix-community/nix-direnv/workflows/Test/badge.svg)
A faster, persistent implementation of `direnv`'s `use_nix` and `use_flake`,
to replace the built-in one.
A faster, persistent implementation of `direnv`'s `use_nix` and `use_flake`, to
replace the built-in one.
Prominent features:
- significantly faster after the first run by caching the `nix-shell` environment
- significantly faster after the first run by caching the `nix-shell`
environment
- prevents garbage collection of build dependencies by symlinking the resulting
shell derivation in the user's `gcroots` (Life is too short to lose
your project's build cache if you are on a flight with no internet connection)
shell derivation in the user's `gcroots` (Life is too short to lose your
project's build cache if you are on a flight with no internet connection)
## Why not use `lorri` instead?
Compared to [lorri](https://github.com/nix-community/lorri),
nix-direnv is simpler (and requires no external daemon) and supports flakes.
Additionally, lorri can sometimes re-evaluate the entirety of nixpkgs on every change
(leading to perpetual high CPU load).
Compared to [lorri](https://github.com/nix-community/lorri), nix-direnv is
simpler (and requires no external daemon) and supports flakes. Additionally,
lorri can sometimes re-evaluate the entirety of nixpkgs on every change (leading
to perpetual high CPU load).
## Installation
> **Heads up**: nix-direnv requires a modern Bash and GNU Grep.
> MacOS ships with outdated or non-GNU versions of these tools,
> As a work-around we suggest that macOS users install `direnv`/`grep` via Nix or Homebrew.
> Discussion of these problems can be found
> **Heads up**: nix-direnv requires a modern Bash and GNU Grep. MacOS ships with
> outdated or non-GNU versions of these tools, As a work-around we suggest that
> macOS users install `direnv`/`grep` via Nix or Homebrew. Discussion of these
> problems can be found
> [here](https://github.com/nix-community/nix-direnv/issues/3).
There are different ways to install nix-direnv, pick your favourite:
@ -34,10 +35,11 @@ There are different ways to install nix-direnv, pick your favourite:
### Via home-manager
Note that while the home-manager integration is recommended,
some use cases require the use of features only present in some versions of nix-direnv.
It is much harder to control the version of nix-direnv installedwith this method.
If you require such specific control, please use another method of installing nix-direnv.
Note that while the home-manager integration is recommended, some use cases
require the use of features only present in some versions of nix-direnv. It is
much harder to control the version of nix-direnv installedwith this method. If
you require such specific control, please use another method of installing
nix-direnv.
In `$HOME/.config/nixpkgs/home.nix` add
@ -57,15 +59,16 @@ In `$HOME/.config/nixpkgs/home.nix` add
}
```
Check the current [Home Manager Options](https://mipmip.github.io/home-manager-option-search/?query=direnv)
for integration with shells other than Bash. Be sure to also allow `home-manager` to
manage your shell with `programs.<your_shell>.enable = true`.
Check the current
[Home Manager Options](https://mipmip.github.io/home-manager-option-search/?query=direnv)
for integration with shells other than Bash. Be sure to also allow
`home-manager` to manage your shell with `programs.<your_shell>.enable = true`.
</details>
<details>
<summary>Direnv's source_url</summary>
### Direnv source\_url
### Direnv source_url
Put the following lines in your `.envrc`:
@ -82,9 +85,9 @@ fi
### Via system configuration on NixOS
For NixOS 23.05+ all that's required is
For NixOS 23.05+ all that's required is
```Nix
```Nix
{
programs.direnv.enable = true;
}
@ -106,6 +109,7 @@ other available options are:
};
}
```
</details>
<details>
@ -126,8 +130,8 @@ source $HOME/.nix-profile/share/nix-direnv/direnvrc
```
</details>
<details>
<details>
<summary>With `nix profile`</summary>
### With `nix profile`
@ -151,9 +155,8 @@ source $HOME/.nix-profile/share/nix-direnv/direnvrc
### From source
Clone the repository to some directory
and then source the direnvrc from this repository in your own
`~/.config/direnv/direnvrc`:
Clone the repository to some directory and then source the direnvrc from this
repository in your own `~/.config/direnv/direnvrc`:
```bash
# put this in ~/.config/direnv/direnvrc
@ -166,7 +169,7 @@ source $HOME/nix-direnv/direnvrc
Either add `shell.nix` or a `default.nix` to the project directory:
``` nix
```nix
# save this as shell.nix
{ pkgs ? import <nixpkgs> {}}:
@ -182,13 +185,13 @@ $ echo "use nix" >> .envrc
$ direnv allow
```
If you haven't used direnv before,
make sure to [hook it into your shell](https://direnv.net/docs/hook.html) first.
If you haven't used direnv before, make sure to
[hook it into your shell](https://direnv.net/docs/hook.html) first.
### Using a non-standard file name
You may use a different file name than `shell.nix` or `default.nix`
by passing the file name in `.envrc`, e.g.:
You may use a different file name than `shell.nix` or `default.nix` by passing
the file name in `.envrc`, e.g.:
```console
$ echo "use nix foo.nix" >> .envrc
@ -196,35 +199,33 @@ $ echo "use nix foo.nix" >> .envrc
## Flakes support
nix-direnv also comes with an alternative `use_flake` implementation.
The code is tested and does work but the upstream flake api is not finalized,
so we we cannot guarantee stability after a nix upgrade.
nix-direnv also comes with an alternative `use_flake` implementation. The code
is tested and does work but the upstream flake api is not finalized, so we we
cannot guarantee stability after a nix upgrade.
Like `use_nix`,
our `use_flake` will prevent garbage collection of downloaded packages,
including flake inputs.
Like `use_nix`, our `use_flake` will prevent garbage collection of downloaded
packages, including flake inputs.
### Creating a new flake-native project
This repository ships with a [flake template](https://github.com/nix-community/nix-direnv/tree/master/templates/flake).
This repository ships with a
[flake template](https://github.com/nix-community/nix-direnv/tree/master/templates/flake).
which provides a basic flake with devShell integration and a basic `.envrc`.
To make use of this template, you may issue the following command:
```console
$ nix flake new -t github:nix-community/nix-direnv <desired output path>
```
### Integrating with a existing flake
```console
$ echo "use flake" >> .envrc && direnv allow
```
The `use flake` line also takes an additional arbitrary flake parameter,
so you can point at external flakes as follows:
The `use flake` line also takes an additional arbitrary flake parameter, so you
can point at external flakes as follows:
```bash
use flake ~/myflakes#project
@ -234,14 +235,14 @@ use flake ~/myflakes#project
#### use flake
Under the covers, `use_flake` calls `nix print-dev-env`.
The first argument to the `use_flake` function is the flake expression to use,
and all other arguments are proxied along to the call to `print-dev-env`.
You may make use of this fact for some more arcane invocations.
Under the covers, `use_flake` calls `nix print-dev-env`. The first argument to
the `use_flake` function is the flake expression to use, and all other arguments
are proxied along to the call to `print-dev-env`. You may make use of this fact
for some more arcane invocations.
For instance, if you have a flake that needs to be called impurely under some conditions,
you may wish to pass `--impure` to the `print-dev-env` invocation
so that the environment of the calling shell is passed in.
For instance, if you have a flake that needs to be called impurely under some
conditions, you may wish to pass `--impure` to the `print-dev-env` invocation so
that the environment of the calling shell is passed in.
You can do that as follows:
@ -252,13 +253,13 @@ $ direnv allow
#### use nix
Like `use flake`, `use nix` now uses `nix print-dev-env`.
Due to historical reasons, the argument parsing emulates `nix shell`.
Like `use flake`, `use nix` now uses `nix print-dev-env`. Due to historical
reasons, the argument parsing emulates `nix shell`.
This leads to some limitations in what we can reasonably parse.
Currently, all single-word arguments and some well-known double arguments
will be interpeted or passed along.
Currently, all single-word arguments and some well-known double arguments will
be interpeted or passed along.
#### Manual reload of the nix environment
@ -267,7 +268,8 @@ nix-direnv in the "manual reload" mode. nix-direnv will then tell you when the
nix environment is no longer up to date. You can then decide yourself when you
want to reload the nix environment.
To activate manual mode, use `nix_direnv_manual_reload` in your `.envrc` like this:
To activate manual mode, use `nix_direnv_manual_reload` in your `.envrc` like
this:
```shell
nix_direnv_manual_reload
@ -283,36 +285,38 @@ $ nix-direnv-reload
##### Known arguments
- `-p`: Starts a list of packages to install; consumes all remaining arguments
- `--include` / `-I`: Add the following path to the list of lookup locations for `<...>` file names
- `--include` / `-I`: Add the following path to the list of lookup locations for
`<...>` file names
- `--attr` / `-A`: Specify the output attribute to utilize
`--command`, `--run`, `--exclude`, `--pure`, `-i`, and `--keep` are explicitly ignored.
`--command`, `--run`, `--exclude`, `--pure`, `-i`, and `--keep` are explicitly
ignored.
All single word arguments (`-j4`, `--impure` etc)
are passed to the underlying nix invocation.
All single word arguments (`-j4`, `--impure` etc) are passed to the underlying
nix invocation.
#### Tracked files
`nix-direnv` makes a performance tradeoff
and only considers changes in a limited number of files
when deciding to update its cache.
`nix-direnv` makes a performance tradeoff and only considers changes in a
limited number of files when deciding to update its cache.
- for `use nix` this is:
* `~/.direnvrc`
* `~/.config/direnv/direnvrc`
* `.envrc`,
* A single nix file. In order of preference:
+ The file argument to `use nix`
+ `shell.nix` if it exists
+ `default.nix` if it exists
- `~/.direnvrc`
- `~/.config/direnv/direnvrc`
- `.envrc`,
- A single nix file. In order of preference:
- The file argument to `use nix`
- `shell.nix` if it exists
- `default.nix` if it exists
- for `use flake` this is:
* `~/.direnvrc`
* `~/.config/direnv/direnvrc`
* `.envrc`
* `flake.nix`
* `flake.lock`
* `devshell.toml` if it exists
- `~/.direnvrc`
- `~/.config/direnv/direnvrc`
- `.envrc`
- `flake.nix`
- `flake.lock`
- `devshell.toml` if it exists
To add more files to be checked use `watch_file` like this
@ -321,16 +325,18 @@ watch_file your-file.nix
use nix # or use flake
```
Or - if you don't mind the overhead (runtime and conceptual) of watching all nix-files:
Or - if you don't mind the overhead (runtime and conceptual) of watching all
nix-files:
```shell
watch_file $(find . -name "*.nix" -printf '"%p" ')
```
Note that this will re-execute direnv for any nix change,
regardless of whether that change is meaningful for the devShell in use.
Note that this will re-execute direnv for any nix change, regardless of whether
that change is meaningful for the devShell in use.
`watch_file` must be invoked before either `use flake` or `use nix` to take effect.
`watch_file` must be invoked before either `use flake` or `use nix` to take
effect.
## General direnv tips

2
default.nix
View file

@ -1,4 +1,4 @@
{ stdenv, nix, gnugrep, lib }:
{ stdenv, nix, lib }:
stdenv.mkDerivation {
name = "nix-direnv";

46
flake.lock generated
View file

@ -1,20 +1,22 @@
{
"nodes": {
"flake-utils": {
"flake-parts": {
"inputs": {
"systems": "systems"
"nixpkgs-lib": [
"nixpkgs"
]
},
"locked": {
"lastModified": 1694529238,
"narHash": "sha256-zsNZZGTGnMOf9YpHKJqMSsa0dXbfmxeoJ7xHlrt+xmY=",
"owner": "numtide",
"repo": "flake-utils",
"rev": "ff7b65b44d01cf9ba6a71320833626af21126384",
"lastModified": 1698882062,
"narHash": "sha256-HkhafUayIqxXyHH1X8d9RDl1M2CkFgZLjKD3MzabiEo=",
"owner": "hercules-ci",
"repo": "flake-parts",
"rev": "8c9fa2545007b49a5db5f650ae91f227672c3877",
"type": "github"
},
"original": {
"owner": "numtide",
"repo": "flake-utils",
"owner": "hercules-ci",
"repo": "flake-parts",
"type": "github"
}
},
@ -36,22 +38,28 @@
},
"root": {
"inputs": {
"flake-utils": "flake-utils",
"nixpkgs": "nixpkgs"
"flake-parts": "flake-parts",
"nixpkgs": "nixpkgs",
"treefmt-nix": "treefmt-nix"
}
},
"systems": {
"treefmt-nix": {
"inputs": {
"nixpkgs": [
"nixpkgs"
]
},
"locked": {
"lastModified": 1681028828,
"narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=",
"owner": "nix-systems",
"repo": "default",
"rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e",
"lastModified": 1699786194,
"narHash": "sha256-3h3EH1FXQkIeAuzaWB+nK0XK54uSD46pp+dMD3gAcB4=",
"owner": "numtide",
"repo": "treefmt-nix",
"rev": "e82f32aa7f06bbbd56d7b12186d555223dc399d1",
"type": "github"
},
"original": {
"owner": "nix-systems",
"repo": "default",
"owner": "numtide",
"repo": "treefmt-nix",
"type": "github"
}
}

59
flake.nix
View file

@ -1,42 +1,57 @@
{
description = "A faster, persistent implementation of `direnv`'s `use_nix`, to replace the built-in one.";
inputs.nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable";
inputs.flake-utils.url = "github:numtide/flake-utils";
inputs.flake-parts.url = "github:hercules-ci/flake-parts";
inputs.flake-parts.inputs.nixpkgs-lib.follows = "nixpkgs";
inputs.treefmt-nix.url = "github:numtide/treefmt-nix";
inputs.treefmt-nix.inputs.nixpkgs.follows = "nixpkgs";
nixConfig.extra-substituters = [ "https://cache.garnix.io" ];
nixConfig.extra-trusted-public-keys = [ "cache.garnix.io:CTFPyKSLcx5RMJKfLo5EEPUObbA78b0YQ2DTCJXqr9g=" ];
outputs = { self, nixpkgs, flake-utils }:
flake-utils.lib.eachDefaultSystem
(system:
let
pkgs = nixpkgs.legacyPackages.${system};
in
{
outputs = inputs @ { flake-parts, ... }:
flake-parts.lib.mkFlake { inherit inputs; }
({ lib, ... }: {
imports = [ ./treefmt.nix ];
systems = [
"aarch64-linux"
"x86_64-linux"
"x86_64-darwin"
"aarch64-darwin"
];
perSystem = { config, pkgs, self', ... }: {
packages = {
default = pkgs.callPackage ./default.nix { };
nix-direnv = pkgs.callPackage ./default.nix { };
default = config.packages.nix-direnv;
test-runner-stable = pkgs.callPackage ./test-runner.nix {
nixVersion = "stable";
};
test-runner-unstable = pkgs.callPackage ./test-runner.nix {
test-runner-unstable = pkgs.callPackage ./test-runner.nix {
nixVersion = "unstable";
};
};
devShells.default = pkgs.callPackage ./shell.nix { };
apps.test-runner = {
type = "app";
program = "${self.packages.${system}.test-runner}";
program = "${config.packages.test-runner}";
};
checks = {
lint = pkgs.callPackage ./lint.nix { };
checks =
let
packages = lib.mapAttrs' (n: lib.nameValuePair "package-${n}") self'.packages;
devShells = lib.mapAttrs' (n: lib.nameValuePair "devShell-${n}") self'.devShells;
in
packages // devShells;
};
flake = {
overlay = final: _prev: {
nix-direnv = final.callPackage ./default.nix { };
};
}) // {
overlay = final: prev: {
nix-direnv = final.callPackage ./default.nix { };
};
templates.default = {
path = ./templates/flake;
description = "nix flake new -t github:Mic92/nix-direnv .";
};
};
templates.default = {
path = ./templates/flake;
description = "nix flake new -t github:Mic92/nix-direnv .";
};
};
});
}

2
lint.nix
View file

@ -5,7 +5,7 @@
, ruff
, runCommand
}:
runCommand "lint" {} ''
runCommand "lint" { } ''
set -e
mkdir source
cp -r ${./.}/* source

2
shell.nix
View file

@ -1,4 +1,4 @@
{ pkgs ? import <nixpkgs> {} }:
{ pkgs ? import <nixpkgs> { } }:
with pkgs;
mkShell {

18
templates/flake/flake.nix
View file

@ -3,12 +3,14 @@
inputs.nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable";
inputs.flake-utils.url = "github:numtide/flake-utils";
outputs = { self, nixpkgs, flake-utils }:
flake-utils.lib.eachDefaultSystem (system: let
pkgs = nixpkgs.legacyPackages.${system};
in {
devShells.default = pkgs.mkShell {
packages = [ pkgs.bashInteractive ];
};
});
outputs = { nixpkgs, flake-utils }:
flake-utils.lib.eachDefaultSystem (system:
let
pkgs = nixpkgs.legacyPackages.${system};
in
{
devShells.default = pkgs.mkShell {
packages = [ pkgs.bashInteractive ];
};
});
}

1
tests/direnv_project.py
View file

@ -40,6 +40,7 @@ def direnv_project(test_root: Path, project_root: Path) -> Iterator[DirenvProjec
shutil.copytree(test_root / "testenv", dir)
shutil.copyfile(project_root / "flake.nix", dir / "flake.nix")
shutil.copyfile(project_root / "flake.lock", dir / "flake.lock")
shutil.copyfile(project_root / "treefmt.nix", dir / "treefmt.nix")
nix_direnv = project_root / "direnvrc"
c = DirenvProject(Path(dir), nix_direnv)

2
tests/testenv/flake.nix
View file

@ -3,7 +3,7 @@
inputs.nixpkgs.url = "github:NixOS/nixpkgs";
inputs.flake-utils.url = "github:numtide/flake-utils";
outputs = { self, nixpkgs, flake-utils }:
outputs = { nixpkgs, flake-utils }:
flake-utils.lib.eachDefaultSystem (system: {
devShell = import ./shell.nix {
pkgs = nixpkgs.legacyPackages.${system};

4
tests/testenv/shell.nix
View file

@ -1,8 +1,8 @@
{ pkgs ? import (builtins.getFlake (toString ./.)).inputs.nixpkgs { }
, someArg ? null
, shellHook ? ''
echo "Executing shellHook."
''
echo "Executing shellHook."
''
}:
pkgs.mkShellNoCC {
inherit shellHook;

47
treefmt.nix Normal file
View file

@ -0,0 +1,47 @@
{ lib, inputs, ... }: {
imports = [
inputs.treefmt-nix.flakeModule
];
perSystem = { pkgs, ... }: {
treefmt = {
# Used to find the project root
projectRootFile = "flake.lock";
programs.deno.enable = true;
programs.mypy.enable = true;
programs.shellcheck.enable = true;
settings.formatter = {
nix = {
command = "sh";
options = [
"-eucx"
''
# First deadnix
${lib.getExe pkgs.deadnix} --edit "$@"
# Then nixpkgs-fmt
${lib.getExe pkgs.nixpkgs-fmt} "$@"
''
"--"
];
includes = [ "*.nix" ];
excludes = [ "nix/sources.nix" ];
};
python = {
command = "sh";
options = [
"-eucx"
''
${lib.getExe pkgs.ruff} --fix "$@"
${lib.getExe pkgs.ruff} format "$@"
''
"--" # this argument is ignored by bash
];
includes = [ "*.py" ];
};
};
};
};
}