nixos/nix
1
1
Fork 0
mirror of https://github.com/NixOS/nix.git synced 2025-11-09 20:16:03 +01:00
Code Activity

Move support for comments to fromJSONC

Browse source
This commit is contained in:
Farid Zakaria 2025-08-08 17:46:38 -07:00
parent 00921f6e3c
commit 4b78ee44ee
3 changed files with 42 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

9
src/libexpr/include/nix/expr/json-to-value.hh
View file

@ -12,6 +12,13 @@ struct Value;
MakeError(JSONParseError, Error); MakeError(JSONParseError, Error);
void parseJSON(EvalState & state, const std::string_view & s, Value & v); /**
* Parse the string into the Value
* @param state
* @param s
* @param v
* @param allowComments Whether to allow comments in the JSON
*/
void parseJSON(EvalState & state, const std::string_view & s, Value & v, bool allowComments = false);
} // namespace nix } // namespace nix

4
src/libexpr/json-to-value.cc
View file

@ -201,11 +201,11 @@ public:
} }
}; };
void parseJSON(EvalState & state, const std::string_view & s_, Value & v) void parseJSON(EvalState & state, const std::string_view & s_, Value & v, bool allowComments)
{ {
JSONSax parser(state, v); JSONSax parser(state, v);
bool res = json::sax_parse( bool res = json::sax_parse(
s_, &parser, nlohmann::detail::input_format_t::json, /* strict= */ true, /* ignore_comments= */ true); s_, &parser, nlohmann::detail::input_format_t::json, /* strict= */ true, /* ignore_comments= */ allowComments);
if (!res) if (!res)
throw JSONParseError("Invalid JSON Value"); throw JSONParseError("Invalid JSON Value");
} }

35
src/libexpr/primops.cc
View file

@ -2470,11 +2470,11 @@ static RegisterPrimOp primop_toJSON({
}); });
/* Parse a JSON string to a value. */ /* Parse a JSON string to a value. */
static void prim_fromJSON(EvalState & state, const PosIdx pos, Value ** args, Value & v) static void prim_fromJSON(EvalState & state, const PosIdx pos, Value ** args, Value & v, bool allow_comments)
{ {
auto s = state.forceStringNoCtx(*args[0], pos, "while evaluating the first argument passed to builtins.fromJSON"); auto s = state.forceStringNoCtx(*args[0], pos, "while evaluating the first argument passed to builtins.fromJSON");
try { try {
parseJSON(state, s, v); parseJSON(state, s, v, allow_comments);
} catch (JSONParseError & e) { } catch (JSONParseError & e) {
e.addTrace(state.positions[pos], "while decoding a JSON string"); e.addTrace(state.positions[pos], "while decoding a JSON string");
throw; throw;
@ -2492,10 +2492,39 @@ static RegisterPrimOp primop_fromJSON({
``` ```
returns the value `{ x = [ 1 2 3 ]; y = null; }`. returns the value `{ x = [ 1 2 3 ]; y = null; }`.
)",
.fun =
[](EvalState & state, const PosIdx pos, Value ** args, Value & v) {
return prim_fromJSON(state, pos, args, v, false);
},
});
static RegisterPrimOp primop_fromJSONC({
.name = "__fromJSONC",
.args = {"e"},
.doc = R"(
Convert a JSON string, potentially with comments, to a Nix value.
For example,
```nix
builtins.fromJSONC ''
{
// This is a comment
"x": [1, 2, 3],
/* This is another comment */
"y": null
}
''
```
returns the value `{ x = [ 1 2 3 ]; y = null; }`.
This function supports JSON with comments. This function supports JSON with comments.
)", )",
.fun = prim_fromJSON, .fun =
[](EvalState & state, const PosIdx pos, Value ** args, Value & v) {
return prim_fromJSON(state, pos, args, v, true);
},
}); });
/* Store a string in the Nix store as a source file that can be used /* Store a string in the Nix store as a source file that can be used