grunt-filepath

Replace a string with the file's relative file path / URL. Originally created to get a dynamic URL in to the OpenGraph metadata of static HTML pages.

The "filepath" task

Overview

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

In the example below, we're:

1. Recursing through everything in the 'test' folder
2. Ignoring any files or folders that contain the strings in the ignore array
3. Finding the string '@@path'
4. Replacing it with the relative file path prefixed with the base variable 'https://mywebsite.com/'.

NOTE: Omit the base parameter if you wish to use the relative path to the file

grunt.initConfig({
  filepath: {
    multiple_files: {
      files: {
        'src_and_dest': ['./test/**']
      },
      remove: './test/',
      ignore: ['ignore-this'],
      base: 'https://mywebsite.com/',
      replace: '@@path'
    }
  }
})

Options

options.files (required)

Type: Array Default value: none

The files and folders you wish to search and replace

options.replace

Type: String Default value: @@path

The variable name you wish to replace with the relative file path

options.ignore

Type: Array Default value: none

The files and folders you wish to ignore, currently only in string format.

options.base

Type: String Default value: ``

Turn your relative file path in to a URL.

options.remove

Type: String Default value: ``

Remove any part of the filepath after it's resolved. E.g. you may not want "/build" in the URL.

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

(Nothing yet)

License

Copyright (c) 2015 Martin Edwards. Licensed under the MIT license.