@jackens/nnn 2024.4.5 → 2024.4.7

package/nnn.d.ts

@@ -1,3 +1,15 @@
+/**
+ * A tiny helper for CSV parsing.
+ *
+ * Options:
+ * - `header`: flag indicating that the parsed CSV has a header row (default: `true`)
+ * - `separator`: field separator (default: `','`)
+ */
+export declare const csvParse: (text: string, { header, separator }?: {
+    header?: boolean | undefined;
+    separator?: string | undefined;
+}) => Partial<Array<Partial<Record<PropertyKey, string>>>> | Partial<Array<Partial<Array<string>>>>;
+
 /**
  * The type of arguments of the `escapeValues` and `escape` helpers.
  */

package/nnn.js

@@ -1,3 +1,17 @@
+// src/nnn/csvParse.ts
+var csvParse = (text, { header = true, separator = "," } = {}) => {
+  const regExp = new RegExp(`${separator}|(?<!")\\s*"((?:[^"]|"")*)"\\s*(?!")`, "g");
+  const rows = text.replace(/\r/g, "").replace(/\n+$/, "").replace(/\n|(?<!")("(?:[^"]|"")*")(?!")/g, (_, chunk) => chunk ?? "\r").split("\r").map((line) => line.replace(regExp, (_, chunk) => chunk == null ? "\r" : chunk.replace(/""/g, '"')).split("\r"));
+  if (header) {
+    const keys = rows.shift();
+    return rows.map((row) => keys.reduce((record, key, index) => {
+      record[key] = row[index];
+      return record;
+    }, {}));
+  }
+  return rows;
+};
+
 // src/nnn/escape.ts
 var escapeValues = (escapeMap, values) => values.map((value) => (escapeMap.get(value?.constructor) ?? escapeMap.get(undefined))?.(value) ?? "");
 var escape = (escapeMap, template, ...values) => String.raw(template, ...escapeValues(escapeMap, values));
@@ -272,5 +286,6 @@ export {
   h,
   fixTypography,
   escapeValues,
-  escape
+  escape,
+  csvParse
 };

package/package.json

@@ -4,13 +4,11 @@
   "homepage": "https://jackens.github.io/nnn/doc/",
   "keywords": [
     "CSS-in-JS",
-    "deepEqual",
+    "CSV",
+    "csvParse",
     "DOM",
-    "eq",
-    "equal",
     "escape",
     "Gantt",
-    "graph",
     "h",
     "has",
     "highlight",
@@ -40,5 +38,5 @@
   "types": "nnn.d.ts",
   "name": "@jackens/nnn",
   "type": "module",
-  "version": "2024.4.5"
+  "version": "2024.4.7"
 }

package/readme.md

@@ -2,7 +2,7 @@
 
 Jackens’ JavaScript helpers.
 
-<sub>Version: <code class="version">2024.4.5</code></sub>
+<sub>Version: <code class="version">2024.4.7</code></sub>
 
 ## Examples
 
@@ -44,6 +44,7 @@ import { «something» } from './node_modules/@jackens/nnn/nnn.js'
 - `HArgs1`: The type of arguments of the `h` and `s` helpers.
 - `JcNode`: The type of arguments of the `jc` helper.
 - `JcRoot`: The type of arguments of the `jc` helper.
+- `csvParse`: A tiny helper for CSV parsing.
 - `escape`: A generic helper for escaping `values` by given `escapeMap` (in *TemplateStrings* flavor).
 - `escapeValues`: A generic helper for escaping `values` by given `escapeMap`.
 - `fixTypography`: A helper that implements typographic corrections specific to Polish typography.
@@ -106,6 +107,49 @@ type JcRoot = Partial<Record<PropertyKey, JcNode>>;
 
 The type of arguments of the `jc` helper.
 
+### csvParse
+
+```ts
+const csvParse: (text: string, { header, separator }?: {
+    header?: boolean | undefined;
+    separator?: string | undefined;
+}) => Partial<Array<Partial<Record<PropertyKey, string>>>> | Partial<Array<Partial<Array<string>>>>;
+```
+
+A tiny helper for CSV parsing.
+
+Options:
+- `header`: flag indicating that the parsed CSV has a header row (default: `true`)
+- `separator`: field separator (default: `','`)
+
+#### Usage Examples
+
+```js
+const text = `"aaa
+""aaa""
+aaa",bbb, "ccc,ccc"
+"xxx,xxx", "yyy
+yyy",zzz
+42,"42"  , 17
+
+`
+expect(csvParse(text, { header: false })).toStrictEqual([
+  ['aaa\n"aaa"\naaa', 'bbb', 'ccc,ccc'],
+  ['xxx,xxx', 'yyy\nyyy', 'zzz'],
+  ['42', '42', ' 17']
+])
+
+expect(csvParse(text)).toStrictEqual([{
+  'aaa\n"aaa"\naaa': 'xxx,xxx',
+  bbb: 'yyy\nyyy',
+  'ccc,ccc': 'zzz'
+}, {
+  'aaa\n"aaa"\naaa': '42',
+  bbb: '42',
+  'ccc,ccc': ' 17'
+}])
+```
+
 ### escape
 
 ```ts