soy-to-require

    1.0.0 • Public • Published

    soy-to-require NPM version Build Status Dependency Status

    Wrap your closure templates in a require js define block

    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 soy-to-require --save-dev

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

    grunt.loadNpmTasks('soy-to-require');

    The "soy_to_require" task

    Overview

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

    grunt.initConfig({
      soy_to_require: {
        options: {
          // Task-specific options go here.
        },
        files: {
            'nameOfFileCollection': ['files.soy.js']
        }
      }
    })

    Options

    options.namespace

    Type: String

    Default value: null

    The Soy namespace.

    options.output

    Type: String

    Optional: true

    Default value: {input_file_path}

    Allows you to override the output directory,

    options.prefix

    Type: String

    Default value: ""

    The prefix used for resolving other Soy modules. This gets appended to options.output to form the location of the AMD module.

    Usage Examples

    In this example, the default options are used to do something with whatever. So if the testing file has the content Testing and the 123 file had the content 1 2 3, the generated result would be Testing, 1 2 3.

    grunt.initConfig({
      soy_to_require: {
          TestTask: {
            options: {
                namespace: 'Testing',
                prefix: 'templates/',
                output: 'dist/js'
            },
            files: {
              'test/fixtures': ['templates/MyView.soy.js', 'test/fixtures/MyView.soy.js']
            }
          }
      },
    })

    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)

    License

    Copyright (c) 2014 charliedowler. Licensed under the MIT license.

    Install

    npm i soy-to-require

    DownloadsWeekly Downloads

    1

    Version

    1.0.0

    License

    MIT

    Last publish

    Collaborators

    • charliedowler