npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

gulp-shopify-theme

v1.1.3

Published

Gulp plugin for Shopify theme development

Downloads

55

Readme

npm

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 = require('gulp-shopify-theme').create();
var shopifyconfig = {
    "api_key": "8a1a2001d06ff…",
    "password": "51f8c8de49ee28…",
    "shared_secret": "51f8c8de49ee51…",
    "shop_name": "yourshopname…",
    "theme_id": "12345678…"
}

gulp.task( 'copy', ['shopify-theme-init'], function () {
    return gulp.src( [ 'src/{layout,config,snippets,templates,locales}/**/*.*' ] )
        .pipe( shopifytheme.stream() );
});

gulp.task( 'shopify-theme-init', function () {
    shopifytheme.init(shopifyconfig);
});

gulp.task( 'watch', function () {
	//
	// …watch and compile tasks…
	//

	shopifytheme.on('done', browserSync.reload());
});

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
    gulp.src( [ 'src/js/*.js' ] )
        .pipe( shopifytheme.stream( {theme_id: 12345} ) )
        .pipe( gulp.dest( 'dist' ) )

    batchMode will force stream() to return the Gulp stream immediately. In this mode you can subscribe to done and error to be notified when all tasks have ended.

    Passing theme_id is optional if you have already passed it to the instance's configuration on init(). However if used it will override the pre-exisiting theme_id. If no theme_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.

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.