Rebase

The problem

You want to build a project, and have the directory structure change a bit. For whatever reason. You could just simply copy everything, but you would have to rename absolute references to file paths. Like script includes, stylsheets, image sources.

This grunt task handles all that, plus you can set it to copy only referenced files.

The intended usage is Grunt's file array format. With this, you can copy multiple types of files into different dirs, and the task will be able to look for reference in all of them.

Scopes

Rebase is based on scopes. Each one parallels with a form of resource include.

script

Matches script tags, and their sources.

  <script type="text/javascript" src="/static/script/test.js"></script>

link

Matches stylesheet links and their href attribute's value.

  <link rel="stylesheet" href="/static/style/css.css"/>

a

Matches html link tags and their href attribute's value.

  <a href="..."></a>

img

Matches image elements and their source value.

  <img src="..." alt="test"/>

url

Matches url() resource links in css.

#test-1{
  background: url("...");
}

Url matching

In the grunt task, define a scope object on the file object. The keys will be converted to a RegExp pattern, and matched against the source files the task runs on. The values of the scope's properties will be replace value of "".replace(pattern, replacement).

Options

filter

Type: Boolean

Default: false

Filter unreferenced files.

base

Type: String

Default: ""

Prepend this path part to the matched resources. Useful if resource root is not the project root.

E.g.:

Matched: "/images/image.jpg" for an image src

Path in project: src/images/image.jpg

Base: "src/"

Rebase to: dist/static/img/

File will be written to dist/static/img/image.jpg

Install

npm install rebase --save-dev

Grunt task

grunt.loadNpmTasks('grunt-rebase');

Usage

grunt.initConfig({
  rebase: {
    noscope: {
      expand: true,
      cwd: "test/src/css/",
      src: "*.css",
      dest: "test/dest/static/style/"
    },
    scoped: {
      // global options
      options: {
        // filter unreferenced files
        filter: true,
        // prepend this base to every reference
        base: "test/src/"
      },
      files: [{
        expand: true,
        cwd: "test/src/css/",
        src: "*.css",
        dest: "test/dest/static/style/",
        // match glob pattern and add them to references
        reference: "test/src/css/*.css",
        scopes: {
          url: {
            "/?img": "/static/images",
            "/?font": "/static/fonts"
          }
        }
      }, {
        expand: true,
        cwd: "test/src/",
        src: "*.html",
        dest: "test/dest/",
        // add processed files to references
        reference: true,
        scopes: {
          url: {
            "/?img": "/static/images",
            "/?font": "/static/fonts"
          },
          a: {
            "/?img": "/static/images"
          },
          img: {
            "/?img": "/static/images"
          },
          link: {
            "/?css": "/static/style"
          },
          script: {
            "/?js": "/static/script"
          }
        }
      }, {
        expand: true,
        cwd: "test/src/img/",
        src: "*.*",
        dest: "test/dest/static/images/"
      }, {
        expand: true,
        cwd: "test/src/js/",
        src: "*.*",
        dest: "test/dest/static/script/"
      }]
    }
  }
})

LICENCE

Copyright (c) 2014 Nagy Zoltan

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.