postcss-custom-url

Transform url() in css.

Usage

var url = require('postcss-custom-url')
var util = url.util

var postcss = require('postcss')
var path = require('path')
var fixtures = path.resolve.bind(path, __dirname, 'fixtures')

postcss(url([
  [ util.inline, { maxSize: 5 } ],
  // equivalent with util.copy
  [ 'copy', { assetOutFolder: fixtures('build', 'images') } ],
]))
.process(
  '.a{ background-image: url(images/octocat_setup.png); }',
  { from: fixtures('a.css'), to: fixtures('build', 'css', 'a.css') }
)
.then(function (result) {
  console.log(result.css)
  // '.a{ background-image: url(../images/octocat_setup.png); }'
})

url(customTransforms)

customTransforms

Type: Array

Default: [ util.rebase ]

An array of transforms.

If an element is not a function, it should be the name of a method exported by util: 'copy', 'inline', 'rebase'.

transforms

Type: Function, Array

Signature: transformFn(result, ...args)

Function to transform url, through modifying result.url

If Array, the first element should be the transform function, and elements after the first will be treated as its arguments args.

result

Type: Result

Result

url

Type: String

from

The CSS source path

to

The CSS destination path

file

The asset source path

asset

Type: Asset

isRelative()

Result.getFile(url, opts)

Result.dataUrl(file)

Asset

mimeType

size()

Return a promise to get the size of the asset

data()

Return a promise to get the contents of the asset

shasum()

Return a promise to get the sha1 of the contents of the asset

base64()

Return a promise to get the base64 of the contents of the asset

dataUrl()

Return a promise to get the data url of the asset

util

A group of transform methods.

rebase

Transform result.url according to result.to

inline

Transform result.url to data-url.

Options:

maxSize

Type: Number

Default: 10

Specify the maximum file size to inline (in kbytes)

copy

Copy asset files to proper destinations and transform result.url.

Options:

useHash

Type: Boolean

Default: false

If true, assets are renamed by their sha1 hashes

name

Specify how to rename the asset.

It only works when useHash is false.

Type: String

Special patterns:

[name]: replaced with the basename of the asset, without the extension.
[hash]: replaced with the hash

For example, you can specify [name].[hash] to keep the original asset name while using its hash.

assetOutFolder

Type: String, Function

Specify the destination where assets should be copied

If Function, it receives the asset file path and result.opts, and should return the output folder.

Urls are transformed based on the destination.