Code Monkey home page Code Monkey logo

csv-js's Introduction

csv-js

A Comma-Separated Values parser for JavaScript


Built to the rfc4180 standard, with adjustable strictness:

  • optional carriage returns for non-microsoft sources
  • automatically type-cast numeric an boolean values
  • An optional "relaxed" mode which:
  • ignores blank lines
  • ignores garbage following quoted tokens
  • does not enforce a consistent record length

Example:

Live Example

Install

npm install csv-js --save-dev

Use:

Simple:

    var rows = CSV.parse("one,two,three\n4,5,6")
    // rows equals [["one","two","three"],[4,5,6]]

jQuery AJAX suggestion:

$.get("csv.txt")
    .pipe( CSV.parse )
    .done( function(rows) {
       for( var i =0; i < rows.length; i++){
           console.log(rows[i])
       }
 });

Options:

CSV.RELAXED

Try this first if you're having problems with data parsing. Enables a "relaxed" strictness mode. Default: false

  • Ignores blank lines;
  • Ignores garbage characters following a close quote
  • Ignores inconsistent records lengths
  • Ignore whitespace around quoted strings.

CSV.IGNORE_RECORD_LENGTH

If relaxed mode is not already enabled, ignores inconsistent records lengths Default: false

CSV.IGNORE_QUOTES

Treats all values as literal, including surrounding quotes. For use if CSV isn't well formatted. This will disable escape sequences. Default: false

CSV.LINE_FEED_OK

Suppress exception for missing carriage returns (specification requires CRLF line endings). Default: true

CSV.CARRIAGE_RETURN_OK

Suppress exception for missing line feeds (specification requires CRLF line endings). Default: true

CSV.DETECT_TYPES

Automatically type-cast numeric and boolean values such as "false", "null", and "0.1", but not "abcd", "Null", or ".1". Customizable by overriding CSV.resolve_type(str) which returns value. Default: true

CSV.IGNORE_QUOTE_WHITESPACE

Detects and ignores whitespace before a quoted string which, per spec, should be treated as the start of an unescaped value. Default: true

CSV.DEBUG

Enables debug logging to console. Default: false

CSV.COLUMN_SEPARATOR

Split columns by this character. Default "," (comma).

Exceptions Thrown:

"UNEXPECTED_END_OF_FILE" or CSV.ERROR_EOF

Fired when file ends unexpectedly. Eg. File ends during an open escape sequence. Example:

Uncaught UNEXPECTED_END_OF_FILE at char 72 : ption,Price\n1997,Ford,E350,"ac, abs, moon,3000.00

"UNEXPECTED_CHARACTER" or CSV.ERROR_CHAR

Fired when an invalid character is detected. Eg. A non-comma after the close of an quoted value. Example:

Uncaught UNEXPECTED_CHARACTER at char 250 : rand Cherokee,"MUST SELL!\nair, moon roof, loaded"z

"UNEXPECTED_END_OF_RECORD" or CSV.ERROR_EOL

Fired when a record ends before the expected number of fields is read (as determined by first row). Example:

Uncaught UNEXPECTED_END_OF_RECORD at char 65 : ,Description,Price\n1997,Ford,E350,"ac, abs, moon"\n

Warnings:

"UNEXPECTED_WHITESPACE" or CSV.WARN_WHITESPACE

Appears when whitespace is encountered outside of a quoted value, only if CSV.IGNORE_QUOTE_WHITESPACE is disabled. Example:

UNEXPECTED_WHITESPACE at char 330 : e,false,123,45.6\n.7,8.,9.1.2,null,undefined\nNull, "

Unit Test:

Unit Test

License:

Licensed under the MIT license: http://www.opensource.org/licenses/mit-license.php

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.

Author:

Greg Kindel (twitter @gkindel), 2017

csv-js's People

Contributors

benediktseidl avatar bryant1410 avatar cygnyx avatar ismasan avatar jason-cooke avatar nleclerc avatar pchhetri avatar slyadams avatar squgeim avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

csv-js's Issues

Cannot import with webpack

When trying to use this library in a React project with Webpack, it fails to build and gives the following error:

229:20-27 Critical dependency: require function is used in a way in which dependencies cannot be statically extracted

The problem seems to be the way require is being used in CSV.stream and CSV.stream.json functions. For my use case, I only required the parse method so I have commented these parts of the code and everything works fine.

Repo description link incorrect

The repo description links to http://gkindel.github.io/cxv-js/csv.html when it should probably point to http://gkindel.github.io/csv-js/csv.html

commas in quoted strings being treated as separate field

Hi,

I'm having an issue with commas enclosed inside quotes. The string is separated at the commas and treated as separate fields. According to the spec this shouldn't happen.

Example:

"one", "number two", 3
"two one", "number, two two ", 2.3

Would fail because of the comma in the quoted string in the second line

Other delimiters

Thanks a lot for your parser. I took a look at the code and am under the impression that changing the delimiter takes more than changing this one setting. Is this correct? It would be nice to specify the delimiter, so we could also use this for tsv's

CR line separators not handled

When the CSV has lines that are separated by a single CR, it does not seem to handle them correctly. Instead of detecting it as the end of line, it keeps parsing the start of the next token on the next line as part of the last token on the previous line.

Absence of tags interferes with usage as bower dependency.

I'm using this lib as a bower dependency and commits pushed today have broken AMD support.
Problem is now i can't easily force a specific working version since the repo does not contain proper tags.

Please add tags and bump version number in bower.json accordingly.

Mind if I clean up and publish to npm?

I'd like to run this through a linter (fix == vs === ambiguities, missing semicolons, and a few other inconsistencies) and then publish it to npm.

Any objection?

Support for ; separation

Hi

Thanks for making csv-js

Nordic versions of ms excel and friends uses ; as separator because , is used for decimals rather than . as in us (which if you ask me as a programmer, is stupid) :)

What do you think of allowing customization of which separator to use?

Thanks

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.