@thi.ng/csv 2.3.86 → 2.3.87

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2024-05-08T18:24:31Z
+- **Last updated**: 2024-06-21T19:34:38Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,12 @@ See [Conventional Commits](https://conventionalcommits.org/) for commit guidelin
 **Note:** Unlisted _patch_ versions only involve non-code or otherwise excluded changes
 and/or version bumps of transitive dependencies.
 
+### [2.3.87](https://github.com/thi-ng/umbrella/tree/@thi.ng/csv@2.3.87) (2024-06-21)
+
+#### ♻️ Refactoring
+
+- enforce uniform naming convention of internal functions ([56992b2](https://github.com/thi-ng/umbrella/commit/56992b2))
+
 ### [2.3.81](https://github.com/thi-ng/umbrella/tree/@thi.ng/csv@2.3.81) (2024-04-08)
 
 #### ♻️ Refactoring

package/README.md

@@ -7,7 +7,7 @@
 [![Mastodon Follow](https://img.shields.io/mastodon/follow/109331703950160316?domain=https%3A%2F%2Fmastodon.thi.ng&style=social)](https://mastodon.thi.ng/@toxi)
 
 > [!NOTE]
-> This is one of 192 standalone projects, maintained as part
+> This is one of 193 standalone projects, maintained as part
 > of the [@thi.ng/umbrella](https://github.com/thi-ng/umbrella/) monorepo
 > and anti-framework.
 >
@@ -20,6 +20,7 @@
   - [Planned features](#planned-features)
 - [Installation](#installation)
 - [Dependencies](#dependencies)
+- [Usage examples](#usage-examples)
 - [API](#api)
 - [Authors](#authors)
 - [License](#license)
@@ -95,6 +96,16 @@ Package sizes (brotli'd, pre-treeshake): ESM: 1.53 KB
 - [@thi.ng/strings](https://github.com/thi-ng/umbrella/tree/develop/packages/strings)
 - [@thi.ng/transducers](https://github.com/thi-ng/umbrella/tree/develop/packages/transducers)
 
+## Usage examples
+
+One project in this repo's
+[/examples](https://github.com/thi-ng/umbrella/tree/develop/examples)
+directory is using this package:
+
+| Screenshot                                                                                                               | Description                        | Live demo                                               | Source                                                                               |
+|:-------------------------------------------------------------------------------------------------------------------------|:-----------------------------------|:--------------------------------------------------------|:-------------------------------------------------------------------------------------|
+| <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/geom-csv-piechart.png" width="240"/> | Piechart visualization of CSV data | [Demo](https://demo.thi.ng/umbrella/geom-csv-piechart/) | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/geom-csv-piechart) |
+
 ## API
 
 [Generated API docs](https://docs.thi.ng/umbrella/csv/)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/csv",
-  "version": "2.3.86",
+  "version": "2.3.87",
   "description": "Customizable, transducer-based CSV parser/object mapper and transformer",
   "type": "module",
   "module": "./index.js",
@@ -10,7 +10,7 @@
     "type": "git",
     "url": "https://github.com/thi-ng/umbrella.git"
   },
-  "homepage": "https://github.com/thi-ng/umbrella/tree/develop/packages/csv#readme",
+  "homepage": "https://thi.ng/csv",
   "funding": [
     {
       "type": "github",
@@ -36,16 +36,16 @@
     "tool:tangle": "../../node_modules/.bin/tangle src/**/*.ts"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.11.2",
-    "@thi.ng/checks": "^3.6.4",
-    "@thi.ng/strings": "^3.7.33",
-    "@thi.ng/transducers": "^9.0.5"
+    "@thi.ng/api": "^8.11.3",
+    "@thi.ng/checks": "^3.6.5",
+    "@thi.ng/strings": "^3.7.34",
+    "@thi.ng/transducers": "^9.0.6"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.43.2",
-    "esbuild": "^0.21.1",
+    "@microsoft/api-extractor": "^7.47.0",
+    "esbuild": "^0.21.5",
     "typedoc": "^0.25.13",
-    "typescript": "^5.4.5"
+    "typescript": "^5.5.2"
   },
   "keywords": [
     "csv",
@@ -85,5 +85,5 @@
   "thi.ng": {
     "year": 2014
   },
-  "gitHead": "df34b4a9e650cc7323575356de207d78933bdcf3\n"
+  "gitHead": "154c95cf9d6bab32174498ec3b5b5d87e42be7f9\n"
 }

package/parse.js

@@ -32,8 +32,8 @@ function parseCSV(opts, src) {
     let isQuoted = false;
     let record = [];
     const init = (header2) => {
-      cols && (index = initIndex(header2, cols));
-      all && (revIndex = initRevIndex(header2));
+      cols && (index = __initIndex(header2, cols));
+      all && (revIndex = __initRevIndex(header2));
       first = false;
     };
     const collectAll = (row) => record.reduce(
@@ -54,7 +54,7 @@ function parseCSV(opts, src) {
       if ((!line.length || line.startsWith(comment)) && !isQuoted)
         return acc;
       if (!first) {
-        isQuoted = parseLine(
+        isQuoted = __parseLine(
           line,
           record,
           isQuoted,
@@ -68,7 +68,7 @@ function parseCSV(opts, src) {
         record = [];
         return reduce(acc, row);
       } else {
-        isQuoted = parseLine(
+        isQuoted = __parseLine(
           line,
           record,
           isQuoted,
@@ -115,7 +115,7 @@ function parseCSVSimple(opts, src) {
       if ((!line.length || line.startsWith(comment)) && !isQuoted)
         return acc;
       if (!first) {
-        isQuoted = parseLine(
+        isQuoted = __parseLine(
           line,
           record,
           isQuoted,
@@ -127,7 +127,7 @@ function parseCSVSimple(opts, src) {
         record = [];
         return reduce(acc, row);
       } else {
-        isQuoted = parseLine(
+        isQuoted = __parseLine(
           line,
           record,
           isQuoted,
@@ -143,7 +143,7 @@ function parseCSVSimple(opts, src) {
 }
 const parseCSVFromString = (opts, src) => parseCSV(opts, split(src));
 const parseCSVSimpleFromString = (opts, src) => parseCSVSimple(opts, split(src));
-const parseLine = (line, acc, isQuoted, delim, quote) => {
+const __parseLine = (line, acc, isQuoted, delim, quote) => {
   let curr = "";
   let p = "";
   let openQuote = isQuoted;
@@ -162,7 +162,7 @@ const parseLine = (line, acc, isQuoted, delim, quote) => {
         continue;
       } else if (line[i + 1] !== quote) isQuoted = false;
     } else if (!isQuoted && c === delim) {
-      collectCell(acc, curr, openQuote);
+      __collectCell(acc, curr, openQuote);
       openQuote = false;
       curr = "";
     } else if (c !== "\\") {
@@ -170,11 +170,11 @@ const parseLine = (line, acc, isQuoted, delim, quote) => {
     }
     p = c;
   }
-  curr !== "" && collectCell(acc, curr, openQuote);
+  curr !== "" && __collectCell(acc, curr, openQuote);
   return isQuoted;
 };
-const collectCell = (acc, curr, openQuote) => openQuote ? acc[acc.length - 1] += "\n" + curr : acc.push(curr);
-const initIndex = (line, cols) => isArray(cols) ? cols.reduce((acc, spec, i) => {
+const __collectCell = (acc, curr, openQuote) => openQuote ? acc[acc.length - 1] += "\n" + curr : acc.push(curr);
+const __initIndex = (line, cols) => isArray(cols) ? cols.reduce((acc, spec, i) => {
   if (spec) {
     const alias = spec.alias || line[i] || String(i);
     acc[alias] = { i, spec: { alias, ...spec } };
@@ -184,7 +184,7 @@ const initIndex = (line, cols) => isArray(cols) ? cols.reduce((acc, spec, i) =>
   (acc, id, i) => cols[id] ? (acc[id] = { i, spec: cols[id] }, acc) : acc,
   {}
 );
-const initRevIndex = (line) => line.reduce((acc, x, i) => (acc[i] = x, acc), {});
+const __initRevIndex = (line) => line.reduce((acc, x, i) => (acc[i] = x, acc), {});
 export {
   parseCSV,
   parseCSVFromString,

package/transforms.d.ts

@@ -64,11 +64,11 @@ export declare const url: CellTransform;
  * @param defaultVal
  */
 export declare const oneOf: <T>(mappings: IObjectOf<T>, defaultVal: T) => CellTransform;
-export declare const zeroPad: (digits: number) => (x: any, length?: number | undefined) => string;
+export declare const zeroPad: (digits: number) => (x: any, length?: number) => string;
 export declare const formatFloat: (prec?: number) => (x: number) => string;
 /**
  * Higher order cell value formatter. Takes normalized values and formats them
  * as percentage with given `precision` (number of fractional digits).
  */
-export declare const formatPercent: (prec?: number | undefined) => import("@thi.ng/strings").Stringer<number>;
+export declare const formatPercent: (prec?: number) => import("@thi.ng/strings").Stringer<number>;
 //# sourceMappingURL=transforms.d.ts.map