Git Product home page Git Product logo

grunt-img-find-and-copy's Introduction

grunt-img-find-and-copy

A Grunt plugin to find only the used images in your CSS and HTML files and copy those images to your build location.

Getting Started

This plugin requires Grunt.

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-img-find-and-copy --save-dev

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

grunt.loadNpmTasks('grunt-img-find-and-copy');

The "img_find_and_copy" task

Overview

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

grunt.initConfig({
  img_find_and_copy: {
        resources: {
          files: {
            'build': ['css/**/*.css', '*.html']
          }
        }
      }
})

The options are pretty simple, in the example above 'build': ['css/**/*.css', '*.html'] the build is the location folder where you want your images copied to, this is ideally your build folder (e.g. dist etc). The array of wildcard file definitions in ['css/**/*.css', '*.html'] are the files that will be evaluated for image references.

You can specify CSS or HTML files, once images are found they will be copied to the build folder and the relative paths will be mapped and resolved so all original paths remain the same.

Usage Examples

Default Options

Evaluate all my local CSS and HTML files that are used in Dev mode and copy all the referenced images to my build folder. So I can have 100s of reference images in Dev mode (if needed) but only have the used actually used by my app to appear in my final build.

grunt.initConfig({
  img_find_and_copy: {
        resources: {
          files: {
            'build': ['css/**/*.css', '*.html']
          }
        }
      }
})

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

  • 1.0.1 - If no build folder found, it now gives a console error.
  • 1.0.0 - Initial version (bugs may be found so please test and raise any issues).

License

Copyright (c) 2015 newbreedofgeek. Licensed under the MIT license.

grunt-img-find-and-copy's People

Stargazers

Yingchun Tian avatar

Watchers

Mark Paul avatar

Forkers

jwardee

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.