gbd

grunt-bower-dependencies-to-rjs

auto configuration the dependencies from bower.json to target rjs file.

Showing:

Popularity

Downloads/wk

0

GitHub Stars

0

Maintenance

Last Commit

6yrs ago

Contributors

3

Package

Dependencies

7

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

grunt-bower-dependencies-to-rjs

Automagically wire-up installed Bower components dependencies as shim into your RequireJS config

Getting Started

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, install this plugin with this command:

npm install grunt-bower-dependencies-to-rjs --save-dev

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

grunt.loadNpmTasks('grunt-bower-dependencies-to-rjs');

Example usage

grunt.initConfig({
  bowerShimToRjs: {
    target: {
      rjsConfig: 'app/config.js'
    }
  }
});

grunt.loadNpmTasks('grunt-bower-dependencies-to-rjs');

grunt.registerTask('default', ['bowerShimToRjs']);

Documentation

When the bower task is run it merges the paths of installed Bower components into the paths property of your RequireJS config.

You trigger this task from another task in your Gruntfile or through the CLI: grunt bower

rjsConfig

Required
Type: String

Specify a relative path to your RequireJS config.

Make sure to specify the baseUrl property in your RequireJS config if you want to use relative paths.

Options

exclude

Default: []
Type: Array

Specify components to be excluded from being added to the RequireJS config.

bowerShimToRjs: {
  all: {
    rjsConfig: 'scripts/main.js',
    options: {
      exclude: ['moment']
    }
  }
}

application.name

Default: name of application that initial in bower.json
Type: String

Specify compress application filename it being added to the RequireJS shim config

bowerShimToRjs: {
  all: {
    rjsConfig: 'scripts/main.js',
    options: {
      application: {
        name: 'yourCompressApplicationFileName'
      }
    }
  }
}

application.exclude

Default: [] Type: Array

Specify components of main application to be excluded from being added to the RequireJS config.

bowerShimToRjs: {
  all: {
    rjsConfig: 'scripts/main.js',
    options: {
      application: {
        exclude: ['dependecy1', 'dependency2']
      }
    }
  }
}

application.overwrite

Default: [] Type: Array

Specify components of main application to be over write name from being added to the RequireJS config.

bowerShimToRjs: {
  all: {
    rjsConfig: 'scripts/main.js',
    options: {
      application: {
        overwrite: {
            'tobeoverwrotenmodulename': 'ToBeOverWriteModuleName'
        }
      }
    }
  }
}

Things to remember

Config file

If you do not already have a config.js file at the location specified by the --config option then one will be generated for you. A basic config.js file looks like this:

requirejs.config({
  shim: {},
  paths: {}
});

Credit

Thanks for grunt-bower-requirejs's contributor(https://github.com/yeoman/grunt-bower-requirejs). I use theire module for my reference.

License

MIT license and copyright Bhakarut

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial