-
-
Notifications
You must be signed in to change notification settings - Fork 14.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
writers: add data-centric writers #244835
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,80 @@ | ||
{ lib, runCommandNoCC, dasel }: | ||
let | ||
daselBin = lib.getExe dasel; | ||
|
||
inherit (lib) | ||
last | ||
optionalString | ||
types | ||
; | ||
in | ||
rec { | ||
AndersonTorres marked this conversation as resolved.
Show resolved
Hide resolved
|
||
# Creates a transformer function that writes input data to disk, transformed | ||
# by both the `input` and `output` arguments. | ||
# | ||
# Type: makeDataWriter :: input -> output -> nameOrPath -> data -> (any -> string) -> string -> string -> any -> derivation | ||
# | ||
# input :: T -> string: function that takes the nix data and returns a string | ||
# output :: string: script that takes the $inputFile and write the result into $out | ||
# nameOrPath :: string: if the name contains a / the files gets written to a sub-folder of $out. The derivation name is the basename of this argument. | ||
# data :: T: the data that will be converted. | ||
# | ||
# Example: | ||
# writeJSON = makeDataWriter { input = builtins.toJSON; output = "cp $inputPath $out"; }; | ||
# myConfig = writeJSON "config.json" { hello = "world"; } | ||
# | ||
Comment on lines
+12
to
+25
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Where's the user documentation? |
||
makeDataWriter = { input ? lib.id, output ? "cp $inputPath $out" }: nameOrPath: data: | ||
assert lib.or (types.path.check nameOrPath) (builtins.match "([0-9A-Za-z._])[0-9A-Za-z._-]*" nameOrPath != null); | ||
let | ||
name = last (builtins.split "/" nameOrPath); | ||
in | ||
runCommandNoCC name | ||
{ | ||
input = input data; | ||
passAsFile = [ "input" ]; | ||
} '' | ||
${output} | ||
|
||
${optionalString (types.path.check nameOrPath) '' | ||
mv $out tmp | ||
mkdir -p $out/$(dirname "${nameOrPath}") | ||
mv tmp $out/${nameOrPath} | ||
''} | ||
''; | ||
|
||
# Writes the content to text. | ||
# | ||
# Example: | ||
# writeText "filename.txt" "file content" | ||
writeText = makeDataWriter { | ||
input = toString; | ||
output = "cp $inputPath $out"; | ||
}; | ||
|
||
# Writes the content to a JSON file. | ||
# | ||
# Example: | ||
# writeJSON "data.json" { hello = "world"; } | ||
writeJSON = makeDataWriter { | ||
input = builtins.toJSON; | ||
output = "${daselBin} -f $inputPath -r json -w json > $out"; | ||
}; | ||
|
||
# Writes the content to a TOML file. | ||
# | ||
# Example: | ||
# writeTOML "data.toml" { hello = "world"; } | ||
writeTOML = makeDataWriter { | ||
input = builtins.toJSON; | ||
output = "${daselBin} -f $inputPath -r json -w toml > $out"; | ||
}; | ||
|
||
# Writes the content to a YAML file. | ||
# | ||
# Example: | ||
# writeYAML "data.yaml" { hello = "world"; } | ||
writeYAML = makeDataWriter { | ||
input = builtins.toJSON; | ||
output = "${daselBin} -f $inputPath -r json -w yaml > $out"; | ||
}; | ||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These writers appear redundant, as we already have
pkgs.formats
for these.If we're going to keep them, should the respective formats be changed to use these writers?