test(csv-parse): options ts convertion

Author: wdavidw

packages/csv-parse/lib/index.d.ts

@@ -370,33 +370,33 @@ export interface Options<T = string[]> {
   /**
    * Generate two properties raw and row where raw is the original CSV row content and row is the parsed array or object.
    */
-  raw?: boolean;
+  raw?: boolean | null;
+  /**
+   * One or multiple characters used to delimit record rows; defaults to auto discovery if not provided.
+   * Supported auto discovery method are Linux ("\n"), Apple ("\r") and Windows ("\r\n") row delimiters.
+   */
+  record_delimiter?: string | Buffer | null | (string | Buffer | null)[];
+  recordDelimiter?: string | Buffer | null | (string | Buffer | null)[];
   /**
    * Discard inconsistent columns count, default to false.
    */
-  relax_column_count?: boolean;
-  relaxColumnCount?: boolean;
+  relax_column_count?: boolean | null;
+  relaxColumnCount?: boolean | null;
   /**
    * Discard inconsistent columns count when the record contains less fields than expected, default to false.
    */
-  relax_column_count_less?: boolean;
-  relaxColumnCountLess?: boolean;
+  relax_column_count_less?: boolean | null;
+  relaxColumnCountLess?: boolean | null;
   /**
    * Discard inconsistent columns count when the record contains more fields than expected, default to false.
    */
-  relax_column_count_more?: boolean;
-  relaxColumnCountMore?: boolean;
+  relax_column_count_more?: boolean | null;
+  relaxColumnCountMore?: boolean | null;
   /**
    * Preserve quotes inside unquoted field.
    */
-  relax_quotes?: boolean;
-  relaxQuotes?: boolean;
-  /**
-   * One or multiple characters used to delimit record rows; defaults to auto discovery if not provided.
-   * Supported auto discovery method are Linux ("\n"), Apple ("\r") and Windows ("\r\n") row delimiters.
-   */
-  record_delimiter?: string | string[] | Buffer | Buffer[];
-  recordDelimiter?: string | string[] | Buffer | Buffer[];
+  relax_quotes?: boolean | null;
+  relaxQuotes?: boolean | null;
   /**
    * If true, ignore whitespace immediately preceding the delimiter (i.e. right-trim all fields), defaults to false.
    * Does not remove whitespace in a quoted field.
@@ -406,27 +406,27 @@ export interface Options<T = string[]> {
    * Dont generate empty values for empty lines.
    * Defaults to false
    */
-  skip_empty_lines?: boolean;
-  skipEmptyLines?: boolean;
+  skip_empty_lines?: boolean | null;
+  skipEmptyLines?: boolean | null;
   /**
-   * Skip a line with error found inside and directly go process the next line.
+   * Don't generate records for lines containing empty column values (column matching /\s*\/), defaults to false.
    */
-  skip_records_with_error?: boolean;
-  skipRecordsWithError?: boolean;
+  skip_records_with_empty_values?: boolean | null;
+  skipRecordsWithEmptyValues?: boolean | null;
   /**
-   * Don't generate records for lines containing empty column values (column matching /\s*\/), defaults to false.
+   * Skip a line with error found inside and directly go process the next line.
    */
-  skip_records_with_empty_values?: boolean;
-  skipRecordsWithEmptyValues?: boolean;
+  skip_records_with_error?: boolean | null;
+  skipRecordsWithError?: boolean | null;
   /**
    * Stop handling records after the requested number of records.
    */
-  to?: number;
+  to?: null | number | string;
   /**
    * Stop handling records after the requested line number.
    */
-  to_line?: number;
-  toLine?: number;
+  to_line?: null | number | string;
+  toLine?: null | number | string;
   /**
    * If true, ignore whitespace immediately around the delimiter, defaults to false.
    * Does not remove whitespace in a quoted field.

packages/csv-parse/test/api.assert_error.ts

@@ -1,5 +1,5 @@
 import should from "should";
-import { CsvError } from "../lib/index.js";
+import { CsvError, normalize_options } from "../lib/index.js";
 
 /* eslint mocha/no-exports: "off" */
 export const assert_error = function <T>(
@@ -60,12 +60,10 @@ describe("API assert_error", function () {
   });
 
   it("exhaustive detect a property not in assert", function () {
-    const err = new CsvError(
-      "CSV_UNKNOWN_ERROR",
-      "A message",
-      {},
-      { a_key: "a value" },
-    );
+    const options = normalize_options({});
+    const err = new CsvError("CSV_UNKNOWN_ERROR", "A message", options, {
+      a_key: "a value",
+    });
     (() => {
       assert_error(
         err,
@@ -124,12 +122,10 @@ describe("API assert_error", function () {
   });
 
   it("validate a boolean true value", function () {
-    const err = new CsvError(
-      "CSV_UNKNOWN_ERROR",
-      "A message",
-      {},
-      { a_boolean: true },
-    );
+    const options = normalize_options({});
+    const err = new CsvError("CSV_UNKNOWN_ERROR", "A message", options, {
+      a_boolean: true,
+    });
     assert_error<{ a_boolean: boolean }>(err, {
       a_boolean: true,
     });
@@ -141,12 +137,10 @@ describe("API assert_error", function () {
   });
 
   it("validate a boolean false value", function () {
-    const err = new CsvError(
-      "CSV_UNKNOWN_ERROR",
-      "A message",
-      {},
-      { a_boolean: false },
-    );
+    const options = normalize_options({});
+    const err = new CsvError("CSV_UNKNOWN_ERROR", "A message", options, {
+      a_boolean: false,
+    });
     assert_error(err, {
       a_boolean: false,
     });

packages/csv-parse/test/api.types.ts

@@ -6,6 +6,7 @@ import {
   Options,
   Parser,
   CsvError,
+  normalize_options,
 } from "../lib/index.js";
 
 describe("API Types", function () {
@@ -30,7 +31,7 @@ describe("API Types", function () {
 
     it("Expose options", function () {
       const parser: Parser = parse();
-      const options: Options = parser.options;
+      const options = parser.options;
       const keys: string[] = Object.keys(options);
       keys
         .sort()
@@ -224,13 +225,15 @@ describe("API Types", function () {
 
       const typedOptions: Options<Person> = {};
       typedOptions.columns = ["age", undefined, null, false, { name: "name" }];
-      typedOptions.columns = (record) => {
+      typedOptions.columns = (record: Person) => {
+        record;
         return ["age"];
       };
 
       const unknownTypedOptions: Options<unknown> = {};
       unknownTypedOptions.columns = ["anything", undefined, null, false];
-      unknownTypedOptions.columns = (record) => {
+      unknownTypedOptions.columns = (record: unknown) => {
+        record;
         return ["anything", undefined, null, false];
       };
     });
@@ -429,10 +432,11 @@ describe("API Types", function () {
       });
 
       it("Supports contexts", function () {
+        const options = normalize_options({});
         const error = new CsvError(
           "CSV_RECORD_INCONSISTENT_FIELDS_LENGTH",
           "MESSAGE",
-          {},
+          options,
           { testContext: { testProp: "testValue" } },
         );
 
@@ -443,12 +447,11 @@ describe("API Types", function () {
     });
 
     it("Proper type is thrown when an error is encountered", function () {
-      parse(`a,b\nc`, function (e: Error | undefined) {
+      parse(`a,b\nc`, function (e) {
+        if (!e) throw Error("Invalid assessment");
         const isCsvError = e instanceof CsvError;
         isCsvError.should.be.true();
-        (e as CsvError).code.should.eql(
-          "CSV_RECORD_INCONSISTENT_FIELDS_LENGTH",
-        );
+        e.code.should.eql("CSV_RECORD_INCONSISTENT_FIELDS_LENGTH");
       });
     });
   });

packages/csv-parse/test/info.lines.js renamed to packages/csv-parse/test/info.lines.ts

@@ -47,6 +47,7 @@ describe("info lines", function () {
         "and",valid,line,follows...
       `,
       (err, records) => {
+        if (!err) return next(Error("Invalid assessment"));
         assert_error(err, {
           message:
             'Invalid Opening Quote: a quote is found on field 4 at line 3, value is "h"',
@@ -72,6 +73,7 @@ describe("info lines", function () {
         skip_empty_lines: true,
       },
       (err, records) => {
+        if (!err) return next(Error("Invalid assessment"));
         assert_error(err, {
           message:
             'Invalid Opening Quote: a quote is found on field 3 at line 4, value is "invalid h"',
@@ -94,6 +96,7 @@ describe("info lines", function () {
         "",1974,8.8392926E7,"",""
       `,
       (err, records) => {
+        if (!err) return next(Error("Invalid assessment"));
         assert_error(err, {
           message:
             "Quote Not Closed: the parsing is finished with an opening quote at line 5",
@@ -120,6 +123,7 @@ describe("info lines", function () {
         delimiter: "\t",
       },
       (err, records) => {
+        if (!err) return next(Error("Invalid assessment"));
         assert_error(err, {
           message:
             'Invalid Closing Quote: got " " at line 3 instead of delimiter, record delimiter, trimable character (if activated) or comment',
@@ -146,6 +150,7 @@ describe("info lines", function () {
         escape: '"',
       },
       (err, records) => {
+        if (!err) return next(Error("Invalid assessment"));
         assert_error(err, {
           message:
             'Invalid Closing Quote: got "t" at line 2 instead of delimiter, record delimiter, trimable character (if activated) or comment',

packages/csv-parse/test/option.bom.js

@@ -1,6 +1,5 @@
 import "should";
 import { parse } from "../lib/index.js";
-import { assert_error } from "./api.assert_error.js";
 
 describe("Option `bom`", function () {
   it("validate", function () {
@@ -11,126 +10,4 @@ describe("Option `bom`", function () {
       code: "CSV_INVALID_OPTION_BOM",
     });
   });
-
-  it("preserve bom if not defined", function (next) {
-    const parser = parse((err, records) => {
-      records.should.eql([
-        ["\ufeffa", "b", "c"],
-        ["d", "e", "f"],
-      ]);
-      next();
-    });
-    parser.write(Buffer.from("\ufeffa,b,c\n"));
-    parser.write(Buffer.from("d,e,f"));
-    parser.end();
-  });
-
-  it("preserve BOM if false", function (next) {
-    const parser = parse({ bom: false }, (err, records) => {
-      records.should.eql([
-        ["\ufeffa", "b", "c"],
-        ["d", "e", "f"],
-      ]);
-      next();
-    });
-    parser.write(Buffer.from("\ufeffa,b,c\n"));
-    parser.write(Buffer.from("d,e,f"));
-    parser.end();
-  });
-
-  it("with column option with bom `true`", function (next) {
-    const parser = parse(
-      {
-        columns: true,
-        bom: true,
-      },
-      (err, records) => {
-        records[0]["key"].should.eql("value");
-        next();
-      },
-    );
-    parser.write(Buffer.from("\ufeffkey\nvalue"));
-    parser.end();
-  });
-
-  it("with column option with bom `false`", function (next) {
-    const parser = parse(
-      {
-        columns: true,
-        bom: false,
-      },
-      (err, records) => {
-        records[0]["\ufeffkey"].should.eql("value");
-        next();
-      },
-    );
-    parser.write(Buffer.from("\ufeffkey\nvalue"));
-    parser.end();
-  });
-
-  it("throw parsing error if quote follow bom", function (next) {
-    const parser = parse((err) => {
-      assert_error(err, {
-        message:
-          'Invalid Opening Quote: a quote is found on field 0 at line 1, value is "\ufeff" (utf8 bom)',
-        code: "INVALID_OPENING_QUOTE",
-        field: "\ufeff",
-      });
-      next();
-    });
-    parser.write(Buffer.from('\ufeff"a",b,c\n'));
-    parser.write(Buffer.from("d,e,f"));
-    parser.end();
-  });
-
-  it("handle BOM with utf8 (default)", function (next) {
-    const parser = parse({ bom: true }, (err, records) => {
-      records.should.eql([
-        ["a", "b", "c"],
-        ["d", "e", "f"],
-      ]);
-      next();
-    });
-    parser.write(Buffer.from("\ufeffa,b,c\n"));
-    parser.write(Buffer.from("d,e,f"));
-    parser.end();
-  });
-
-  it("preserve data if BOM is true", function (next) {
-    const parser = parse({ bom: true }, (err, records) => {
-      records.should.eql([
-        ["a", "b", "c"],
-        ["d", "e", "f"],
-      ]);
-      next();
-    });
-    parser.write(Buffer.from("a,b,c\n"));
-    parser.write(Buffer.from("d,e,f"));
-    parser.end();
-  });
-
-  it("handle BOM even if no enough data in the first package", function (next) {
-    const parser = parse({ bom: true }, (err, records) => {
-      records.should.eql([
-        ["a", "b", "c"],
-        ["d", "e", "f"],
-      ]);
-      next();
-    });
-    parser.write(Buffer.from([239]));
-    parser.write(Buffer.from([187]));
-    parser.write(Buffer.from([191]));
-    parser.write(Buffer.from("a,b,c\n"));
-    parser.write(Buffer.from("d,e,f"));
-    parser.end();
-  });
-
-  it("preserve data if no enough data to detect BOM", function (next) {
-    const parser = parse({ bom: true }, (err, records) => {
-      records.should.eql([["\ufffd"]]);
-      next();
-    });
-    parser.write(Buffer.from([239, 187]));
-    parser.end();
-  });
 });