Skip to content

Commit f40219a

Browse files
committed
docs(csv-parse): use dedent
1 parent e5bc2f4 commit f40219a

31 files changed

+180
-136
lines changed

packages/csv-parse/samples/api.callback.js

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,13 @@
11
import assert from "node:assert";
2+
import dedent from "dedent";
23
import { parse } from "csv-parse";
34

4-
const input = '#Welcome\n"1","2","3","4"\n"a","b","c","d"';
55
parse(
6-
input,
6+
dedent`
7+
# Welcome
8+
"1","2","3","4"
9+
"a","b","c","d"
10+
`,
711
{
812
comment: "#",
913
},

packages/csv-parse/samples/comment.js

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,13 @@
11
import assert from "node:assert";
2+
import dedent from "dedent";
23
import { parse } from "csv-parse";
34

45
parse(
5-
'#Welcome\n"1","2","3","4"\n"a","b","c","d"',
6+
dedent`
7+
# Welcome
8+
"1","2","3","4"
9+
"a","b","c","d"
10+
`,
611
{ comment: "#" },
712
function (err, data) {
813
assert.deepStrictEqual(data, [

packages/csv-parse/samples/mixed.output_stream.js

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
import assert from "node:assert";
2+
import dedent from "dedent";
23
import { parse } from "csv-parse";
34

45
const records = [];
56
parse(
6-
`
7-
"1","2","3"
8-
"a","b","c"
9-
`,
7+
dedent`
8+
"1","2","3"
9+
"a","b","c"
10+
`,
1011
{
1112
trim: true,
1213
skip_empty_lines: true,

packages/csv-parse/samples/option.cast.context.js

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
import assert from "node:assert";
2+
import dedent from "dedent";
23
import { parse } from "csv-parse/sync";
34

4-
const data = `
5+
const data = dedent`
56
2000-01-01,date1
67
2050-11-27,date2
7-
`.trim();
8+
`;
89
const records = parse(data, {
910
// The cast option exect a function which
1011
// is called with two arguments,
@@ -43,7 +44,7 @@ assert.deepStrictEqual(records, [
4344
[
4445
"2050-11-27T05:00:00.000Z",
4546
{
46-
bytes: 35,
47+
bytes: 33,
4748
comment_lines: 0,
4849
empty_lines: 0,
4950
invalid_field_length: 0,

packages/csv-parse/samples/option.cast.header.column.fn.js

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,26 @@
11
import assert from "node:assert";
2+
import dedent from "dedent";
23
import { parse } from "csv-parse/sync";
34

45
assert.deepEqual(
5-
parse("a,b,c\n1,2,3\n4,5,6", {
6-
cast: (value, context) => {
7-
if (context.header) return value;
8-
if (context.column === "B") return Number(value);
9-
return String(value);
6+
parse(
7+
dedent`
8+
a,b,c
9+
1,2,3
10+
4,5,6
11+
`,
12+
{
13+
cast: (value, context) => {
14+
if (context.header) return value;
15+
if (context.column === "B") return Number(value);
16+
return String(value);
17+
},
18+
columns: (header) => {
19+
return header.map((label) => label.toUpperCase());
20+
},
21+
trim: true,
1022
},
11-
columns: (header) => {
12-
return header.map((label) => label.toUpperCase());
13-
},
14-
trim: true,
15-
}),
23+
),
1624
[
1725
{ A: "1", B: 2, C: "3" },
1826
{ A: "4", B: 5, C: "6" },

packages/csv-parse/samples/option.cast.header.columns.true.js

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,24 @@
11
import assert from "node:assert";
2+
import dedent from "dedent";
23
import { parse } from "csv-parse/sync";
34

45
assert.deepEqual(
5-
parse("a,b,c\n1,2,3\n4,5,6", {
6-
cast: (value, context) => {
7-
if (context.header) return value.toUpperCase();
8-
if (context.column === "B") return Number(value);
9-
return String(value);
6+
parse(
7+
dedent`
8+
a,b,c
9+
1,2,3
10+
4,5,6
11+
`,
12+
{
13+
cast: (value, context) => {
14+
if (context.header) return value.toUpperCase();
15+
if (context.column === "B") return Number(value);
16+
return String(value);
17+
},
18+
columns: true,
19+
trim: true,
1020
},
11-
columns: true,
12-
trim: true,
13-
}),
21+
),
1422
[
1523
{ A: "1", B: 2, C: "3" },
1624
{ A: "4", B: 5, C: "6" },

packages/csv-parse/samples/option.cast.js

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
import assert from "node:assert";
2+
import dedent from "dedent";
23
import { parse } from "csv-parse/sync";
34

4-
const data = `
5+
const data = dedent`
56
1,2,3
67
4,5,6
7-
`.trim();
8+
`;
89
const records = parse(data, {
910
// The cast option exect a function which
1011
// is called with two arguments,

packages/csv-parse/samples/option.cast_date.js

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
import assert from "node:assert";
2+
import dedent from "dedent";
23
import { parse } from "csv-parse/sync";
34

4-
const data = `
5-
2000-01-01,date1
6-
2020-01-01,date2
7-
`.trim();
5+
const data = dedent`
6+
2000-01-01,date1
7+
2020-01-01,date2
8+
`;
89
const records = parse(data, {
910
cast: true,
1011
cast_date: true,

packages/csv-parse/samples/option.columns.array.js

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,7 @@ import assert from "node:assert";
22
import { parse } from "csv-parse";
33

44
parse(
5-
`
6-
"value 1","value 2"
7-
`.trim(),
5+
'"value 1","value 2"',
86
{
97
columns: ["key_1", "key_2"],
108
},

packages/csv-parse/samples/option.columns.function.js

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
import assert from "node:assert";
2+
import dedent from "dedent";
23
import { parse } from "csv-parse";
34

45
parse(
5-
`
6-
"key_1","key_2"
7-
"value 1","value 2"
8-
`.trim(),
6+
dedent`
7+
"key_1","key_2"
8+
"value 1","value 2"
9+
`,
910
{
1011
columns: (header) => header.map((column) => column.toUpperCase()),
1112
},

packages/csv-parse/samples/option.columns.true.js

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
import assert from "node:assert";
2+
import dedent from "dedent";
23
import { parse } from "csv-parse";
34

45
parse(
5-
`
6-
"key_1","key_2"
7-
"value 1","value 2"
8-
`.trim(),
6+
dedent`
7+
"key_1","key_2"
8+
"value 1","value 2"
9+
`,
910
{
1011
columns: true,
1112
},

packages/csv-parse/samples/option.comment.js

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
import assert from "node:assert";
2+
import dedent from "dedent";
23
import { parse } from "csv-parse/sync";
34

4-
const data = `
5-
# At the beginning of a record
6-
"hello"
7-
"world"# At the end of a record
8-
`.trim();
5+
const data = dedent`
6+
# At the beginning of a record
7+
"hello"
8+
"world"# At the end of a record
9+
`;
910
const records = parse(data, {
1011
comment: "#",
1112
});

packages/csv-parse/samples/option.comment_no_infix.js

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
import assert from "node:assert";
2+
import dedent from "dedent";
23
import { parse } from "csv-parse/sync";
34

45
const output = parse(
5-
`
6-
# Illustrate the usage of comment_no_infix
7-
a,b#,c
8-
`.trim(),
6+
dedent`
7+
# Illustrate the usage of comment_no_infix
8+
a,b#,c
9+
`,
910
{
1011
comment: "#",
1112
comment_no_infix: true,

packages/csv-parse/samples/option.delimiter.array.js

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
import assert from "node:assert";
22
import { parse } from "csv-parse/sync";
33

4-
const input = `color name::red::green::blue
4+
const input = `
5+
color name::red::green::blue
56
Cyan \t "0" :: 255 :: 255
67
Yellow \t "255" :: "255" ::"0"
7-
Hot Pink \t "255" :: 105 :: "180"`;
8+
Hot Pink \t "255" :: 105 :: "180"
9+
`.trim();
810

911
const output = parse(input, {
1012
delimiter: ["::", "\t"],

packages/csv-parse/samples/option.from.js

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
11
import assert from "node:assert";
2+
import dedent from "dedent";
23
import { parse } from "csv-parse";
34

45
parse(
5-
`
6-
a,b
7-
1,2
8-
3,4
9-
5,6
10-
`.trim(),
6+
dedent`
7+
a,b
8+
1,2
9+
3,4
10+
5,6
11+
`,
1112
{
1213
columns: true,
1314
from: 2,

packages/csv-parse/samples/option.on_record.alter.js

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
import assert from "node:assert";
2+
import dedent from "dedent";
23
import { parse } from "csv-parse";
34

45
parse(
5-
`
6-
a.1,a.2,a.3
7-
b.1,b.2,b.3
8-
`.trim(),
6+
dedent`
7+
a.1,a.2,a.3
8+
b.1,b.2,b.3
9+
`,
910
{
1011
on_record: (record, { lines }) => [lines, record[2], record[0]],
1112
},

packages/csv-parse/samples/option.on_record.filter.js

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
import assert from "node:assert";
2+
import dedent from "dedent";
23
import { parse } from "csv-parse";
34

45
parse(
5-
`
6-
line 1
7-
line 2
8-
line 3
9-
`.trim(),
6+
dedent`
7+
line 1
8+
line 2
9+
line 3
10+
`,
1011
{
1112
on_record: (record, { lines }) => (lines === 2 ? null : record),
1213
},

packages/csv-parse/samples/option.quote.default.js

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
import assert from "node:assert";
2+
import dedent from "dedent";
23
import { parse } from "csv-parse/sync";
34

45
const records = parse(
5-
`
6-
a,"b",c
7-
"d",e,"f"
8-
`.trim(),
6+
dedent`
7+
a,"b",c
8+
"d",e,"f"
9+
`,
910
);
1011

1112
assert.deepStrictEqual(records, [

packages/csv-parse/samples/option.quote.escape.js

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
import assert from "node:assert";
2+
import dedent from "dedent";
23
import { parse } from "csv-parse/sync";
34

45
const records = parse(
5-
`
6-
a,"b""b",c
7-
d,"e""e",f
8-
`.trim(),
6+
dedent`
7+
a,"b""b",c
8+
d,"e""e",f
9+
`,
910
);
1011

1112
assert.deepStrictEqual(records, [

packages/csv-parse/samples/option.raw.js

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
import assert from "node:assert";
2+
import dedent from "dedent";
23
import { parse } from "csv-parse";
34

45
parse(
5-
`
6-
a,b,c
7-
d,e,f
8-
`.trim(),
6+
dedent`
7+
a,b,c
8+
d,e,f
9+
`,
910
{ raw: true },
1011
(err, records) => {
1112
assert.deepStrictEqual(records, [

packages/csv-parse/samples/option.relax_column_count.columns.js

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
import assert from "node:assert";
2+
import dedent from "dedent";
23
import { parse } from "csv-parse";
34

45
parse(
5-
`
6-
lastname,firstname,fullname
7-
Ritchie
8-
Lovelace,Ada,"Augusta Ada King, Countess of Lovelace"
9-
`.trim(),
6+
dedent`
7+
lastname,firstname,fullname
8+
Ritchie
9+
Lovelace,Ada,"Augusta Ada King, Countess of Lovelace"
10+
`,
1011
{
1112
relax_column_count: true,
1213
columns: true,

0 commit comments

Comments
 (0)