adaltas / node-csv-docs

Website for the csv projects

Node CSV documentation website

The repository contains the source code generating the website of the Node.js CSV project.

Developers

To start a local instance of the website with yarn:

yarn install
yarn run develop

To fetch the latest source code of the project:

git submodule update --rebase --remote

node-csv-docs's Issues

Make docs searchable

Currently there's no way to search the docs site. Most modern project docs have a search box that indexes the content.

Semicolon needed in the async iterator example code

The example code on https://github.com/adaltas/node-csv-docs/blob/master/src/md/parse/api/async_iterator.md needs a semicolon after const parse = require('csv-parse'). It's followed by an IIFE. I ran the code and received the following error:

filepath/async_iterator.js:28
})();
  ^

TypeError: require(...)(...) is not a function

Outdated csv-parse option on documentation page

Thanks for making my life easier by maintaining CSV tools! 🙏 ❤️

The csv-parse options overview lists skip_lines_with_empty_values here: https://csv.js.org/parse/options/

It links to a 404 page. I believe this is now called skip_records_with_empty_values and a corresponding page exists here: https://csv.js.org/parse/options/skip_records_with_empty_values/

browser import paths do not exist

The browser import paths mentioned in https://github.com/adaltas/node-csv-docs/blob/master/src/md/parse/distributions/browser_esm.md#usage do not exist in the current version of csv-parse. The closest I can find is csv-parse/dist/esm, which does seem to work.

Explain clearly that INVALID_OPENING_QUOTE error can be caused due to BOM character

We've been stuck with the INVALID_OPENING_QUOTE error for days due to first row of CSV file starting with a quote:
"1800","2000 5","2000","2000 6","2000 4","2000 2","2000 3","2000 1","2500"

Apparently this was because of the BOM character and setting bom:true fixed the issue:
https://csv.js.org/parse/options/bom/

I highly recommend to add a clear explanation in the docs that INVALID_OPENING_QUOTE might be caused by not applying bom:true when files are UTF.

Ideally the library should recognise encoding / BOM character automatically by default (if possible) and enable the bom:true parameter should be handled automatically.

Otherwise this causes unexpected behavior in production when someone gives a file which starts with a quote in the first value.

csv-parse: 'samples' and 'test' links are broken

issue is on the mentioned page
https://csv.js.org/parse/api/
Checking 'samples' and 'test' folders redirect to a 404 page not found Github page

Examples on docs site are unreadable

The examples on the docs site (here, as well as the other csv submodules examples) show the syntax highlighting briefly after page load, and then the text color seems to be overridden to the same color as the background (both are #333).

In the attached screenshot you can see that the text is in fact there, but not rendered with the proper syntax highlighting.

No examples on how to parse csv files.

Most of the example are parsing hardcoded csv strings

Docs

Errors in 'File system interaction' page for csv-parse

There's a couple of errors in the sync example at the bottom of this page: https://csv.js.org/parse/recipies/file_interaction/

The path to the parse module is incorrect our outdated. const parse = require('csv-parse/lib/parse') should changed to `const parse = require('csv-parse/lib/sync')'.

The for loop should use 'for of' instead of 'for in' otherwise, you'll only get the indices of records written to the console: for(let record in records).