New option formatDates for writeData method (#996)

* New option formatDates for writeData method

* Fixing tests

Author: nshiab

deno.json

@@ -5,7 +5,7 @@
     ".": "./src/index.ts"
   },
   "tasks": {
-    "all-tests": "deno install --allow-scripts=npm:playwright-chromium && deno fmt --check && deno lint && deno check src/index.ts && deno publish --allow-dirty --dry-run && deno test -A --fail-fast",
+    "all-tests": "deno install --allow-scripts=npm:playwright-chromium && deno fmt --check && deno lint && deno check src/index.ts && deno publish --allow-dirty --dry-run && rm -rf test/output && deno test -A --fail-fast",
     "test-coverage": "deno test -A --fail-fast --coverage=cov_profile && deno coverage cov_profile",
     "patch-no-tests": "deno run -A src/incrementVersion.ts patch",
     "patch": "deno task all-tests && deno run -A src/incrementVersion.ts patch",

src/class/SimpleTable.ts

@@ -5385,6 +5385,7 @@ export default class SimpleTable extends Simple {
    * @param options - An optional object with configuration options:
    *   @param options.compression - A boolean indicating whether to compress the output file. Defaults to false. If true, CSV and JSON files will be compressed with GZIP while PARQUET files will use ZSTD.
    *   @param options.dataAsArrays - A boolean for JSON files. If true, JSON files are written as one object with arrays instead of an array of objects. Convenient to reduce the size of JSON files for web projects. You can use the function arraysToData from the journalism library to bring back the data to its original state.
+   *   @param options.formatDates - If true, dates will be formatted as ISO strings ("2025-01-01T01:00:00.000Z"). Defaults to false. Works only with CSV and JSON files.
    *
    * @category Exporting data
    */
@@ -5393,6 +5394,7 @@ export default class SimpleTable extends Simple {
     options: {
       compression?: boolean;
       dataAsArrays?: boolean;
+      formatDates?: boolean;
     } = {},
   ) {
     createDirectory(file);

src/methods/writeDataQuery.ts

@@ -5,25 +5,29 @@ export default function writeDataQuery(
   table: string,
   file: string,
   fileExtension: string,
-  options: { compression?: boolean },
+  options: { compression?: boolean; formatDates?: boolean },
 ) {
   const cleanedFile = cleanPath(file);
   if (fileExtension === "csv") {
-    if (options.compression) {
-      return `COPY "${table}" TO '${
-        cleanedFile + ".gz"
-      }' (DELIMITER ',', HEADER TRUE, COMPRESSION GZIP);`;
-    } else {
-      return `COPY "${table}" TO '${cleanedFile}' (DELIMITER ',', HEADER TRUE, DATEFORMAT '%xT%X.%gZ', TIMESTAMPFORMAT '%xT%X.%gZ');`;
-    }
+    return `COPY "${table}" TO '${
+      options.compression ? cleanedFile + ".gz" : cleanedFile
+    }' (DELIMITER ',', HEADER TRUE${
+      options.compression ? ", COMPRESSION GZIP" : ""
+    }${
+      options.formatDates
+        ? ", DATEFORMAT '%xT%X.%gZ', TIMESTAMPFORMAT '%xT%X.%gZ'"
+        : ""
+    });`;
   } else if (fileExtension === "json") {
-    if (options.compression) {
-      return `COPY "${table}" TO '${
-        cleanedFile + ".gz"
-      }' (FORMAT JSON, ARRAY TRUE, COMPRESSION GZIP);`;
-    } else {
-      return `COPY "${table}" TO '${cleanedFile}' (FORMAT JSON, ARRAY TRUE, DATEFORMAT '%xT%X.%gZ', TIMESTAMPFORMAT '%xT%X.%gZ');`;
-    }
+    return `COPY "${table}" TO '${
+      options.compression ? cleanedFile + ".gz" : cleanedFile
+    }' (FORMAT JSON, ARRAY TRUE${
+      options.compression ? ", COMPRESSION GZIP" : ""
+    }${
+      options.formatDates
+        ? ", DATEFORMAT '%xT%X.%gZ', TIMESTAMPFORMAT '%xT%X.%gZ'"
+        : ""
+    });`;
   } else if (fileExtension === "parquet") {
     if (options.compression) {
       return `COPY "${table}" TO '${cleanedFile}' (FORMAT PARQUET, COMPRESSION ZSTD);`;

test/unit/methods/writeData.test.ts

@@ -82,7 +82,7 @@ Deno.test("should write a json file with dates", async () => {
     key1: new Date("2025-04-08T14:09:24.155Z"),
   }]);
 
-  await table.writeData(`${output}date-test.json`);
+  await table.writeData(`${output}date-test.json`, { formatDates: true });
 
   // We test the content of the file
   const tableCheck = JSON.parse(