grunt-simple-commonjs

A Simple tool that wrap a CommonJS Project into a single file for client side usage

npm install grunt-simple-commonjs
22 downloads in the last week
33 downloads in the last month

grunt-simple-commonjs

A Simple tool that wrapper a CommonJS Project into a single file for client side usage

Note

This is just a simple CommonJS wrapper

Currently we support these CommonJS specifications:

  1. you can use require() to import a .js file or .json file. Dependency Cycle is allowed.
  2. you can use exports variable to set the out interface of the module.
  3. you can use module variable to handle the module. module.exports is equal to exports, and module.id is the identifier of the module wich you can import with require(id).

Note that, because this is 'simple', module.id is not readonly(in specification this should be readonly). And if you change module.id, there will be no effection on true id of the module.

This plugin is still under development, for issues please contact me on github

And I'm a freshman in fudan university, this is my first plugin for Grunt, thx for supporting me :)

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-simple-commonjs --save-dev

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

grunt.loadNpmTasks('grunt-simple-commonjs');

The "simple-commonjs" task

Overview

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

grunt.initConfig({
  'simple-commonjs': {
    options: {
        main: 'src/index.js'
    },
    all: {
        files: {
            'dist/index.js': ['src/**/*.js', 'src/**/*.json']
        }
    },
  },
});

Options

options.main

Type: String Default value: null

The entry of your programm

Note that this option is required

Usage Examples

The test show a simple Example

You can use make example to see it

If you don't get full code, you can't get it on my github

And if you don't want to get it, the gruntfile of test should be the example shows above, just replace 'src' with 'test'

Build from code

Just run:

$ make

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.

npm loves you