grunt-sendwithus

Grunt plugin to upload templates to Sendwithus form within your tasks

Showing:

Popularity

Downloads/wk

2

GitHub Stars

7

Maintenance

Last Commit

4yrs ago

Contributors

3

Package

Dependencies

5

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

experimental

Caveat Emptor

This is an experimental plugin and is not yet fully supported by the Sendwithus team.

grunt-sendwithus

Grunt plugin to deploy your local HTML email templates to sendwithus

Getting Started

This plugin requires Grunt.

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-sendwithus --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-sendwithus');

This plugin was designed to work with Grunt 0.4.x. If you're still using grunt v0.3.x it's strongly recommended that you upgrade.

The "sendwithus" task

Overview

In your project's Gruntfile, add a section named sendwithus to the data object passed into grunt.initConfig().

grunt.initConfig({
  sendwithus: {
    default: {
      options: {}, // Task-specific options go here
      src: [] // Target-specific file list goes here
    }
  }
})

Options

options.apiKey

Type: String Default value: null

The API key from your sendwithus account. Note: it's recommended that you don't hard-code this api into the gruntfile, but rather require it from an external source like a config file or something.

Usage Examples

Default Options

grunt.initConfig({
  sendwithus: {
    default: {
      options: {
        apiKey: 'xxxxxxxxxx'  
      },
      src: ['src/testing.html', 'src/**/*.html']
    }
  }
})

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Testing

In order to run this plugin, you need to create a swu.json file in the root directory above where this project exists and populate it with

{
  "apiKey": "YOUR SENDWITHUS PRODUCTION API KEY"
}

Release History

0.0.3 - Fix an issue where templates might silently fail when uploading
0.0.2 - Fix the README, and fix named tasks
0.0.1 - Initial release

License

Copyright (c) 2015 sendwithus. Licensed under the MIT license.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100