0.4.2 • Published 8 years ago
sv v0.4.2
sv
For all your separated value needs.
sv.Stringifier
is a Readable stream.sv.Parser
is a Writable stream.
Install
npm install sv
The optimist
dependency is only required for command line use.
API usage
All tabular data must / will have column names on the first row.
Parsing
sprints.csv:
index name time
1 chris 1:18
2 daniel 1:17
3 lewis 1:30
4 stephen 1:16
5 larry 1:32
And in node:
var sv = require('sv');
var parser = new sv.Parser();
parser.on('data', function(obj) {
console.log('sprinter ->', obj);
});
var fs = require('fs');
var sprints = fs.createReadStream('sprints.csv', {encoding: 'utf8'});
sprints.pipe(parser);
Stringifying
var expenses = [
{name: 'Tip' },
{name: 'Lunch', amount: 5.90},
{name: 'Latte', amount: 3.15},
{name: 'Paper', amount: 2.10},
{name: 'Pens' , amount: 4.59},
{ amount: 9.16}
];
var sv = require('sv');
var stringifier = new sv.Stringifier({peek: 2, missing: 'n/a'});
stringifier.pipe(process.stdout);
expenses.forEach(function(expense) {
stringifier.write(expense);
});
// if you write set 'peek' to more rows than you have in your data,
// you'll need to call stringifier end so that they get flushed.
stringifier.end();
- N.b.: If you pipe a buffer or (i.e., with a stringifier) into a parser, the parser will not receive any encoding. You must set the encoding on the parser in those cases.
Stringifier features:
- Infer column names from a list of objects.
- Convert from objects to csv / tsv plaintext.
- Also allows writing arrays / strings directly.
- Write header automatically.
Parser features:
- Infer delimiter from input.
- Infer column names from first line of input.
- Handle universal newlines (
\r
,\r\n
, or\n
).
CLI usage
shopt -s globstar
for csv in ~/corpora/testsheets/**/*.csv; do
echo
file "$csv"
echo "Tunneling through multiple 'sv' calls should be transparent."
cat "$csv" | sv -j | wc -l
cat "$csv" | sv | sv -j | wc -l
done
TODO
- Decide how to encode a field like {id: 1, name: '"chris'},
when the delimiter is
,
and quotechar is"
.- This is weird because it doesn't need quoting, but without, the
quotechar marker will trigger an
inside
state, but there's no end quote.)
- This is weird because it doesn't need quoting, but without, the
quotechar marker will trigger an
Development notes
Characters codes
Line separators:
\n
= 10 (newline)\r
= 13 (return)
Field separators:
\t
= 9 (tab)= 32 (space)
,
= 44 (comma);
= 59 (semicolon)
Field quotations:
"
= 34 (double quote)'
= 39 (single quote)- ` = 96 (backtick)
Escapes:
\
= 92 (backslash)
Debugging helper:
function logEvents(emitter, prefix, names) {
names.forEach(function(name) {
emitter.on(name, function(/*...*/) {
console.error(prefix + ':' + name, arguments);
});
});
}
License
Copyright 2013-2016 Christopher Brown. MIT Licensed.
0.4.2
8 years ago
0.4.1
8 years ago
0.4.0
8 years ago
0.3.10
8 years ago
0.3.9
8 years ago
0.3.8
8 years ago
0.3.7
9 years ago
0.3.6
10 years ago
0.3.5
10 years ago
0.3.4
10 years ago
0.3.3
11 years ago
0.3.2
11 years ago
0.3.1
11 years ago
0.3.0
11 years ago
0.2.7
11 years ago
0.2.6
11 years ago
0.2.5
11 years ago
0.2.4
11 years ago
0.2.3
11 years ago
0.2.2
11 years ago
0.2.0
11 years ago
0.1.2
11 years ago
0.1.1
11 years ago