grunt-bower-update-main

    0.2.0 • Public • Published

    grunt-bower-update-main

    Build Status

    Auto-update your bower.json main property to include all your module's source files

    Getting Started

    This plugin requires Grunt ~0.4.5

    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-bower-update-main --save-dev

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

    grunt.loadNpmTasks('grunt-bower-update-main');

    The "bowerUpdateMain" task

    Overview

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

    grunt.initConfig({
      bowerUpdateMain: {
        options: {
          // Task-specific options go here.
        },
        your_target: {
          // Target-specific file lists and/or options go here.
        },
      },
    });

    Options

    options.bowerFilename

    Type: String Default value: bower.json

    Location of your bower.json file. By default, it is read from the project root.

    options.bowerFileIndent

    Type: Integer Default value: 2

    How many spaces should be used as indents within the generated bower.json file.

    options.outputFilename

    Type: String|Boolean Default value: false

    Specify an alternative location to use for the bower output file. By default, bower.json is overwritten.

    options.useBowerIgnore

    Type: Boolean Default value: true

    Whether your bower.json file's ignore property should be used to automatically exclude files from the generated array of files for the updated main property.

    Usage Examples

    Default Options

    Simplest usage - specify the location of your source files and nothing else. In this example, all javascript files underneath the app folder are included.

    grunt.initConfig({
      bowerUpdateMain: {
        target: {
          main: [
            'app/**/*.js'
          ]
        }
      }
    });

    Custom Options

    This example includes all javascript in the project root except for bower and node modules

    grunt.initConfig({
      bowerUpdateMain: {
        target: {
          main: [
            '**/*.js',
            '!bower_components/**/*',
            '!node_modules/**/*',
            '!test/**/*'
          ]
        }
      }
    });

    Contributing

    In lieu of a formal style guide, 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

    • 0.2.0 - Add rank feature
    • 0.1.8 - Add test coverage for tested directories
    • 0.1.7 - Add travis CI
    • 0.1.6 - Update jshint
    • 0.1.5 - Fix doc title
    • 0.1.4 - Add test coverage for config without ignores
    • 0.1.3 - Add test coverage for default config
    • 0.1.2 - make outputFilename option false by default
    • 0.1.1 - Add documentation and test cases
    • 0.1.0 - Initial release (works)

    Install

    npm i grunt-bower-update-main

    DownloadsWeekly Downloads

    4

    Version

    0.2.0

    License

    none

    Last publish

    Collaborators

    • matmar10