https://github.com/sam-parsons/snowpack-plugin-dsv

converts .csv and .tsv files into javascript modules
https://github.com/sam-parsons/snowpack-plugin-dsv

csv snowpack-plugin tsv

Last synced: 21 days ago
JSON representation

converts .csv and .tsv files into javascript modules

• Host: GitHub
• URL: https://github.com/sam-parsons/snowpack-plugin-dsv
• Owner: sam-parsons
• License: mit
• Created: 2021-05-17T02:44:33.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2021-06-09T03:51:09.000Z (over 3 years ago)
• Last Synced: 2024-12-24T20:08:09.350Z (about 2 months ago)
• Topics: csv, snowpack-plugin, tsv
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/snowpack-plugin-dsv
• Size: 31.3 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
[npm]: https://img.shields.io/npm/v/snowpack-plugin-dsv

[npm-url]: https://www.npmjs.com/package/snowpack-plugin-dsv

[size]: https://packagephobia.now.sh/badge?p=snowpack-plugin-dsv

[size-url]: https://packagephobia.now.sh/result?p=snowpack-plugin-dsv

[![npm][npm]][npm-url]

[![size][size]][size-url]

[![libera manifesto](https://img.shields.io/badge/libera-manifesto-lightgrey.svg)](https://liberamanifesto.com)

# snowpack-plugin-dsv

Snowpack plugin that converts `.csv` and `.tsv` files into JavaScript modules with [d3-dsv](https://github.com/d3/d3-dsv).

## Requirements

This plugin requires an [LTS](https://github.com/nodejs/Release) Node version (v8.0.0+) and Snowpack v2.0.0+.

## Install

Using npm:

```console

npm install --save-dev snowpack-plugin-dsv

```

## Usage

Create a `snowpack.config.js` [configuration file](https://www.snowpack.dev/reference/configuration) and import the plugin to automatically detect and parse `.csv`, `.tsv`, and `.psv` files:

```js

const dsv = require('snowpack-plugin-dsv');

module.exports = {

  mount: {

    public: { url: '/', static: true },

    src: { url: '/dist' },

  },

  plugins: ['snowpack-plugin-dsv'],

};

```

For other types of delimiters, set the `delimiter` property of the options object to the appropriate character. Note: You will have to set the file extension of your custom files to `.dsv`.

```js

module.exports = {

  mount: { ... },

  plugins: [['snowpack-plugin-dsv', { delimiter: '~' }]],

};

```

If you would like to use multiple files with different delimiters, populate the `delimiters` array with the appropriate file extensions. Note: Make sure the second character of the custom file extension is the delimiter used in the data. Ex: If delimiting by `~`, the file extension should be `.~sv`.

```js

module.exports = {

  mount: { ... },

  plugins: [['snowpack-plugin-dsv', { delimiters: ['.~sv', '.%sv'] }]],

};

```

## Practical Example

Suppose that you have a CSV (or TSV!) file which contains some information on delicious fruits:

```csv

type,count

apples,7

pears,4

bananas,5

```

And suppose you'd like to import that CSV as an `Array` within some part of your code. After adding the plugin (as shown above), you may `import` (or `require`) the CSV file directly. The import will provide an `Array` of `Objects` representing rows from the CSV file:

```js

import fruit from './fruit.csv';

console.log(fruit);

// [

//   { type: 'apples', count: '7' },

//   { type: 'pears', count: '4' },

//   { type: 'bananas', count: '5' }

// ]

```

## Options

### `delimiter`

Type: `string`


Default: `null`

Indicates the delimiter that will be used by an internal `dsvParse` method from `d3-dsv`. This delimiter will be used for all files with a `.dsv` extension.

### `delimiters`

Type: `array`


Default: `null`

Declares multiple file extensions and delimiters to be used during build. The extension and delimiter are indicated by a custom file extension alone - a `.%sv` file will be automatically delimited with `%`.

### `processRow`

Type: `function`


Default: `null`

Specifies a function which processes and manipulates each row in the parsed array. The function can manipulate the passed `row`.

This option could be used for converting numeric `string` values into `number` values - see example below.

```js

dsv({

  processRows: (row, id) => {

    Object.keys(row).forEach((key, id) => {

      let value = row[key].trim();

      row[key] = isNaN(Number(value)) ? value : Number(value);

    });

  },

});

```

## Meta

[LICENSE (MIT)](./LICENSE.md)