Security News
CISA Brings KEV Data to GitHub
CISA's KEV data is now on GitHub, offering easier access, API integration, commit history tracking, and automated updates for security teams and researchers.
Check CSV files against a set of validation rules.
npm install --global csval
Run csval
and give a CSV file as the first argument
csval mydata.csv
Since no rules were specified above, the file is only checked to make sure it can be parsed correctly. As long as it's a valid CSV file, it will pass validation. The CLI will show errors if they exist. Otherwise, it will display a success message.
Pass in a rules file to validate against the rules
csval mydata.csv myrules.json
Again, the CLI will show parsing errors if they exist. When a rules file is specified as it is above, the CLI will also display any validation errors. Otherwise, it will display a success message.
Rules files should follow the JSON Schema format. It describes what you should expect in each row. Here's an example.
{
"type": "object",
"properties": {
"salary": {
"type": "number"
}
}
}
Note: The "type": "object"
line above is implied and can be left out if
desired.
The rules above say that the "salary" field on each row must be a number. This CSV file would pass.
name,salary
John,100000
Jane,150000
The CSV file meets all validation checks.
This CSV file would fail.
name,salary
John,100000
Jane,idk
Row 3: 'salary' must be number
Here's another example rules file.
{
"properties": {
"age": {
"type": "number",
"minimum": 0
}
}
}
This CSV file would pass.
name,age
John,30
Jane,50
But this one would fail.
name,age
John,30
Jane,-10
You can require certain fields, as well. Consider this rules file.
{
"properties": {
"age": {
"type": "number"
}
},
"required": ["age"]
}
This CSV file would pass.
name,age,salary
John,30,100000
Jane,50,150000
This one would fail.
name,salary
John,100000
Jane,150000
There are many other possible rules. See the JSON Schema for more information.
Install the library
npm install csval
Use it in your project like so
import { parseCsv, validate } from "csval";
const main = async () => {
const csvString= "name,age\nJohn,30";
const rules = {
properties: {
name: {
type: "string"
}
}
};
const parsed = await parseCsv(csvString);
const valid = await validate(parsed, rules);
// validate will either throw an error or valid will be true
};
main();
You can also read CSV data and rules from files.
import { readCsv, readRules, parseCsv, validate } from "csval";
const csvString = await readCsv("path/to/file.csv");
const rules = await readRules("path/to/rules.json");
const parsed = await parseCsv(csvString);
const valid = await validate(parsed, rules);
// validate will either throw an error or valid will be true
Clone the repository
git clone https://github.com/travishorn/csval.git
Change into the directory
cd csval
Install dependencies
npm install
Run tests via Mocha
npm run test
Lint all JavaScript files via ESLint and Prettier
npm run lint
Automatically fix linting problems if possible
npm run lint:fix
The MIT License
Copyright 2023 Travis Horn
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
FAQs
Check CSV files against a set of validation rules.
The npm package csval receives a total of 93 weekly downloads. As such, csval popularity was classified as not popular.
We found that csval demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
CISA's KEV data is now on GitHub, offering easier access, API integration, commit history tracking, and automated updates for security teams and researchers.
Security News
Opengrep forks Semgrep to preserve open source SAST in response to controversial licensing changes.
Security News
Critics call the Node.js EOL CVE a misuse of the system, sparking debate over CVE standards and the growing noise in vulnerability databases.