.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,15 @@
+<!-- Before creating an issue please make sure you are using the latest version of file-loader. -->
+
+**Do you want to request a *feature* or report a *bug*?**
+<!-- Please ask questions on StackOverflow or the webpack Gitter (https://gitter.im/webpack/webpack). Questions will be closed. -->
+
+**What is the current behavior?**
+
+**If the current behavior is a bug, please provide the steps to reproduce.**
+<!-- A great way to do this is to provide your configuration via a GitHub gist. -->
+
+**What is the expected behavior?**
+
+**If this is a feature request, what is motivation or use case for changing the behavior?**
+
+**Please mention other relevant information such as your webpack version, Node.js version and Operating System.**

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,18 @@
+<!-- Thanks for submitting a pull request! Please provide enough information so that others can review your pull request. -->
+
+**What kind of change does this PR introduce?**
+<!-- E.g. a bugfix, feature, refactoring, build related change, etc… -->
+
+**Did you add tests for your changes?**
+
+**If relevant, did you update the README?**
+
+**Summary**
+
+<!-- Explain the **motivation** for making this change. What existing problem does the pull request solve? -->
+<!-- Try to link to an open issue for more information. -->
+
+**Does this PR introduce a breaking change?**
+<!-- If this PR introduces a breaking change, please describe the impact and a migration path for existing applications. -->
+
+**Other information**

.gitignore

@@ -1,2 +1,10 @@
+# development
 /node_modules
 /coverage
+*.log
+
+# dotfiles
+.*
+!.gitignore
+*~
+*#*

.travis.yml

@@ -1,4 +1,29 @@
+sudo: false
 language: node_js
-node_js:
-  - "0.10"
-  - "0.11"
+branches:
+  only:
+    - master
+matrix:
+  fast_finish: true
+  include:
+    # - os: linux
+    #   node_js: "7"
+    #   env: WEBPACK_VERSION="2.2.0" JOB_PART=lint
+    - os: linux
+      node_js: "6"
+      env: WEBPACK_VERSION="2.2.0" JOB_PART=test
+    - os: linux
+      node_js: "4.3"
+      env: WEBPACK_VERSION="2.2.0" JOB_PART=test
+    - os: linux
+      node_js: "7"
+      env: WEBPACK_VERSION="2.2.0" JOB_PART=test
+before_install:
+  - nvm --version
+  - node --version
+before_script:
+  - 'if [ "$WEBPACK_VERSION" ]; then npm install webpack@^$WEBPACK_VERSION; fi'
+script:
+  - npm run travis:$JOB_PART
+# after_success:
+#   - bash <(curl -s https://codecov.io/bash)

CHANGELOG.md

@@ -0,0 +1,58 @@
+# Change Log
+
+All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
+
+<a name="0.11.2"></a>
+## [0.11.2](https://github.com/webpack/file-loader/compare/v0.11.1...v0.11.2) (2017-06-05)
+
+
+### Bug Fixes
+
+* **index:** allow to override publicPath with an empty string ([#145](https://github.com/webpack/file-loader/issues/145)) ([26ab81a](https://github.com/webpack/file-loader/commit/26ab81a))
+* init `publicPath` to undefined ([#159](https://github.com/webpack/file-loader/issues/159)) ([e4c0b2a](https://github.com/webpack/file-loader/commit/e4c0b2a))
+
+
+
+<a name="0.11.1"></a>
+## [0.11.1](https://github.com/webpack/file-loader/compare/v0.11.0...v0.11.1) (2017-04-01)
+
+
+### Bug Fixes
+
+* outputPath function overriden by useRelativePath ([#139](https://github.com/webpack/file-loader/issues/139)) ([80cdee2](https://github.com/webpack/file-loader/commit/80cdee2))
+
+
+
+<a name="0.11.0"></a>
+# [0.11.0](https://github.com/webpack/file-loader/compare/v0.10.1...v0.11.0) (2017-03-31)
+
+
+### Features
+
+* Emit files with relative urls ([#135](https://github.com/webpack/file-loader/issues/135)) ([dbcd6cc](https://github.com/webpack/file-loader/commit/dbcd6cc))
+
+
+
+<a name="0.10.1"></a>
+## [0.10.1](https://github.com/webpack/file-loader/compare/v0.10.0...v0.10.1) (2017-02-25)
+
+
+### Bug Fixes
+
+* **getOptions:** deprecation warn in loaderUtils ([#129](https://github.com/webpack/file-loader/issues/129)) ([a8358a0](https://github.com/webpack/file-loader/commit/a8358a0))
+
+
+
+<a name="0.10.0"></a>
+# [0.10.0](https://github.com/webpack/file-loader/compare/v0.9.0...v0.10.0) (2017-01-28)
+
+
+### Features
+
+* **resources:** specify custom public file name ([6833c70](https://github.com/webpack/file-loader/commit/6833c70))
+
+
+
+# Change Log
+
+All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.

LICENSE

@@ -0,0 +1,20 @@
+Copyright JS Foundation and other contributors
+
+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 above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+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.

README.md

@@ -1,64 +1,156 @@
-# file loader for webpack
-
-## Usage
-
-[Documentation: Using loaders](http://webpack.github.io/docs/using-loaders.html)
-
-``` javascript
-var url = require("file!./file.png");
-// => emits file.png as file in the output directory and returns the public url
-// => returns i. e. "/public-path/0dcbbaa701328a3c262cfd45869e351f.png"
-```
-
-By default the filename of the resulting file is the MD5 hash of the file's contents 
-with the original extension of the required resource.
-
-## Filename templates
-
-You can configure a custom filename template for your file using the query
-parameter `name`. For instance, to copy a file from your `context` directory
-into the output directory retaining the full directory structure, you might
-use `?name=[path][name].[ext]`.
-
-### Filename template placeholders
-
-* `[ext]` the extension of the resource
-* `[name]` the basename of the resource
-* `[path]` the path of the resource relative to the `context` query parameter or option.
-* `[hash]` the hash or the content
-* `[<hashType>:hash:<digestType>:<length>]` optionally you can configure
-  * other `hashType`s, i. e. `sha1`, `md5`, `sha256`, `sha512`
-  * other `digestType`s, i. e. `hex`, `base26`, `base32`, `base36`, `base49`, `base52`, `base58`, `base62`, `base64`
-  * and `length` the length in chars
-* `[N]` the N-th match obtained from matching the current file name against the query param `regExp`
-
-## Examples
-
-``` javascript
-require("file?name=js/[hash].script.[ext]!./javascript.js");
-// => js/0dcbbaa701328a3c262cfd45869e351f.script.js
-
-require("file?name=html-[hash:6].html!./page.html");
-// => html-109fa8.html
-
-require("file?name=[hash]!./flash.txt");
-// => c31e9820c001c9c4a86bce33ce43b679
-
-require("file?name=[sha512:hash:base64:7].[ext]!./image.png");
-// => gdyb21L.png
-// use sha512 hash instead of md5 and with only 7 chars of base64
-
-require("file?name=img-[sha512:hash:base64:7].[ext]!./image.jpg");
-// => img-VqzT5ZC.jpg
-// use custom name, sha512 hash instead of md5 and with only 7 chars of base64
-
-require("file?name=picture.png!./myself.png");
-// => picture.png
-
-require("file?name=[path][name].[ext]?[hash]!./dir/file.png")
-// => dir/file.png?e43b20c069c4a01867c31e98cbce33c9
-```
-
-## License
-
-MIT (http://www.opensource.org/licenses/mit-license.php)
+[![npm][npm]][npm-url]
+[![node][node]][node-url]
+[![deps][deps]][deps-url]
+[![tests][tests]][tests-url]
+[![coverage][cover]][cover-url]
+[![chat][chat]][chat-url]
+
+<div align="center">
+  <a href="https://github.com/webpack/webpack">
+    <img width="200" height="200"
+      src="https://webpack.js.org/assets/icon-square-big.svg">
+  </a>
+  <h1>File Loader</h1>
+  <p>Instructs webpack to emit the required object as file and to return its public url.</p>
+</div>
+
+<h2 align="center">Install</h2>
+
+```bash
+npm install --save-dev file-loader
+```
+
+<h2 align="center">Usage</h2>
+
+By default the filename of the resulting file is the MD5 hash of the file's contents
+with the original extension of the required resource.
+
+``` javascript
+var url = require("file-loader!./file.png");
+// => emits file.png as file in the output directory and returns the public url
+// => returns i. e. "/public-path/0dcbbaa701328a3c262cfd45869e351f.png"
+```
+
+By default a file is emitted, however this can be disabled if required (e.g. for server
+side packages).
+
+``` javascript
+var url = require("file-loader?emitFile=false!./file.png");
+// => returns the public url but does NOT emit a file
+// => returns i. e. "/public-path/0dcbbaa701328a3c262cfd45869e351f.png"
+```
+
+#### Filename templates
+
+You can configure a custom filename template for your file using the query parameter `name`. For instance, to copy a file from your `context` directory into the output directory retaining the full directory structure, you might use `?name=[path][name].[ext]`.
+
+By default, the path and name you specify will output the file in that same directory and will also use that same URL path to access the file.
+
+You can specify custom output and public paths by using the `outputPath`, `publicPath` and `useRelativePath` query name parameters:
+
+```
+use: "file-loader?name=[name].[ext]&publicPath=assets/foo/&outputPath=app/images/"
+```
+
+`useRelativePath` should be `true` if you wish to generate relative URL to the each file context
+```javascript
+{
+ loader: 'file-loader',
+ query: {
+  useRelativePath: process.env.NODE_ENV === "production"
+ }
+}
+```
+
+#### Filename template placeholders
+
+* `[ext]` the extension of the resource
+* `[name]` the basename of the resource
+* `[path]` the path of the resource relative to the `context` query parameter or option.
+* `[hash]` the hash of the content, `hex`-encoded `md5` by default
+* `[<hashType>:hash:<digestType>:<length>]` optionally you can configure
+  * other `hashType`s, i. e. `sha1`, `md5`, `sha256`, `sha512`
+  * other `digestType`s, i. e. `hex`, `base26`, `base32`, `base36`, `base49`, `base52`, `base58`, `base62`, `base64`
+  * and `length` the length in chars
+* `[N]` the N-th match obtained from matching the current file name against the query param `regExp`
+
+#### Examples
+
+``` javascript
+require("file-loader?name=js/[hash].script.[ext]!./javascript.js");
+// => js/0dcbbaa701328a3c262cfd45869e351f.script.js
+
+require("file-loader?name=html-[hash:6].html!./page.html");
+// => html-109fa8.html
+
+require("file-loader?name=[hash]!./flash.txt");
+// => c31e9820c001c9c4a86bce33ce43b679
+
+require("file-loader?name=[sha512:hash:base64:7].[ext]!./image.png");
+// => gdyb21L.png
+// use sha512 hash instead of md5 and with only 7 chars of base64
+
+require("file-loader?name=img-[sha512:hash:base64:7].[ext]!./image.jpg");
+// => img-VqzT5ZC.jpg
+// use custom name, sha512 hash instead of md5 and with only 7 chars of base64
+
+require("file-loader?name=picture.png!./myself.png");
+// => picture.png
+
+require("file-loader?name=[path][name].[ext]?[hash]!./dir/file.png")
+// => dir/file.png?e43b20c069c4a01867c31e98cbce33c9
+```
+
+<h2 align="center">Contributing</h2>
+
+Don't hesitate to create a pull request. Every contribution is appreciated. In development you can start the tests by calling `npm test`.
+
+<h2 align="center">Maintainers</h2>
+
+<table>
+  <tbody>
+    <tr>
+      <td align="center">
+        <img width="150" height="150"
+        src="https://avatars.githubusercontent.com/sokra?v=3">
+        <br />
+        <a href="https://github.com/">Tobias Koppers</a>
+      </td>
+      <td align="center">
+        <img width="150" height="150"
+        src="https://avatars.githubusercontent.com/SpaceK33z?v=3">
+        <br />
+        <a href="https://github.com/">Kees Kluskens</a>
+      </td>
+      <td align="center">
+        <img width="150" height="150"
+        src="https://avatars.githubusercontent.com/mobitar?v=3">
+        <br />
+        <a href="https://github.com/">Mo Bitar</a>
+      </td>
+    </tr>
+  </tbody>
+</table>
+
+
+<h2 align="center">LICENSE</h2>
+
+MIT
+
+[npm]: https://img.shields.io/npm/v/file-loader.svg
+[npm-url]: https://npmjs.com/package/file-loader
+
+[node]: https://img.shields.io/node/v/file-loader.svg
+[node-url]: https://nodejs.org
+
+[deps]: https://david-dm.org/webpack-contrib/file-loader.svg
+[deps-url]: https://david-dm.org/webpack-contrib/file-loader
+
+[tests]: http://img.shields.io/travis/webpack-contrib/file-loader.svg
+[tests-url]: https://travis-ci.org/webpack-contrib/file-loader
+
+[cover]: https://coveralls.io/repos/github/webpack-contrib/file-loader/badge.svg
+[cover-url]: https://coveralls.io/github/webpack-contrib/file-loader
+
+[chat]: https://badges.gitter.im/webpack/webpack.svg
+[chat-url]: https://gitter.im/webpack/webpack

index.js

@@ -2,18 +2,79 @@
 	MIT License http://www.opensource.org/licenses/mit-license.php
 	Author Tobias Koppers @sokra
 */
+var path = require("path");
 var loaderUtils = require("loader-utils");
 
 module.exports = function(content) {
 	this.cacheable && this.cacheable();
 	if(!this.emitFile) throw new Error("emitFile is required from module system");
-	var query = loaderUtils.parseQuery(this.query);
-	var url = loaderUtils.interpolateName(this, query.name || "[hash].[ext]", {
-		context: query.context || this.options.context,
+
+	var query = loaderUtils.getOptions(this) || {};
+	var configKey = query.config || "fileLoader";
+	var options = this.options[configKey] || {};
+	var config = {
+		publicPath: undefined,
+		useRelativePath: false,
+		name: "[hash].[ext]"
+	};
+
+	// options takes precedence over config
+	Object.keys(options).forEach(function(attr) {
+		config[attr] = options[attr];
+	});
+
+	// query takes precedence over config and options
+	Object.keys(query).forEach(function(attr) {
+		config[attr] = query[attr];
+	});
+
+	var context = config.context || this.options.context;
+	var url = loaderUtils.interpolateName(this, config.name, {
+		context: context,
 		content: content,
-		regExp: query.regExp
+		regExp: config.regExp
 	});
-	this.emitFile(url, content);
-	return "module.exports = __webpack_public_path__ + " + JSON.stringify(url) + ";";
-}
+
+	var outputPath = "";
+
+	var filePath = this.resourcePath;
+	if (config.useRelativePath) {
+		var issuerContext = this._module && this._module.issuer && this._module.issuer.context || context;
+		var relativeUrl = issuerContext && path.relative(issuerContext, filePath).split(path.sep).join("/");
+		var relativePath = relativeUrl && path.dirname(relativeUrl) + "/";
+		if (~relativePath.indexOf("../")) {
+			outputPath = path.posix.join(outputPath, relativePath, url);
+		} else {
+			outputPath = relativePath + url;
+		}
+		url = relativePath + url;
+	} else if (config.outputPath) {
+		// support functions as outputPath to generate them dynamically
+		outputPath = (
+			typeof config.outputPath === "function"
+			? config.outputPath(url)
+			: config.outputPath + url
+		);
+		url = outputPath;
+	} else {
+		outputPath = url;
+	}
+
+	var publicPath = "__webpack_public_path__ + " + JSON.stringify(url);
+	if (config.publicPath !== undefined) {
+		// support functions as publicPath to generate them dynamically
+		publicPath = JSON.stringify(
+			typeof config.publicPath === "function"
+			? config.publicPath(url)
+			: config.publicPath + url
+		);
+	}
+
+	if (query.emitFile === undefined || query.emitFile) {
+		this.emitFile(outputPath, content);
+	}
+
+	return "module.exports = " + publicPath + ";";
+};
+
 module.exports.raw = true;

package.json

@@ -1,20 +1,23 @@
 {
   "name": "file-loader",
-  "version": "0.8.5",
+  "version": "0.11.2",
   "author": "Tobias Koppers @sokra",
   "description": "file loader module for webpack",
   "files": [
     "index.js"
   ],
   "dependencies": {
-    "loader-utils": "~0.2.5"
+    "loader-utils": "^1.0.2"
   },
   "devDependencies": {
     "should": "~4.0.4",
+    "standard-version": "^4.0.0",
     "mocha": "~1.21.3"
   },
   "scripts": {
-    "test": "mocha -R spec"
+    "test": "mocha -R spec",
+    "travis:test": "npm run test",
+    "release": "standard-version"
   },
   "repository": {
     "type": "git",

test/correct-filename.test.js

@@ -4,7 +4,7 @@ var fileLoader = require("../");
 
 function run(resourcePath, query, content) {
 	content = content || new Buffer("1234");
-	var result = null;
+	var file = null;
 	var context = {
 		resourcePath: resourcePath,
 		query: "?" + query,
@@ -13,15 +13,43 @@ function run(resourcePath, query, content) {
 		},
 		emitFile: function(url, content2) {
 			content2.should.be.eql(content);
-			result = url;
+			file = url;
 		}
 	};
-	fileLoader.call(context, content);
-	return result;
+
+	var result = fileLoader.call(context, content)
+
+	return {
+		file: file,
+		result: result
+	}
+}
+function run_with_options(resourcePath,options, content) {
+	content = content || new Buffer("1234");
+	var file = null;
+
+	var context = {
+		resourcePath: resourcePath,
+		options: {
+			"fileLoader": options,
+			context: "/this/is/the/context"
+		},
+    	emitFile: function(url, content2) {
+			content2.should.be.eql(content);
+			file = url;
+		}
+	};
+
+	var result = fileLoader.call(context, content)
+
+	return {
+		file: file,
+		result: result
+	}
 }
 
 function test(excepted, resourcePath, query, content) {
-	run(resourcePath, query, content).should.be.eql(excepted);
+	run(resourcePath, query, content).file.should.be.eql(excepted);
 }
 
 describe("correct-filename", function() {
@@ -56,5 +84,68 @@ describe("correct-filename", function() {
 		test("sntmopgidsdqrofkjywoyldtiij.txt", "/file.txt", "name=[hash:base26].[ext]");
 		test("sntmopgids.txt", "/file.txt", "name=[hash:base26:10].[ext]");
 	});
-
-});
+});
+
+describe("publicPath option", function() {
+	it("should be supported", function() {
+		run("/file.txt", "publicPath=http://cdn/").result.should.be.eql(
+			'module.exports = "http://cdn/81dc9bdb52d04dc20036dbd8313ed055.txt";'
+		);
+	});
+
+	it("should override public path when given empty string", function() {
+		run("file.txt", "publicPath=").result.should.be.eql(
+			'module.exports = "81dc9bdb52d04dc20036dbd8313ed055.txt";'
+		);
+	});
+
+	it("should use webpack public path when not set", function() {
+		run("file.txt").result.should.be.eql(
+			'module.exports = __webpack_public_path__ + "81dc9bdb52d04dc20036dbd8313ed055.txt";'
+		);
+	});
+});
+
+describe("useRelativePath option", function() {
+	it("should be supported", function() {
+		run("/this/is/the/context/file.txt", "useRelativePath=true").result.should.be.eql(
+			'module.exports = __webpack_public_path__ + \"./81dc9bdb52d04dc20036dbd8313ed055.txt\";'
+		);
+		run("/this/is/file.txt", "useRelativePath=true").result.should.be.eql(
+			'module.exports = __webpack_public_path__ + \"../../81dc9bdb52d04dc20036dbd8313ed055.txt\";'
+		);
+		run("/this/file.txt", "context=/this/is/the/&useRelativePath=true").result.should.be.eql(
+			'module.exports = __webpack_public_path__ + \"../../81dc9bdb52d04dc20036dbd8313ed055.txt\";'
+		);
+		run("/this/file.txt", "context=/&useRelativePath=true").result.should.be.eql(
+			'module.exports = __webpack_public_path__ + \"this/81dc9bdb52d04dc20036dbd8313ed055.txt\";'
+		);
+	});
+});
+describe("outputPath function", function() {
+	it("should be supported", function() {
+      outputFunc = function(value) {
+        return("/path/set/by/func");
+
+      };
+      var options = {};
+      options.outputPath = outputFunc;
+      run_with_options("/this/is/the/context/file.txt", options).result.should.be.eql(
+        'module.exports = __webpack_public_path__ + \"/path/set/by/func\";'
+      );
+
+	});
+	it("should be ignored if you set useRelativePath", function() {
+	      outputFunc = function(value) {
+	        return("/path/set/by/func");
+
+	      };
+	      var options = {};
+	      options.outputPath = outputFunc;
+	      options.useRelativePath = true;
+	      run_with_options("/this/is/the/context/file.txt", options).result.should.be.eql(
+	        'module.exports = __webpack_public_path__ + \"./81dc9bdb52d04dc20036dbd8313ed055.txt\";'
+	      );
+
+		});
+});

test/optional-file-emission.test.js

@@ -0,0 +1,29 @@
+var should = require("should");
+var fileLoader = require("../");
+
+function run(resourcePath, query, content) {
+	content = content || new Buffer("1234");
+	var result = false;
+	var context = {
+		resourcePath: resourcePath,
+		query: "?" + query,
+		options: {
+			context: "/this/is/the/context"
+		},
+		emitFile: function(url, content2) {
+			result = true;
+		}
+	};
+	fileLoader.call(context, content);
+	return result;
+}
+
+describe("optional-emission", function() {
+	it("should emit a file by default", function() {
+		run("whatever.txt", "").should.be.true;
+	});
+
+	it("should not emit a file if disabled", function() {
+		run("whatever.txt", "emitFile=false").should.be.false;
+	});
+});