grunt-titaniumifier

grunt-titaniumifier

Get a Titanium CommonJS Module out of your Node.js package with Titaniumifier using Grunt!

Read the documentation of titaniumifier to understand what you can do with it.

Getting Started

This plugin requires Grunt ~0.4.2

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-titaniumifier --save-dev

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

grunt.loadNpmTasks('grunt-titaniumifier');

The "titaniumifier" task

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

grunt.initConfig({
  titaniumifier: {
    "module": {
      options: {
        // You can create a CommonJS module **without** the
        // dependencies bundled
        bare: false,
        // Specifying bundle:true you will have a bundled JS file alongside the
        // zipfile, so you can distribute it as a single file
        bundle: false,
        // If you don’t even need the zipfile (why??!) you can exclude it from
        // the building process
        module: true
      }
    }
  },
});

Most of the configuration must happen on the package.json file, please see the documentation of titaniumifier to see what you can do.

Credits

Humbly made by the spry ladies and gents at SMC.

License

This library, grunt-titaniumifier, is free software ("Licensed Software"); you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; including but not limited to, the implied warranty of MERCHANTABILITY, NONINFRINGEMENT, or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA