mirror of https://github.com/TryGhost/Ghost.git synced 2024-12-24 19:33:02 +03:00

History

Fabien O'Carroll 4d8c2ebb1f Supported products column for `parse` & `unparse` refs https://github.com/TryGhost/Team/issues/765 Support for multiple products means we can no longer map a members state to a csv row using just the `complimentary_plan` option. Instead we must include the product(s) that a member has. This ensures that we can read and write this data from/to csv files.		2021-06-23 10:14:30 +01:00
..
lib	Supported products column for `parse` & `unparse`	2021-06-23 10:14:30 +01:00
test	Supported products column for `parse` & `unparse`	2021-06-23 10:14:30 +01:00
.eslintrc.js	Initialized members-csv package	2020-06-19 18:54:48 +12:00
index.js	Fixed module paths	2020-06-19 19:52:21 +12:00
LICENSE	2021	2021-01-25 16:34:32 +00:00
package.json	Published new versions	2021-06-02 09:57:04 +01:00
README.md	2021	2021-01-25 16:34:32 +00:00

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