Merge remote-tracking branch 'upstream/master'

Author: zoubin

README.md

@@ -66,55 +66,27 @@ Type: `Result`
 
 ## Result
 
-### url
+Properties and methods:
 
-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)
+* `url`: `String`
+* `from`: The CSS source path
+* `to`: The CSS destination path
+* `file`: The asset source path
+* `asset`: `Asset`.
+* `isRelative()`: `Function`
+* `Result.getFile(url, opts)`. Return the `file` property.
+* `Result.dataUrl(file)`
 
 ## Asset
 
-### mimeType
-
-### size()
+Properties and methods:
 
-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
+* `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
 
@@ -124,57 +96,61 @@ A group of transform methods.
 
 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)
+* `maxSize`: `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
+* `useHash`: `Boolean`, default: `false`. If `true`, assets are renamed by their sha1 hashes.
+* `name`: `String`, default: `null`. Specify how to rename the asset. It only works when `useHash` is false. Special patterns:
+  * `[name]`: replaced with the basename of the asset, without the extension.
+  * `[hash]`: replaced with the hash
+* `assetOutFolder`: `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, unless `baseUrl` is specified.
+* `baseUrl`: `String`, default: `null`. Specify the base url for assets.
 
-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
+```js
+var url = require('postcss-custom-url')
+var postcss = require('postcss')
 
-If `Function`, it receives the asset file path and `result.opts`,
-and should return the output folder.
+postcss(url([
+  [
+    'copy',
+    {
+      // copy images to /path/to/build/images
+      // since the final css file is /path/to/build/css/style.css,
+      // url is set to ../images/octocat_setup.84f6371.png
+      assetOutFolder: '/path/to/build/images',
+
+      // rename images like octocat_setup.84f6371.png
+      name: '[name].[hash]',
+
+      // if set to true, all images are named after `[hash]`
+      // useHash: true,
+
+      // if specified, reset url to i/octocat_setup.84f6371.png
+      // baseUrl: 'i',
+    },
+  ],
+]))
+.process(
+  '.a{ background-image: url(images/octocat_setup.png); }',
+  { from: '/path/to/src/style.css', to: '/path/to/build/css/style.css' }
+)
+.then(function (result) {
+  console.log(result.css)
+  // '.a{ background-image: url(../images/octocat_setup.png); }'
+})
 
-Urls are transformed based on the destination.
+```
 

changelog.md

@@ -1,4 +1,12 @@
-<!-- 5d24916 1460952667000 -->
+<!-- 4cfed5e 1460974453000 -->
+
+## [v4.2.0](https://github.com/reducejs/postcss-custom-url/commit/4cfed5e) (2016-04-18)
+
+* [[`22b2b06`](https://github.com/reducejs/postcss-custom-url/commit/22b2b06)] readme
+
+* [[`2e6101f`](https://github.com/reducejs/postcss-custom-url/commit/2e6101f)] copy, support specifying baseUrl
+
+* [[`0add06b`](https://github.com/reducejs/postcss-custom-url/commit/0add06b)] changelog
 
 ## [v4.1.0](https://github.com/reducejs/postcss-custom-url/commit/5d24916) (2016-04-18)
 

lib/result.js

@@ -46,15 +46,14 @@ class Result {
       }
     })
     return trs.reduce(function (p, tr) {
-      return p.then(function () {
+      return p.then(function (next) {
+        if (next === false) {
+          return false
+        }
         if (typeof tr[0] === 'string') {
           tr[0] = util[tr[0]]
         }
-        let r = tr[0].apply(null, tr.slice(1))
-        if (r && typeof r.then === 'function') {
-          return r
-        }
-        return Promise.resolve()
+        return tr[0].apply(null, tr.slice(1))
       })
     }, Promise.resolve())
   }

lib/util.js

@@ -7,15 +7,15 @@ const promisify = require('node-promisify')
 const fsWrite = promisify(fs.writeFile)
 const mkdirp = promisify(require('mkdirp'))
 
-exports.rebase = function (result) {
+function rebase(result) {
   if (result.isRelative()) {
     result.url = path.relative(
       path.dirname(result.to), result.file
     )
   }
 }
 
-exports.inline = function (result, opts) {
+function inline(result, opts) {
   opts = opts || {}
   let asset = result.asset
   if (!result.isRelative() || !asset.mimeType) {
@@ -36,7 +36,7 @@ exports.inline = function (result, opts) {
     })
 }
 
-exports.copy = function (result, opts) {
+function copy(result, opts) {
   if (!result.isRelative()) return
 
   opts = opts || {}
@@ -71,12 +71,22 @@ exports.copy = function (result, opts) {
     })
     .then(function (basename) {
       let assetFile = path.join(assetFolder, basename)
-      result.url = path.relative(
-        path.dirname(result.to), assetFile
-      )
+      if (opts.baseUrl) {
+        result.url = path.join(opts.baseUrl, basename)
+      } else {
+        result.url = path.relative(
+          path.dirname(result.to), assetFile
+        )
+      }
       return result.asset.data().then(function (buf) {
         return fsWrite(assetFile, buf)
       })
     })
 }
 
+module.exports = {
+  rebase: rebase,
+  inline: inline,
+  copy: copy,
+}
+

package.json

@@ -1,6 +1,6 @@
 {
   "name": "postcss-custom-url",
-  "version": "4.1.0",
+  "version": "4.2.0",
   "description": "Transform `url()` in css",
   "main": "index.js",
   "scripts": {

test/custom.js

@@ -13,12 +13,7 @@ const fixtures = path.resolve.bind(path, __dirname, 'fixtures')
 test('custom', function(t) {
   let url = custom([
     [ util.inline, { maxSize: 10 } ],
-    [function (result, base) {
-      if (result.url.slice(0, 5) === 'data:') return
-
-      result.url = path.join(base, path.basename(result.url))
-    }, 'i'],
-    'copy',
+    ['copy', { assetOutFolder: fixtures('build', 'css', 'assets'), baseUrl: 'i' }],
   ])
   let body = '.a{ background-image: url(images/octocat_setup.png) url(images/octocat_fork.png); }'
   let expectedBody = [ '.a{background-image:url(', ')url(i/octocat_fork.png);}' ]
@@ -38,7 +33,7 @@ test('custom', function(t) {
     .then(function (result) {
       t.equal(result.css.replace(/\s+/g, ''), expectedBody, 'should inline and transform url')
       return Promise.all([
-        Result.dataUrl(fixtures('build', 'css/i', 'octocat_fork.png')),
+        Result.dataUrl(fixtures('build', 'css/assets', 'octocat_fork.png')),
         Result.dataUrl(fixtures('images', 'octocat_fork.png')),
       ])
     })

test/result.js

@@ -0,0 +1,18 @@
+'use strict'
+
+const test = require('tap').test
+const Result = require('../lib/result')
+
+test('return false', function (t) {
+  var result = new Result('i/a.png', { from: '/path/to/style.css' })
+  return result.transform([
+    r => { r.url = 'x/a.png' },
+    r => {
+      r.url = 'y/a.png'
+      return false
+    },
+    r => { r.url = 'z/a.png' },
+  ])
+  .then(() => t.equal(result.url, 'y/a.png'))
+})
+