Add support for automatically gitignoring generated files #157
Conversation
thufschmitt
force-pushed
the
auto-gitignore
branch
from
b867aee
to
9e8506c
Compare
Running `nix run .\#regenerate-files` now generates files locally according to the `files` option in `project.ncl`. This is still rather crude in a number of ways, but it is already working (and used to generate this project's own `.gitignore`). Fixes #144
Add a light `gitignore` abstraction allowing to define a set of gitignore patterns from Nickel, and plug that in to the file generation interface so that a generated file can also be git ignored by simply setting `files.foo.gitignore = true`
thufschmitt
force-pushed
the
auto-gitignore
branch
from
9e8506c
to
2b7ebe9
Compare
| @@ -0,0 +1,52 @@ | |||
| # let nix = import "./nix-interop/nix.ncl" in | |||
There was a problem hiding this comment.
| # let nix = import "./nix-interop/nix.ncl" in |
| : Bool | ||
| | doc "Whether to gitignore the file" | ||
| | default | ||
| = false, |
There was a problem hiding this comment.
This means that each generated file will be added to .gitignore in one way or another. I think we should have a default option here that doesn't add it to .gitignore at all.
There was a problem hiding this comment.
No they aren't, the ones with gitignore = true are filtered out here.
But that indeed makes some slightly confusing semantics as it means that files.foo.gitignore has a different semantics than git.ignore."/foo".
| |> std.array.map (fun { value = { target, .. }, .. } => { field = target, value = true }) | ||
| |> std.record.from_array | ||
| in | ||
| let gitignore_content | { _ : Bool } -> String = fun ignores => |
There was a problem hiding this comment.
I think these functions should be in the final record so that users can add more .gitignore files to their repos.
| fun pattern is_ignored => | ||
| "%{if is_ignored then "" else "!"}%{pattern}" | ||
| ) | ||
| |> std.record.values |
There was a problem hiding this comment.
We should somehow provide a way to order these lines, because order is important in .gitignore
| # let nix = import "./nix-interop/nix.ncl" in | ||
| let filegen = import "./files.ncl" in | ||
| let Gitignorable = { | ||
| gitignore |
There was a problem hiding this comment.
This should probably be nested like git.ignore in case we want to add, for example, .gitattributes support.
Add a light
gitignoreabstraction allowing to define a set of gitignore patterns from Nickel, and plug that in to the file generation interface so that a generated file can also be git ignored by simply settingfiles.foo.gitignore = true