https://github.com/daviaquino87/validator-csv

The "Validator CSV" package is a powerful and easy-to-use tool for checking the integrity and quality of CSV files. With it, you can ensure that your CSV files are well formatted, meet header specifications, and meet your application's specific requirements.
https://github.com/daviaquino87/validator-csv

csv csv-files javascript js nodejs npm-package

Last synced: 2 months ago
JSON representation

The "Validator CSV" package is a powerful and easy-to-use tool for checking the integrity and quality of CSV files. With it, you can ensure that your CSV files are well formatted, meet header specifications, and meet your application's specific requirements.

• Host: GitHub
• URL: https://github.com/daviaquino87/validator-csv
• Owner: daviaquino87
• License: mit
• Created: 2023-10-02T20:08:26.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-10-24T13:32:35.000Z (about 1 year ago)
• Last Synced: 2023-12-24T20:09:30.223Z (about 1 year ago)
• Topics: csv, csv-files, javascript, js, nodejs, npm-package
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/validator-csv
• Size: 45.9 KB
• Stars: 5
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# validator-csv

[![npm version][npm-version-image]][npm-package-uri]

[![License][license-image]][license-uri]

[![NPM Downloads][npm-downloads-image]][npm-downloads-url]

[![GitHub Issues][github-issues-image]][github-issues-uri]

The "Validator CSV" package is a powerful and easy-to-use tool for checking the integrity and quality of CSV files. With it, you can ensure that your CSV files are well formatted, meet header specifications, and meet your application's specific requirements.

## Installation

You can install this package via npm. Make sure you have Node.js installed.

```bash

npm i validator-csv

```

## Usage

To use validator-csv follow the examples:










Validating CSV through file path

```js

const path = require("node:path");

const validator = require('validator-csv');

const Yup = require("yup");

const filePath = path.resolve(__dirname, "uploads", "clientes.csv");

const validationSchema = Yup.object().shape({

  age: Yup.number().min(18, "Invalid age, the customer must be over 18 years old.").required("The field age is required."),

});

validator.validateCSV({

  filePath,

  headers: ["name", "age", "gender"],

  schema: validationSchema,

}).then((data) => {

  console.log(data);

}).catch((error) => {

  console.error("Error:", error);

});

/*

data:{

  headers: ["name","age","gender","erros"],

  rows: [

    ["John Smith",18,"male",[]],

  ]

}

*/

```







Validating CSV through buffer

```js

const fs = require("node:fs");

const path = require("node:path");

const validator = require('validator-csv');

const Yup = require("yup");

const filePath = path.join(__dirname, "uploads", "clientes.csv");

const csvBuffer = fs.readFileSync(filePath);

const validationSchema = Yup.object().shape({

  age: Yup.number().min(18, "Invalid age, the customer must be over 18 years old.").required("The field age is required."),

});

validator

  .validateCSVFromBuffer({

    buffer: csvBuffer,

    headers: ["name", "age", "gender"],

    schema: validationSchema,

  })

  .then((data) => {

    console.log(data);

  })

  .catch((error) => {

    console.error("Error:", error);

  });

/*

data:{

  headers: ["name","age","gender","erros"],

  rows: [

    ["John Smith",18,"male",[]],

  ]

}

*/

```

### info:

By default, the separator parameter is set to a comma (","), but this setting can be modified by the user as needed.

Important Note About the Escape Character

When the text is encapsulated in double quotes ("), the separator will not impact the lines, thus ensuring the integrity of the data contained in the quotes.

ex: 

```js

validator.validateCSV({

  filePath: filePath,

  headers: ["name", "age", "gender"],

  separator: ";",

  schema: validationSchema,

}).then((data) => {

  console.log(data);

});

```

## Validation functions

Example of custom function with yup

```js

const validationSchema = Yup.object().shape({

  age: Yup.number().test("validate-age","Invalid age, the customer must be over 18 years old.",(element) => {

    element >= 18

  })

});

```

## Examples

To view the examples, clone the Express repo and install the dependencies:

```sh

$ git clone --branch examples https://github.com/daviaquino87/validator-csv 

$ cd validator-csv

$ npm install

$ npm run start

```

# People

The original author of validator-csv is [Davi Aquino](https://github.com/daviaquino87).

## Licença

[MIT](LICENSE.md).

[npm-downloads-image]: https://badgen.net/npm/dm/express

[npm-downloads-url]: https://npmcharts.com/compare/validator-csv?minimal=true

[npm-version-image]: https://img.shields.io/npm/v/validator-csv

[npm-package-uri]: https://www.npmjs.com/package/validator-csv

[license-image]: https://img.shields.io/npm/l/validator-csv

[license-uri]: https://github.com/daviaquino87/seu-pacote/blob/main/LICENSE

[github-issues-image]: https://img.shields.io/github/issues/daviaquino87/validator-csv

[github-issues-uri]: https://github.com/daviaquino87/validator-csv/issues