pyrox.dev
1# pkgs.nix-gitignore {#sec-pkgs-nix-gitignore}
2
3`pkgs.nix-gitignore` is a function that acts similarly to `builtins.filterSource` but also allows filtering with the help of the gitignore format.
4
5## Usage {#sec-pkgs-nix-gitignore-usage}
6
7`pkgs.nix-gitignore` exports a number of functions, but you'll most likely need either `gitignoreSource` or `gitignoreSourcePure`. As their first argument, they both accept either 1. a file with gitignore lines or 2. a string with gitignore lines, or 3. a list of either of the two. They will be concatenated into a single big string.
8
9```nix
10{
11 pkgs ? import <nixpkgs> { },
12}:
13{
14
15 src = nix-gitignore.gitignoreSource [ ] ./source;
16 # Simplest version
17
18 src = nix-gitignore.gitignoreSource ''
19 supplemental-ignores
20 '' ./source;
21 # This one reads the ./source/.gitignore and concats the auxiliary ignores
22
23 src = nix-gitignore.gitignoreSourcePure ''
24 ignore-this
25 ignore-that
26 '' ./source;
27 # Use this string as gitignore, don't read ./source/.gitignore.
28
29 src = nix-gitignore.gitignoreSourcePure [
30 ''
31 ignore-this
32 ignore-that
33 ''
34 ~/.gitignore
35 ] ./source;
36 # It also accepts a list (of strings and paths) that will be concatenated
37 # once the paths are turned to strings via readFile.
38}
39```
40
41These functions are derived from the `Filter` functions by setting the first filter argument to `(_: _: true)`:
42
43```nix
44{
45 gitignoreSourcePure = gitignoreFilterSourcePure (_: _: true);
46 gitignoreSource = gitignoreFilterSource (_: _: true);
47}
48```
49
50Those filter functions accept the same arguments the `builtins.filterSource` function would pass to its filters, thus `fn: gitignoreFilterSourcePure fn ""` should be extensionally equivalent to `filterSource`. The file is blacklisted if it's blacklisted by either your filter or the gitignoreFilter.
51
52If you want to make your own filter from scratch, you may use
53
54```nix
55{ gitignoreFilter = ign: root: filterPattern (gitignoreToPatterns ign) root; }
56```
57
58## gitignore files in subdirectories {#sec-pkgs-nix-gitignore-usage-recursive}
59
60If you wish to use a filter that would search for .gitignore files in subdirectories, just like git does by default, use this function:
61
62```nix
63{
64 # gitignoreFilterRecursiveSource = filter: patterns: root:
65 # OR
66 gitignoreRecursiveSource = gitignoreFilterSourcePure (_: _: true);
67}
68```