grunt-cms-site-scaffold

A grunt plugin for scaffolding cms sites.

npm install grunt-cms-site-scaffold
4 downloads in the last week
8 downloads in the last month

grunt-cms-site-scaffold

A grunt plugin for scaffolding cms sites.

NOTE

When using this to upload files, you must use the command-line to enter the --email=youremail.banno.com --password=yourldappassword command line arguments. Do not include them in GRUNTFILES!!! Remember, this is your password, and uploads are logged against your account. You are responsible for using them correctly.

Getting Started

This plugin requires Grunt ~0.4.1

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-cms-site-scaffold --save-dev

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

grunt.loadNpmTasks('grunt-cms-site-scaffold');

The "cms_site_scaffold" task

Overview

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

grunt.initConfig({
  email: grunt.option('email'),
  password: grunt.option('password'),
  cms_site_scaffold: {
    options: {
      // Task-specific options go here.
    },
    your_target: {
      // Target-specific file lists and/or options go here.
    },
  },
})

Options

url

Type: url Default value: 'http://artemis.local:9000'

Where to scaffold to.

options.punctuation

Type: Boolean Default value: false

Whether or not to ignore missing files in the files object.

Usage Examples

Default Options

This example uploads the artemis scaffold to locahost:9000.

grunt.initConfig({
  email: grunt.option('email'),
  password: grunt.option('password'),
  cms_site_scaffold: {
    options: {
      url: 'http://localhost:9000'
    },
    src: ['artemis.local.json']
  },
})

Custom Options

This example uploads the artemis scaffold to staging.artemis.com. It ignores the missing appolo.json file.

grunt.initConfig({
  email: grunt.option('email'),
  password: grunt.option('password'),
  cms_site_scaffold: {
    options: {
      url: 'http://staging.artemis.com',
      ignoreMissing: true
    },
    files: [
      {src:['artemis.local.json']},
      {src:['apollo.json']}
    ],
  },
})

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.

Release History

(Nothing yet)

npm loves you