npmignore update. query params replacement. readme

Author: Val

.npmignore

@@ -3,3 +3,4 @@
 *.log
 *.swp
 node_modules/
+test/

README.md

@@ -0,0 +1,68 @@
+# Replace loader for [Webpack](http://webpack.github.io/)
+
+Perform replacements (plain and regular expression) in the contents loaded by the loader.
+
+## Install:
+
+```bash
+$ npm install --save-dev replace-loader
+```
+
+## Usage:
+
+### Plain replacement:
+
+In your `webpack.config.js`:
+
+```javascript
+module.exports = {
+    // ...
+    module: {
+      loaders: [
+        {
+          test: /fileInWhichJQueryIsUndefined\.js$/,
+          loader: 'replace',
+          query: {
+            search: 'jQuery',
+            replace: 'window.$'
+          }
+        }
+      ]
+    }
+}
+```
+
+### Regex replacement:
+
+To achieve regular expression replacement you should specify the `flags` query param
+(as an empty string if you do not want any flags). In this case, `search` and `flags` are being
+passed to the [RegExp](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp) constructor.
+
+In your `webpack.config.js`:
+
+```javascript
+module.exports = {
+    // ...
+    module: {
+      loaders: [
+        {
+          test: /fileInWhichJQueryIsUndefined\.js$/,
+          loader: 'replace',
+          query: {
+            search: 'jquery',
+            replace: 'window.$',
+            flags: 'i'
+          }
+        }
+      ]
+    }
+}
+```
+
+## Contributing:
+
+Feel free to open issues to propose stuff and participate. Pull requests are also welcome.
+
+## Licence:
+
+[MIT](http://en.wikipedia.org/wiki/MIT_License)

index.js

@@ -3,12 +3,12 @@ var utils = require('loader-utils');
 module.exports = function (source) {
   var query = utils.parseQuery(this.query);
 
-  if (typeof query.subject !== 'undefined' && typeof query.replacement !== 'undefined') {
+  if (typeof query.search !== 'undefined' && typeof query.replace !== 'undefined') {
     if (typeof query.flags !== 'undefined') {
-      query.subject = new RegExp(query.subject, query.flags);
+      query.search = new RegExp(query.search, query.flags);
     }
 
-    source = source.replace(query.subject, query.replacement);
+    source = source.replace(query.search, query.replace);
   }
 
   return source;

package.json

@@ -1,10 +1,12 @@
 {
   "name": "replace-loader",
-  "version": "0.0.1",
-  "description": "",
+  "version": "0.1.0",
+  "description": "Replace loader for Webpack",
   "keywords": [
     "webpack",
-    "webpack-loader"
+    "loader",
+    "webpack-loader",
+    "replace"
   ],
   "scripts": {
     "test": "mocha"

test/index.test.js

@@ -9,7 +9,7 @@ var outputFileName = 'build.js';
 var outputFilePath = path.join(outputDirPath, outputFileName);
 
 describe('Webpack replace loader ...', function () {
-  it('should replace with string subject', function (done) {
+  it('should replace with string search', function (done) {
     webpack(
       {
         entry: entryFilePath,
@@ -23,8 +23,8 @@ describe('Webpack replace loader ...', function () {
               test: /\.js$/,
               loader: '__this',
               query: {
-                subject: 'var value',
-                replacement: 'var a'
+                search: 'var value',
+                replace: 'var a'
               }
             }
           ]
@@ -44,7 +44,7 @@ describe('Webpack replace loader ...', function () {
     );
   });
 
-  it('should replace with pattern subject', function (done) {
+  it('should replace with pattern search', function (done) {
     webpack(
       {
         entry: entryFilePath,
@@ -58,8 +58,8 @@ describe('Webpack replace loader ...', function () {
               test: /\.js$/,
               loader: '__this',
               query: {
-                subject: 'var VALUE = \'\.*\'',
-                replacement: 'var a = \'\'',
+                search: 'var VALUE = \'\.*\'',
+                replace: 'var a = \'\'',
                 flags: 'i'
               }
             }
@@ -94,16 +94,16 @@ describe('Webpack replace loader ...', function () {
               test: /\.js$/,
               loader: '__this',
               query: {
-                subject: 'var value',
-                replacement: 'var a'
+                search: 'var value',
+                replace: 'var a'
               }
             },
             {
               test: /bar\.js$/,
               loader: '__this',
               query: {
-                subject: 'var value',
-                replacement: 'var bar'
+                search: 'var value',
+                replace: 'var bar'
               }
             }
           ]
@@ -137,8 +137,8 @@ describe('Webpack replace loader ...', function () {
             {
               test: /\.js$/,
               loaders: [
-                '__this?subject=var value&replacement=var a',
-                '__this?subject=module.exports = value&replacement=module.exports = a'
+                '__this?search=var value&replace=var a',
+                '__this?search=module.exports = value&replace=module.exports = a'
               ]
             }
           ]