@getable/json-image-to-cloudinary

json-image-to-cloudinary

Takes a json array and field names. Replaces the value of those field names with a cloudinary url.

Table of Contents generated with DocToc

• Install
• Usage
  • CLI
  • Programmatic
• Options
  • -h, --help
  • -f, --field | field <String> Required
  • --overwrite | overwriteImages <Boolean>
  • -i, --id | id <String>
  • -w, --widths | widths <Array>
  • --widths-key | widthsKey <String>
  • --width-names | widthNames <Object>
• Tests
• Developing
  • Requirements
• License

Install

npm i -S @getable/json-image-to-cloudinary

Usage

CLI

CLOUDINARY_URL=cloudinary://<your url here> && json-image-to-cloudinary data.json -f image

Programmatic

import  from '@getable/json-image-to-cloudinary'

jsonImageToCloudinary(docs, options, callback)

Options

-h, --help

show help

-f, --field | field <String> Required

Field to replace with a cloudinary url

--overwrite | overwriteImages <Boolean>

Overwrite data on cloudinary, use this if your urls changed and you're running the script for a second time

-i, --id | id <String>

Generate a cloudinary id from this string. Access keys in the object with ${}. e.g. --id="${category}/${id}"'

-w, --widths | widths <Array>

CLI: A comma separated list of widths to eagerly compute. Programmatic: An array of integers.

--widths-key | widthsKey <String>

Defaults to field + "s", but you can override here

--width-names | widthNames <Object>

CLI: Name a width for output as an object with width urls e.g. --field=image --widths=50,100 --width-names='small:50,large:100}'

Programmatic: An object of width names that map to widths e.g. `{widths: [50, 100], widthNames: {small: 50, large: 100}}

outputs:

{
  "image": "https://cloudinaryurl",
  "images": {
    "small": "https://cloudinaryurl-at-50",
    "large": "https://cloudinaryurl-at-100"
  }
}

Tests

Tests are in tape.

• npm test will run the tests
• npm run tdd will run the tests on every file change.

Developing

To publish, run npm run release -- [{patch,minor,major}]

NOTE: you might need to sudo ln -s /usr/local/bin/node /usr/bin/node to ensure node is in your path for the git hooks to work

Requirements

• npm > 2.0.0 So that passing args to a npm script will work. npm i -g npm
• git > 1.8.3 So that git push --follow-tags will work. brew install git

License

Artistic 2.0 © Joey Baker