convert codebase to typescript (#51)

* Use ESM imports

* Move to typescript

* Add first types

* Build project to test against nodejs versions

* relax eslint

* move to ts

* reformat code

* fix esm build

* remove cyclist type

* change node:stream to stream for legacy

* polish esm/cjs dist with sourcemap

* prepare 0.9.0

.eslintrc.json

@@ -0,0 +1,49 @@
+{
+  "root": true,
+  "extends": [
+    "eslint:recommended",
+    "plugin:import/recommended",
+    "plugin:import/typescript",
+    "plugin:node/recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:prettier/recommended"
+  ],
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "project": ["tsconfig.test.json"],
+    "sourceType": "module"
+  },
+  "settings": {
+    "import/resolver": {
+      "typescript": true,
+      "node": true
+    }
+  },
+  "plugins": [
+    "@typescript-eslint",
+    "mocha"
+  ],
+  "env": {
+    "node": true,
+    "es6": true,
+    "mocha": true
+  },
+  "rules": {
+    "@typescript-eslint/no-explicit-any": "error",
+    "quote-props": ["error", "consistent"],
+    "mocha/no-skipped-tests": "warn",
+    "mocha/no-exclusive-tests": "error",
+    "node/no-unsupported-features/es-syntax": [
+      "error",
+      {
+        "version": ">=13.0.0",
+        "ignores": ["modules"]
+      }
+    ],
+    "node/no-unpublished-import": [
+      "error", {
+        "allowModules": ["slow-stream"]
+      }
+    ]
+  }
+}

.github/workflows/ci.yml

@@ -3,31 +3,51 @@ on: [ push ]
 jobs:
   test:
     runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        node-version: [10.x, 12.x, 14.x, 15.x, 16.x, 17.x, 18.x ]
     steps:
-      - uses: actions/checkout@v2
-      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v1
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
-          node-version: ${{ matrix.node-version }}
+          node-version: 21.x
+          cache: npm
       - run: npm ci
       - run: npm test
       - run: npm run lint
       - run: npm run build
+      - run: cd build && tar -czf ../build.tar.gz *
+      - uses: actions/upload-artifact@v3
+        with:
+          name: built-project
+          path: build.tar.gz
+
+  test-legacy-versions:
+    runs-on: ubuntu-latest
+    needs: test
+    strategy:
+      matrix:
+        node-version: [ 10.x, 11.x, 12.x, 13.x, 14.x, 15.x, 16.x, 17.x, 18.x, 19.x, 20.x ]
+    steps:
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+      - uses: actions/download-artifact@v3
+        with:
+          name: built-project
+      - run: mkdir -p build && tar -xzf build.tar.gz -C build
+      - run: npm --prefix build install
+      - run: npm --prefix build test
 
   coverage:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
-          node-version: '16'
+          node-version: 18.x
       - run: npm ci
       - run: npm run coverage
       - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@v2
+        uses: codecov/codecov-action@v3
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           directory: .coverage

.gitignore

@@ -1,5 +1,7 @@
-node_modules/
-.nyc_output/
+.DS_Store
 .coverage/
 .idea/
+.nyc_output/
+build/
 dist/
+node_modules/

.mocharc.json

@@ -0,0 +1,10 @@
+{
+  "timeout": 5000,
+  "exit": true,
+  "extension": ["ts", "js"],
+  "recursive": true,
+  "node-option": [
+    "experimental-specifier-resolution=node",
+    "import=tsx"
+  ]
+}

.npmignore

@@ -1,5 +1,14 @@
-.nyc_output/
+.DS_Store
 .coverage/
-.tools/
-.idea/
+.eslintrc.json
+.git/
 .github/
+.gitignore
+.idea/
+.mocharc.json
+.nyc_output/
+.prettierignore
+.prettierrc
+.tools/
+build/
+test/

.prettierignore

@@ -0,0 +1,4 @@
+**/.git
+**/node_modules
+**/.coverage
+README.md

.prettierrc

@@ -0,0 +1,5 @@
+---
+printWidth: 120
+quoteProps: "consistent"
+bracketSpacing: false
+tabWidth: 4

.tools/build.sh

@@ -0,0 +1,40 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+readonly PROJECT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/.."
+readonly BUILD_DIR="${PROJECT_DIR}/build"
+readonly DIST_DIR="${PROJECT_DIR}/dist"
+
+rm -rf "${DIST_DIR}" "${BUILD_DIR}"
+mkdir -p "${DIST_DIR}" "${BUILD_DIR}"
+
+cd "${PROJECT_DIR}"
+
+echo "Compiling oleoduc (esm version)..."
+npm run tsc -- -p tsconfig.json
+cat >"${DIST_DIR}/esm/package.json" <<!EOF
+{
+    "type": "module"
+}
+!EOF
+
+echo "Compiling oleoduc (cjs version)..."
+npm run tsc -- -p tsconfig.cjs.json
+cat >"${DIST_DIR}/cjs/package.json" <<!EOF
+{
+    "type": "commonjs"
+}
+!EOF
+
+echo "Building oleoduc for test..."
+npm run tsc -- -p tsconfig.test.json
+echo "Patching package.json to be able to run tests against previous versions of nodejs..."
+cp "${PROJECT_DIR}/package.json" "${BUILD_DIR}"
+npx json -I -f "${BUILD_DIR}/package.json" -e 'this.type="commonjs"'
+npx json -I -f "${BUILD_DIR}/package.json" -e 'this.devDependencies.mocha="9.x"'
+npx json -I -f "${BUILD_DIR}/package.json" -e 'this.scripts.test="mocha --recursive --exit test/**/*-test.js"'
+cat >"${BUILD_DIR}/.mocharc.json" <<!EOF
+{}
+!EOF
+cd -
+

.tools/hooks.sh

@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+readonly PROJECT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/.."
+readonly PRE_COMMIT_HOOK="${PROJECT_DIR}/.git/hooks/pre-commit"
+
+cat <<'EOF' >"${PRE_COMMIT_HOOK}"
+#!/usr/bin/env bash
+set -euo pipefail
+# Do not edit. This file has been generated by oleoduc
+
+npm test
+npm run lint
+npm run build
+
+EOF
+
+chmod +x "${PRE_COMMIT_HOOK}"
+echo "pre-push hooks installed in ${PRE_COMMIT_HOOK}"

README.md

@@ -100,7 +100,7 @@ for await (const data of csvStream) {
 
 ## accumulateData(callback, [options])
 
-Allows data to be accumulated before piping them to the next step. It can be used to reduce the data or to create group
+Allows data to be accumulated before piping them to the next step. It can be used to reduce or group data
 
 #### Parameters
 
@@ -169,7 +169,7 @@ oleoduc(
 
 ## compose(...streams, [options])
 
-Same as oleoduc but without promise stuff.
+Same as oleoduc but without promise stuff and stream composition capability
 
 #### Parameters
 
@@ -381,7 +381,7 @@ oleoduc(
 
 ## mergeStreams(...streams, [options])
 
-Allows streams to be merged into a single one.
+Allows chunks of multiple streams to be processed in no particular order.
 
 #### Parameters
 
@@ -432,8 +432,8 @@ await oleoduc(
 Pipe streams together, forwards errors and returns a promisified stream.
 
 It is same as nodejs
-core [pipeline](https://nodejs.org/api/stream.html#stream_stream_pipeline_source_transforms_destination_callback) but
-with better error handling and stream composition capability.
+core [pipeline](https://nodejs.org/api/stream.html#stream_stream_pipeline_source_transforms_destination_callback) 
+but with better error handling.
 
 If the last stream is readable, the returned stream will be iterable
 
@@ -554,6 +554,36 @@ Robert;Hue
 `
 ```
 
+Stream data as if it where a csv with options
+
+```js
+const { oleoduc, transformIntoCSV } = require("oleoduc");
+const { Readable } = require("stream");
+const { createWriteStream } = require("fs");
+
+const source = Readable.from([{ firstname: "John", lastname: "Doe" }, { firstname: "Robert", lastname: "Hue" }]);
+
+await oleoduc(
+  source,
+  transformIntoCSV({
+    sepatator: "|",
+    mapper: (v) => `"${v || ''}"`,//Values will be enclosed in double quotes
+    columns: {
+      fullname: (data) => `${data.firstName} ${data.lastName}`,
+      date: () => new Date().toISOString(),
+    },
+  }),
+  createWriteStream("/path/to/file")
+);
+
+// --> Output CSV file
+`
+fullname|date
+John Doe|2021-03-12T21:34:13.085Z
+Robert Hue|2021-03-12T21:34:13.085Z
+`
+```
+
 ## transformIntoJSON([options])
 
 Allows data to be streamed as if it were a json string
@@ -582,7 +612,6 @@ await oleoduc(
 
 // Json Output
 '[{ user: "John Doe" }, { user: "Robert Hue" }]'
-
 ```
 
 Stream data as if it where a json object with an array property inside
@@ -603,36 +632,6 @@ await oleoduc(
 '{ other: "data", users: [{ user: "John Doe" }, { user: "Robert Hue" }] }'
 ```
 
-Stream data as if it where a csv with options
-
-```js
-const { oleoduc, transformIntoCSV } = require("oleoduc");
-const { Readable } = require("stream");
-const { createWriteStream } = require("fs");
-
-const source = Readable.from([{ firstname: "John", lastname: "Doe" }, { firstname: "Robert", lastname: "Hue" }]);
-
-await oleoduc(
-  source,
-  transformIntoCSV({
-    sepatator: "|",
-    mapper: (v) => `"${v || ''}"`,//Values will be enclosed in double quotes
-    columns: {
-      fullname: (data) => `${data.firstName} ${data.lastName}`,
-      date: () => new Date().toISOString(),
-    },
-  }),
-  createWriteStream("/path/to/file")
-);
-
-// --> Output CSV file
-`
-fullname|date
-John Doe|2021-03-12T21:34:13.085Z
-Robert Hue|2021-03-12T21:34:13.085Z
-`
-```
-
 ## transformStream([options])
 
 Allows chunks of a sub-stream to be streamed as if each was part of the source