Use StealJS to build your projects with Grunt.
Switch branches/tags
Clone or download
Pull request Compare This branch is 34 commits ahead, 1 commit behind alexisabril:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
docs
tasks
test
.editorconfig
.gitignore
.npmignore
.travis.yml
Gruntfile.js
LICENSE.md
README.md
package.json

README.md

grunt-steal

Build Status

Grunt tasks for StealJS.

Install

npm install grunt-steal --save-dev

API

{Object}

grunt-steal is a collection of Grunt tasks for building out projects that use StealJS.

Object

  • build {steal-build}:

    A task for building an application for production. Equivalent to using [steal-tools.build].

  • export {steal-export}:

    A task for exporting a project to another module format, for sharing with others who will use your project outside of StealJS.

  • live-reload {steal-live-reload}:

    A task for starting a [live-reload] server.

steal-build {Object}

The steal-build options object's values.

Object

  • steal {Object}: Specifies the config argument in [steal-tools.build]. The [config.main main] option must be specified. Typically, [config.configPath configPath] is also specified, as that is used to set [config.baseURL baseURL]. Any Steal [config.config configuration] can be specified; however, most other build configuration values are specified by [config.buildConfig], in the config file.

  • buildOptions {Object}: Specifies the options argument to [steal-tools.build stealTools.build].

steal-export {Object}

A Grunt multi task that loads modules, and writes them out in different formats.

Object

  • tasks {Object<String,steal-tools.export.object>}: An object with task names as keys, and exportObjects as values.

    grunt.initConfig({
      "steal-export": {
        taskName1: { ExportObject1 },
        taskName2: { ExportObject2 }
      }
    });
    

    Each [steal-tools.export.object] specifies:

    • A steal object that specifies the modules to be loaded.
    • An options object that specifies any special loading behavior, like turning logging.
    • An outputs object that specifies how the modules should be written out.
    grunt.initConfig({
      "steal-export": {
        taskName: {
          steal : { .. },
          options: { .. },
          outputs: { .. }
        }
      }
    });
    

steal-live-reload {Object}

The steal-live-reload options object's values.

Object

  • steal {Object}: Specifies the config argument in [steal-tools.build]. The [config.main main] option must be specified. Typically, [config.configPath configPath] is also specified, as that is used to set [config.baseURL baseURL]. Any Steal [config.config configuration] can be specified; however, most other build configuration values are specified by [config.buildConfig], in the config file.

  • liveReloadOptions {Object}: Specifies the options argument to [steal-tools.cmd.live-reload steal-tools live-reload].

License

MIT