https://github.com/zazuko/csv-validate
Client Side and CLI JS validator.
https://github.com/zazuko/csv-validate
Last synced: about 1 year ago
JSON representation
Client Side and CLI JS validator.
- Host: GitHub
- URL: https://github.com/zazuko/csv-validate
- Owner: zazuko
- Created: 2020-09-11T12:28:18.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-10-27T14:16:41.000Z (over 3 years ago)
- Last Synced: 2025-03-28T14:01:38.713Z (about 1 year ago)
- Language: JavaScript
- Size: 293 KB
- Stars: 5
- Watchers: 5
- Forks: 5
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# csv-validate: Validating CSV Parser
This JS CSV validating parser is based on [csv-parse](https://github.com/wdavidw/node-csv-parse) and [csv-sniffer](https://github.com/MonetDBSolutions/npm-csv-sniffer). It features data streaming, error tracing, and automatic identification of the CSV delimiters and quotes.
`csv-validate` provides both NodeJS module (NPM), optional console UI (CLI), and browser/Web UI for the local validation of CSV files.
`\author` Artem Lutov
`\affiliation` [Zazuko GmbH](https://zazuko.com), [Lutov Analytics](https://lutan.ch)
`\license` [Apache 2](https://www.apache.org/licenses/LICENSE-2.0)
## Web UI
The Web UI bundle is located in `dist/` and consists of 3 files (and optional `test.csv` example to test the web app):
```sh
dist/
index.html
styles.css
main.js
```
To build the Web UI, just execute `npm run build` from the package directory, producing the `main.js` bundle in `dist/`. Afterward, open `index.html` in your browser to use the web app:
## CLI
Console UI provides the following interface:
```sh
$ npx csv-validate -h
Usage: csv-validate [options]
Options:
-r, --relax-column-count relax column count instead of emitting an error
-s, --skip-error-lines skip lines with errors instead of emitting an
error
-d, --delimiter enforce specified CSV delimiter instead of
inferring it
-q, --quotes left [and right if distinct] quote symbols instead
of inferring them (default: "")
-n, --new-line enforce specified CSV new line (e.g., \r\n)
instead of inferring it
-e, --encoding file encoding (default: "utf8")
-h, --help display help for command
```
To install it, execute:
```sh
$ npm install [-g] csv-validate
```
Otherwise, the executable can be called from the package sources as:
```sh
$ bin/csv-validate.js -h
```
## NodeJS Module
The module interface abstracts [csv-parse](https://github.com/wdavidw/node-csv-parse) and [csv-sniffer](https://github.com/MonetDBSolutions/npm-csv-sniffer).
### Interface
The main interface is represented by a single function (see [index.js](index.js): `Parser`):
```js
static import (input: readable-stream.Readable, options: Object)
```
where the possible options are (see [index.js](index.js): `Parser constructor`):
```ts
relaxColumnCount: boolean, // Default: undefined (false)
skipLinesWithError: boolean, // Default: undefined (false)
delimiter: string, // Item delimiter, e.g. ',' or ' '. Default: automatically inferred
quotes: string, // Item quotation symbol, e.g. '\'' or '"'. Default: automatically inferred
newLine: string // A record separator, which is a newline character set, e.g., '\n' or '\n\r'. Default: automatically inferred
```
### Usage
The interface can be used as follows:
```js
const CsvValidatingParser = require('csv-validate"')
const { PassThrough } = require('readable-stream')
const input = new PassThrough()
input.write('key1,key2\n')
input.write('value1_1,value2_1\n')
input.write('value1_2,value2_2\n')
input.end()
CsvValidatingParser.import(input, { newLine: '\n' })
```
See [test/interface.test.js](test/interface.test.js) for more examples.