History

Daniel Lockyer 9ec83a6e21 Disabled publishing for Members packages - we don't want to publish these anymore so this commit disables the ability to - also fixes up a missing version that wasn't reset		2022-07-21 09:26:04 +02:00
..
lib	Fixed members-csv not using renamed tiers field	2022-05-19 18:09:50 +02:00
test	Fixed CSV unparsing for subscribed flag	2022-01-11 16:26:11 +02:00
.eslintrc.js
index.js
LICENSE
package.json	Disabled publishing for Members packages	2022-07-21 09:26:04 +02:00
README.md

README.md

Members Csv

Install

npm install @tryghost/members-csv --save

yarn add @tryghost/members-csv

Usage

There are 2 parts to this package: CSV to JSON serialization and JSON to CSV serialization. The module exposes 2 methods to fullfil these: parse and unparse respectively.

To parse CSV file and convert it to JSON use parse method, e.g.:

const {parse} = require('@tryghost/members-csv');

const mapping = {
    email: 'csv_column_containing_email_data',
    name: 'csv_column_containing_names_data'
}
const membersJSON = await parse(csvFilePath, mapping);

csvFilePath - is a path to the CSV file that has to be processed mapping - optional parameter, it's a hash describing custom mapping for CSV columns to JSON properties

Example mapping for CSV having email under correo_electronico column would look like following:

{
    email: 'correo_electronico'
}

To unparse JSON to CSV compatible with members format use following:

const {unparse} = require('@tryghost/members-csv');

const members = [{
    email: 'email@example.com',
    name: 'Sam Memberino',
    note: 'Early supporter'
}];

const membersCSV = unparse(members);

console.log(membersCSV);
// -> "id,email,name,note,subscribed_to_emails,complimentary_plan,stripe_customer_id,created_at,deleted_at,labels\r\n,email@example.com,Sam Memberino,Early supporter,,,,,,"

Develop

This is a mono repository, managed with lerna.

Follow the instructions for the top-level repo.

git clone this repo & cd into it as usual
Run yarn to install top-level dependencies.

Run

yarn dev

Test

yarn lint run just eslint
yarn test run lint and tests