grunt-downloadfile

Download files via Grunt

Stats

StarsIssuesVersionUpdatedCreatedSize
grunt-downloadfile
312.1.12 years ago8 years agoMinified + gzip package size for grunt-downloadfile in KB

Readme

grunt-downloadfile

Getting Started

This plugin requires Grunt ~0.4.1

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

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

grunt.loadNpmTasks('grunt-downloadfile');

The "downloadfile" task

Overview

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

grunt.initConfig({
  downloadfile: {
    options: {
      dest: './node-versions',
      overwriteEverytime: false
    },
    files: {
      'node-v0.10.20.tar.gz': 'http://nodejs.org/dist/v0.10.20/node-v0.10.20.tar.gz',
      'node-v0.10.2.tar.gz': 'http://nodejs.org/dist/v0.10.2/node-v0.10.2.tar.gz'
    }
  }
})

Options

options.dest

Type: String Default value: './'

Destination of downloaded files. If the folder doesn't exists grunt will create it.

options.overwriteEverytime

Type: Boolean Default value: false

In case the download file is already present skip downloading. In case you want to overwrite file everytime pass true

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

v2 - New API, simplier configuration

Author

Michael Czolko

ko-fi

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.