Skip to content

Only quote CSV string values if necessary #3402

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Only quote CSV string values if necessary #3402

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6674377
Split CSV and TSV formatters
into-the-v0id Aug 28, 2025
0312a6e
Only quote CSV string values if necessary
into-the-v0id Aug 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
87 changes: 67 additions & 20 deletions src/builtin.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -563,6 +563,27 @@ static jv escape_string(jv input, const char* escapings) {

}

static int string_contains_byte(jv input, const char* search) {
assert(jv_get_kind(input) == JV_KIND_STRING);

int lookup[128] = {0};
const char* p = search;
while (*p) {
lookup[(int)*p] = 1;
p++;
}

const char* s = jv_string_value(input);
for (int i=0; s[i] != '\0'; i++) {
int c = s[i];
if (c < 128 && lookup[c]) {
return i;
}
}

return -1;
}

static jv f_format(jq_state *jq, jv input, jv fmt) {
if (jv_get_kind(fmt) != JV_KIND_STRING) {
jv_free(input);
Expand All @@ -575,27 +596,13 @@ static jv f_format(jq_state *jq, jv input, jv fmt) {
} else if (!strcmp(fmt_s, "text")) {
jv_free(fmt);
return f_tostring(jq, input);
} else if (!strcmp(fmt_s, "csv") || !strcmp(fmt_s, "tsv")) {
const char *quotes, *sep, *escapings;
const char *msg;
if (!strcmp(fmt_s, "csv")) {
msg = "cannot be csv-formatted, only array";
quotes = "\"";
sep = ",";
escapings = "\"\"\"\0";
} else {
msg = "cannot be tsv-formatted, only array";
assert(!strcmp(fmt_s, "tsv"));
quotes = "";
sep = "\t";
escapings = "\t\\t\0\r\\r\0\n\\n\0\\\\\\\0";
}
} else if (!strcmp(fmt_s, "csv")) {
jv_free(fmt);
if (jv_get_kind(input) != JV_KIND_ARRAY)
return type_error(input, msg);
return type_error(input, "cannot be csv-formatted, only array");
jv line = jv_string("");
jv_array_foreach(input, i, x) {
if (i) line = jv_string_append_str(line, sep);
if (i) line = jv_string_append_str(line, ",");
switch (jv_get_kind(x)) {
case JV_KIND_NULL:
/* null rendered as empty string */
Expand All @@ -614,9 +621,13 @@ static jv f_format(jq_state *jq, jv input, jv fmt) {
}
break;
case JV_KIND_STRING: {
line = jv_string_append_str(line, quotes);
line = jv_string_concat(line, escape_string(x, escapings));
line = jv_string_append_str(line, quotes);
if (string_contains_byte(x, "\n\",") != -1) {
line = jv_string_append_str(line, "\"");
line = jv_string_concat(line, escape_string(x, "\"\"\"\0"));
line = jv_string_append_str(line, "\"");
} else {
line = jv_string_concat(line, x);
}
break;
}
default:
Expand All @@ -627,6 +638,42 @@ static jv f_format(jq_state *jq, jv input, jv fmt) {
}
jv_free(input);
return line;
} else if (!strcmp(fmt_s, "tsv")) {
jv_free(fmt);
if (jv_get_kind(input) != JV_KIND_ARRAY)
return type_error(input, "cannot be tsv-formatted, only array");
jv line = jv_string("");
jv_array_foreach(input, i, x) {
if (i) line = jv_string_append_str(line, "\t");
switch (jv_get_kind(x)) {
case JV_KIND_NULL:
/* null rendered as empty string */
jv_free(x);
break;
case JV_KIND_TRUE:
case JV_KIND_FALSE:
line = jv_string_concat(line, jv_dump_string(x, 0));
break;
case JV_KIND_NUMBER:
if (jv_number_value(x) != jv_number_value(x)) {
/* NaN, render as empty string */
jv_free(x);
} else {
line = jv_string_concat(line, jv_dump_string(x, 0));
}
break;
case JV_KIND_STRING: {
line = jv_string_concat(line, escape_string(x, "\t\\t\0\r\\r\0\n\\n\0\\\\\\\0"));
break;
}
default:
jv_free(input);
jv_free(line);
return type_error(x, "is not valid in a tsv row");
}
}
jv_free(input);
return line;
} else if (!strcmp(fmt_s, "html")) {
jv_free(fmt);
return escape_string(f_tostring(jq, input), "&&amp;\0<&lt;\0>&gt;\0'&apos;\0\"&quot;\0");
Expand Down
4 changes: 4 additions & 0 deletions tests/jq.test
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,10 @@ null
"ISgpPD4mJyIJ"
"!()<>&'\"\t"

@csv
["hello", "hello,world", "a\"b", "one\ntwo", "foo, \"bar\nbaz\" end"]
"hello,\"hello,world\",\"a\"\"b\",\"one\ntwo\",\"foo, \"\"bar\nbaz\"\" end\""

# regression test for #436
@base64
"foóbar\n"
Expand Down