Gulp Shopify Theme
Gulp.js plugin for Shopify theme development.
Highlights:
- Asynchronous theme assets uploads.
- Retry on error.
- Bulk theme files deletion.
- Multiple instance support.
Install
$ npm install --save-dev gulp-shopify-theme
Features
- Queue Shopify API calls respecting the 40-call/burst / 2 call/sec limits
- Support idiomatic Gulp.js workflow:
.pipe(shopifytheme.stream( options ))
- Support purging all theme files on Shopify (for cleanup and reupload)
- Multiple instance support. Sync multiple themes via a single
gulpfile.js
- Uses the excellent Microapps'
shopify-api-node
as the API wrapper
Usage
A working example can be found here: gist.github.com/tmslnz/1d025baaa…
var shopifytheme = ;var shopifyconfig = "api_key": "8a1a2001d06ff…" "password": "51f8c8de49ee28…" "shared_secret": "51f8c8de49ee51…" "shop_name": "yourshopname…" "theme_id": "12345678…" gulp; gulp; gulp;
Methods
-
shopifytheme.create( options )
Returns a new instance. The instance will do nothing until
.init( options )
is called on it. -
shopifytheme.init( options )
Initialises an instance with
options
. The plugin will wait for, and queue, new files as they come through. -
shopifytheme.stream( options )
Use this to stream any theme file to the plugin.
Options are:
- batchMode
- theme_id
gulpbatchMode
will forcestream()
to return the Gulp stream immediately. In this mode you can subscribe todone
anderror
to be notified when all tasks have ended.Passing
theme_id
is optional if you have already passed it to the instance's configuration oninit()
. However if used it will override the pre-exisitingtheme_id
. If notheme_id
is present an error is thrown. -
shopifytheme.purge()
This will delete all theme files from Shopify. Equivalent to going to the Shopify Admin and deleting each file by hand (eww!). Use with caution, of course.
.purge()
honours a blacklist of _un_deletable files (e.g.layout/theme.liquid
)
Options
For now it's just API configuration.
- apiKey
- password
- shopName
- themeId
- autoLimit (see
shopify-api-node
) - timeout
Events
The plugin instance emits two events done
and error
at the end of a sync task queue.
On done
the event handler receives the list of files that have successfully synced.
On error
the handler is passed whatever error was thrown in the process.