.github/ISSUE_TEMPLATE/bug_report.md

@@ -4,7 +4,6 @@ about: Create a report to help us improve
 title: ''
 labels: bug
 assignees: ''
-
 ---
 
 **Describe the bug**
@@ -13,7 +12,9 @@ A clear and concise description of what the bug is, the CSV package version you
 
 **To Reproduce**
 
-Please provide us with a unit test, an example code or even pseudo-code. It could be written in JavaScript or CoffeeScript, it doesn't matter. What's important is to limit the data to the minimum as well as to strip down the number of options to the only ones with an impact.
+Please provide us with a unit test, an example code or even pseudo-code. It could be written in JavaScript or CoffeeScript, but not in TypeScript unless the bug is related to TypeScript.
+
+What's important is to **limit the data** to the minimum as well as to **strip down the number of options** to the relevant ones with an impact. Do not reference an external file.
 
 **Additional context**
 

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: CSV Documentation
+    url: https://csv.js.org/
+    about: Check out the CSV documentation for answers to common questions

.github/ISSUE_TEMPLATE/feature_request.md

@@ -4,20 +4,23 @@ about: Suggest an idea for this project
 title: ''
 labels: enhancement
 assignees: ''
-
 ---
 
-**Is your feature request related to a problem? Please describe.**
+**Summary**
+
+A clear and concise description of what the feature is.
+
+**Motivation**
 
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+If the feature is related to a problem, describe it. Add any other context explaining why this feature is of interest to you and the community.
 
-**Describe the solution you'd like**
+**Alternative**
 
-A clear and concise description of what you want to happen.
+A clear and concise description of alternative solutions or features you've considered.
 
-**Describe alternatives you've considered**
+**Draft**
 
-A clear and concise description of any alternative solutions or features you've considered.
+Write a proposal for the feature, how it works, its expected coverage, a sample code or unit test. If the feature is related to a documentation or article, write the content or the table of content you expect.
 
 **Additional context**
 

.github/workflows/nodejs.yml

@@ -0,0 +1,52 @@
+# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: Node.js
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [16.x]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node-version }}
+    - run: yarn --frozen-lockfile
+    - run: yarn run test
+  test_legacy:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [12.x, 14.x]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node-version }}
+    - run: yarn --frozen-lockfile
+    - run: yarn run test:legacy
+  publish:
+    needs: [test, test_legacy]
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [16.x]
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node-version }}
+        registry-url: 'https://registry.npmjs.org'
+    - run: yarn --frozen-lockfile
+    - run: yarn run publish
+      env:
+        NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -1,6 +1,6 @@
 .*
-/node_modules
-/packages/*/node_modules
+node_modules
+!.eslintrc
 !.github
 !.gitignore
 !.husky

README.md

@@ -9,6 +9,8 @@
 
 </pre>
 
+# CSV packages for Node.js and the web
+
 This project provides CSV generation, parsing, transformation and serialization for Node.js.
 
 It has been tested and used by a large community over the years and should be considered reliable. It provides every option you would expect from an advanced CSV parser and stringifier.
@@ -17,21 +19,47 @@ It has been tested and used by a large community over the years and should be co
 
 This repository is a monorepo managed using [Lerna](https://github.com/lerna/lerna). There are 5 packages managed in this codebase, even though we publish them to NPM as separate packages:
 
-*   [`csv`](packages/csv/),
-    an umbrella which is itself split into 4 packages.
-*   [`csv-generate`](packages/csv-generate/),
-    a flexible generator of CSV string and Javascript objects.
-*   [`csv-parse`](packages/csv-parse/),
-    a parser converting CSV text into arrays or objects.
-*   [`csv-stringify`](packages/csv-stringify/),
-    a stringifier converting records into a CSV text.
-*   [`stream-transform`](packages/stream-transform/),
-    a transformation framework.
+* [`csv`](https://csv.js.org/)
+  ([GitHub](https://github.com/adaltas/node-csv/tree/master/packages/csv)),
+  an umbrella which is itself split into 4 packages.
+* [`csv-generate`](https://csv.js.org/generate/)
+  ([GitHub](https://github.com/adaltas/node-csv/tree/master/packages/csv-generate)),
+  a flexible generator of CSV string and Javascript objects.
+* [`csv-parse`](https://csv.js.org/parse/)
+  ([GitHub](https://github.com/adaltas/node-csv/tree/master/packages/csv-parse)),
+  a parser converting CSV text into arrays or objects.
+* [`csv-stringify`](https://csv.js.org/stringify/)
+  ([GitHub](https://github.com/adaltas/node-csv/tree/master/packages/csv-stringify)),
+  a stringifier converting records into a CSV text.
+* [`stream-transform`](https://csv.js.org/transform/)
+  ([GitHub](https://github.com/adaltas/node-csv/tree/master/packages/stream-transform)),
+  a transformation framework.
 
 ## Documentation
 
 The full documentation for the current version is available [here](https://csv.js.org).
 
+* [Getting Started](https://csv.js.org/project/getting-started/)
+* [Examples](https://csv.js.org/project/examples/)
+* [License](https://csv.js.org/project/license/)
+* [Community](https://csv.js.org/project/contribute/)
+
+## Features
+
+* Extends the native Node.js [transform stream API](http://nodejs.org/api/stream.html#stream_class_stream_transform)
+* Simplicity with the optional callback and sync API
+* Support for ECMAScript modules and CommonJS
+* Large documentation, numerous examples and full unit test coverage
+* Few dependencies, in many cases zero dependencies
+* Node.js support from version 8 to latest
+* Mature project with more than 10 years of history
+
 ## License
 
 Licensed under the [MIT License](LICENSE).
+
+## Contributors
+
+The project is sponsored by [Adaltas](https://www.adaltas.com), an Big Data consulting firm based in Paris, France.
+
+*   David Worms: <https://github.com/wdavidw>

demo/browser/esm/csv.html

@@ -0,0 +1,97 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>CSV parse demo</title>
+    <style>
+      div {
+        width: 60%;
+        margin: 5rem auto;
+        text-align: center;
+      }
+      textarea {
+        width: 100%;
+        height: 200px;
+      }
+      input {
+        margin: 1rem;
+      }
+      pre {
+        text-align: left;
+        padding: 2rem;
+        border: 1px solid black;
+      }
+    </style>  
+  </head>
+  <body>
+    <div>
+      <h1>CSV demo</h1>
+      <p><a href="/">back</a></p>
+      <label for="generateOptions">Generate options:</label>
+      <textarea id="generateOptions"></textarea>
+      <label for="parseOptions">Parse options:</label>
+      <textarea id="parseOptions"></textarea>
+      <label for="transformOptions">Transform handler:</label>
+      <textarea id="transformOptions"></textarea>
+      <label for="stringifyOptions">Stringify options:</label>
+      <textarea id="stringifyOptions"></textarea>
+      <input id="run" type="submit" value="run" />
+      <pre><code id="output"></code></pre>
+      <script type="module">
+        import * as csv from '/lib/esm/csv/sync.js';
+        const runEl = document.getElementById('run');
+        const generateOptionsEl = document.getElementById('generateOptions');
+        generateOptionsEl.innerHTML = JSON.stringify({
+          delimiter: '|',
+          length: 10
+        }, null, 2);
+        const parseOptionsEl = document.getElementById('parseOptions');
+        parseOptionsEl.innerHTML = JSON.stringify({
+          delimiter: '|'
+        }, null, 2);
+        const transformOptionsEl = document.getElementById('transformOptions');
+        transformOptionsEl.innerHTML = [
+          'function(record){',
+          '  return record;',
+          '}'
+        ].join('\n');
+        const stringifyOptionsEl = document.getElementById('stringifyOptions');
+        stringifyOptionsEl.innerHTML = JSON.stringify({
+          quoted: true
+        }, null, 2);
+        const outputEl = document.getElementById('output');
+        runEl.onclick = (e) => {
+          try{
+            const generateOptions = JSON.parse(generateOptionsEl.value);
+            const parseOptions = JSON.parse(parseOptionsEl.value);
+            const transform = {};
+            eval(`transform.handler = ${transformOptionsEl.value}`);
+            const stringifyOptions = JSON.parse(stringifyOptionsEl.value);
+            // Run the pipeline
+            csv
+            // Generate 20 records
+            .generate(generateOptions)
+            // Transform CSV data into records
+            .pipe(csv.parse({
+              delimiter: '|'
+            }))
+            // Transform each value into uppercase
+            .pipe(csv.transform(transform.handler))
+            // Convert objects into a stream
+            .pipe(csv.stringify(stringifyOptions))
+            // Print the CSV stream to stdout
+            .on('readable', function () {
+              let chunck; while(chunck = this.read()){
+                outputEl.innerHTML = outputEl.innerHTML + chunck.toString()
+              }
+            })
+            .on('error', function (err) {
+              outputEl.innerHTML = 'Error: ' + err.message;
+            });
+          }catch(err){
+            outputEl.innerHTML = 'Error: ' + err.message;
+          }
+        };
+      </script>
+    </div>
+  </body>
+</html> 

demo/browser/esm/csv_sync.html

@@ -0,0 +1,82 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>CSV parse demo</title>
+    <style>
+      div {
+        width: 60%;
+        margin: 5rem auto;
+        text-align: center;
+      }
+      textarea {
+        width: 100%;
+        height: 200px;
+      }
+      input {
+        margin: 1rem;
+      }
+      pre {
+        text-align: left;
+        padding: 2rem;
+        border: 1px solid black;
+      }
+    </style>  
+  </head>
+  <body>
+    <div>
+      <h1>CSV demo</h1>
+      <p><a href="/">back</a></p>
+      <label for="generateOptions">Generate options:</label>
+      <textarea id="generateOptions"></textarea>
+      <label for="parseOptions">Parse options:</label>
+      <textarea id="parseOptions"></textarea>
+      <label for="transformOptions">Transform handler:</label>
+      <textarea id="transformOptions"></textarea>
+      <label for="stringifyOptions">Stringify options:</label>
+      <textarea id="stringifyOptions"></textarea>
+      <input id="run" type="submit" value="run" />
+      <pre><code id="output"></code></pre>
+      <script type="module">
+        import * as csv from '/lib/esm/csv/sync.js';
+        const runEl = document.getElementById('run');
+        const generateOptionsEl = document.getElementById('generateOptions');
+        generateOptionsEl.innerHTML = JSON.stringify({
+          delimiter: '|',
+          length: 10
+        }, null, 2);
+        const parseOptionsEl = document.getElementById('parseOptions');
+        parseOptionsEl.innerHTML = JSON.stringify({
+          delimiter: '|'
+        }, null, 2);
+        const transformOptionsEl = document.getElementById('transformOptions');
+        transformOptionsEl.innerHTML = [
+          'function(record){',
+          '  return record;',
+          '}'
+        ].join('\n');
+        const stringifyOptionsEl = document.getElementById('stringifyOptions');
+        stringifyOptionsEl.innerHTML = JSON.stringify({
+          quoted: true
+        }, null, 2);
+        const outputEl = document.getElementById('output');
+        runEl.onclick = (e) => {
+          try{
+            const generateOptions = JSON.parse(generateOptionsEl.value);
+            const parseOptions = JSON.parse(parseOptionsEl.value);
+            const transform = {};
+            eval(`transform.handler = ${transformOptionsEl.value}`);
+            const stringifyOptions = JSON.parse(stringifyOptionsEl.value);
+            // Run the pipeline
+            const input = csv.generate(generateOptions);
+            const rawRecords = csv.parse(input, parseOptions);
+            const refinedRecords = csv.transform(rawRecords, transform.handler);
+            const output = csv.stringify(refinedRecords, stringifyOptions);
+            outputEl.innerHTML = output;
+          }catch(err){
+            outputEl.innerHTML = 'Error: ' + err.message;
+          }
+        };
+      </script>
+    </div>
+  </body>
+</html>