ya-csv - GitLite

KO | EN

gitlite — search

#python #hacktoberfest #android #machine-learning #rust #linux #macos #windows #awesome #kubernetes #security #mcp #ios #openai

ya-csv

(★ 242)

CSV parser/writer for Node.js

파일 탐색기

최종 버전 다운로드 (.zip)

- - benchmark.yml
  - test.yml
- - .gitignore
- compare.js
- correctness-check.js
- generate-all-fixtures.js
- generate-fixture.js
- run.js
- reshuffle.js
- ya-csv.js
- chunk-size-sweep.js
- columns-from-header.js
- echo.js
- empty-quote.js
- escape-chunk-boundary.js
- index.js
- parse-edge-cases.js
- parser.js
- pause.js
- perl-csv-test.pl
- run.js
- stream.js
- test.csv
- writer.js
CHANGELOG.md
LICENSE
package.json
README.md
TODO.md

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/koles/ya-csv

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd ya-csv

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Node.js

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다. LTS(장기지원) 버전을 추천합니다.

npm install ya-csv

package.json에 명시된 라이브러리들을 내려받아 설치합니다.

npm run bench # benchmark the working tree

이 명령어를 터미널에 그대로 입력해 실행하세요.

npm run bench:compare # benchmark the working tree against a base commit (default: HEAD)

이 명령어를 터미널에 그대로 입력해 실행하세요.

✅ 명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# ya-csv

Event based CSV parser and writer for Node.js suitable for processing large CSV streams.

* Designed for high performance and ease of use.
  * RFC 4180 compliance with optional extensions.
  * Zero dependencies.

## Example
```js
// A simple echo program:
var csv = require('ya-csv');

var reader = csv.createCsvStreamReader(process.openStdin());
var writer = csv.createCsvStreamWriter(process.stdout);

reader.addListener('data', function(data) {
    writer.writeRecord(data);
});

reader.addListener('error', function(e) {
    console.error('Oops!');
});
```

## Installation
```bash
npm install ya-csv
```

Current version requires at least Node.js v0.2.3 and it's tested with Node.js v0.4.12, 0.6.11, 0.7.5 and v0.10.24. Hope it works with the other versions in between too.

## Features

- event based, suitable for processing big CSV streams
 - configurable separator, quote and escape characters (comma, double-quote and double-quote by default)
 - ignores lines starting with configurable comment character (off by default)
 - supports memory-only streaming

## More examples

Echo first column of the `data.csv` file:
```js
// equivalent of csv.createCsvFileReader('data.csv') 
var reader = csv.createCsvFileReader('data.csv', {
    'separator': ',',
    'quote': '"',
    'escape': '"',       
    'comment': '',
});
var writer = new csv.CsvWriter(process.stdout);
reader.addListener('data', function(data) {
    writer.writeRecord([ data[0] ]);
});
```

Return data in objects rather than arrays: either by grabbing the column names from the header row (first row is not passed to the `data` listener):
```js
var reader = csv.createCsvFileReader('data.csv', { columnsFromHeader: true });
reader.addListener('data', function(data) {
    // supposing there are so named columns in the source file
    sys.puts(data.col1 + " ... " + data.col2);
});
```

... or by providing column names from the client code (first row is passed to the `data` listener in this case):
```js
var reader = csv.createCsvFileReader('data.csv');
reader.setColumnNames([ 'col1', 'col2' ]);
reader.addListener('data', function(data) {
    sys.puts(data.col1 + " ... " + data.col2);
});
```

Note `reader.setColumnNames()` resets the column names so next invocation of the `data` listener will again receive the data in an array rather than an object.

Convert the `/etc/passwd` file to comma separated format, drop commented lines and dump the results to the standard output:
```js
var reader = csv.createCsvFileReader('/etc/passwd', {
    'separator': ':',
    'quote': '"',
    'escape': '"',
    'comment': '#',
});
var writer = new csv.CsvWriter(process.stdout);
reader.addListener('data', function(data) {
    writer.writeRecord(data);
});
```

Parsing an upload as the data comes in, using node-formidable:
```js
upload_form.onPart = function(part) {
    if (!part.filename) { upload_form.handlePart(part); return }

var reader = csv.createCsvFileReader({'comment': '#'});
    reader.addListener('data', function(data) {
        saveRecord(data);
    });

part.on('data', function(buffer) {
        // Pipe incoming data into the reader.
        reader.parse(buffer);
    });
    part.on('end', function() {
        reader.end()
    })
}
```

## CsvReader Options

Note: the defaults are based on the values from RFC 4180 -
https://tools.ietf.org/html/rfc4180

* `separator` - field separator (delimiter), default: ',' (comma)
  * `quote` - the character used to enclose fields with white space
    characters, escaping etc., default: '"' (double quote)
  * `escape` - character used to escape the `quote` inside a
    field, default: '"' (double quote). If you are changing `quotechar`
    you may want to change the `escape` to the same value
  * `comment` - parser will ignore this character and all following
    characters on the same line
    the line, default: none
  * `columnNames` - an array of column names, if used, the rows sent to
    the `data` listener are represented as hashes instead of arrays,
    default: none
  * `columnsFromHeader` - boolean value indicating whether the first row
    should be interpreted as a list of header names. If used, the rows
    sent to the `data` listener are represented as hashes instead of arrays,
    default: `false`
  * `nestedQuotes` - boolean value indicating whether the parser should
    try to process a file with unescaped quote characters inside fields,
    default: `false`
  * `flags` - a string with flags to be passed through to
    createRead/WriteStream (only supported via `createCsvFileReader`
    and `createCsvFileWriter` methods), default: none

## CSvWriter Options

* `separator` - field separator (delimiter), default: ',' (comma)
  * `quote` - the character used to enclose fields with white space
    characters, escaping etc., default: '"' (double quote)
  * `escape` - character used to escape the `quote` inside a
    field, default: '"' (double quote). If you are changing `quotechar`
    you may want to change the `escape` to the same value
  * `escapeFormulas` - boolean value indicating whether the parser should
    escape '=', '+' and '-' with an apostrophe to prevent some programs
    from treating the content as an executable formula, default: `false`

## Benchmarking

`bench/` contains a small throughput benchmark and a comparison tool with
zero extra dependencies:

```bash
npm run bench            # benchmark the working tree
npm run bench:compare    # benchmark the working tree against a base commit (default: HEAD)
node bench/compare.js --base=v1.0.0 --threshold=15
```

`bench:compare` checks out the base commit into a throwaway git worktree,
runs the same benchmark against both trees, and reports the change per
fixture (exiting non-zero if any fixture regresses past `--threshold`
percent). A GitHub Actions workflow runs it on every PR touching `lib/` or
`bench/`.