Merge branch 'release/1.0.0'

nystudio107 · Oct 19, 2018 · c9ee969 · c9ee969
2 parents 6e4e97b + fc7e47a
commit c9ee969
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 18 deletions.
diff --git a/README.md b/README.md
@@ -1,14 +1,14 @@
 ## How it works
 
-webpack 4 plugin to download remote files, and save them locally.
+webpack 4 plugin to download & save remote files locally
 
 ## Usage
 
 ```js
-const DownloadFilePlugin = require('download-file-webpack-plugin');
+const SaveRemoteFilePlugin = require('save-remote-file-webpack-plugin');
 module.exports = {
     plugins: [
-        new DownloadFilePlugin([
+        new SaveRemoteFilePlugin([
             {
                 url: 'http://example.com/some/file.txt',
                 filepath: 'local.txt',
@@ -24,5 +24,5 @@ You can pass in either an object, or an array of objects.
 
 ## Options
 
-* **url** remote URL of the file to download
-* **filepath** filename where the file will be saved
+* **url** remote URL of the remote file to save locally
+* **filepath** filename where the file will be saved, relative to your webpack `output.path`
diff --git a/dist/index.js b/dist/index.js
@@ -8,8 +8,8 @@ var download = require('download-to-file');
 var path = require('path');
 
 module.exports = function () {
-    function DownloadFilePlugin(options) {
-        _classCallCheck(this, DownloadFilePlugin);
+    function SaveRemoteFilePlugin(options) {
+        _classCallCheck(this, SaveRemoteFilePlugin);
 
         if (options instanceof Array) {
             this.options = options;
@@ -18,13 +18,13 @@ module.exports = function () {
         }
     }
 
-    _createClass(DownloadFilePlugin, [{
+    _createClass(SaveRemoteFilePlugin, [{
         key: 'apply',
         value: function apply(compiler) {
             var _this = this;
 
             compiler.hooks.beforeRun.tapAsync({
-                name: 'DownloadFilePlugin',
+                name: 'SaveRemoteFilePlugin',
                 context: true
             }, function (context, compilation, callback) {
                 var downloadFiles = function downloadFiles(option) {
@@ -35,7 +35,7 @@ module.exports = function () {
                             compilation.errors.push(new Error(err));
                         } else {
                             if (reportProgress) {
-                                reportProgress(100.0, 'Download finished: ', filepath);
+                                reportProgress(100.0, 'Remote files saved to: ', filepath);
                             }
                         }
                     });
@@ -46,5 +46,5 @@ module.exports = function () {
         }
     }]);
 
-    return DownloadFilePlugin;
+    return SaveRemoteFilePlugin;
 }();
diff --git a/package.json b/package.json
@@ -1,15 +1,15 @@
 {
-  "name": "download-file-webpack-plugin",
+  "name": "save-remote-file-webpack-plugin",
   "version": "1.0.0",
-  "description": "webpack 4 plugin to download remote files, and save them locally",
+  "description": "webpack 4 plugin to download & save remote files locally",
   "main": "dist/index.js",
   "dependencies": {
     "download-to-file": "^2.1.0"
   },
-  "homepage": "https://github.com/nystudio107/download-file-webpack-plugin",
+  "homepage": "https://github.com/nystudio107/save-remote-file-webpack-plugin",
   "repository": {
     "type": "git",
-    "url": "[email protected]:nystudio107/download-file-webpack-plugin.git"
+    "url": "[email protected]:nystudio107/save-remote-file-webpack-plugin.git"
   },
   "devDependencies": {
     "babel-cli": "^6.22.2",

diff --git a/src/index.js b/src/index.js
@@ -1,7 +1,7 @@
 const download = require('download-to-file')
 const path = require('path');
 
-module.exports = class DownloadFilePlugin {
+module.exports = class SaveRemoteFilePlugin {
     constructor(options) {
         if (options instanceof Array) {
             this.options = options;
@@ -13,7 +13,7 @@ module.exports = class DownloadFilePlugin {
     apply(compiler) {
         compiler.hooks.beforeRun.tapAsync(
             {
-                name: 'DownloadFilePlugin',
+                name: 'SaveRemoteFilePlugin',
                 context: true
             },
             (context, compilation, callback) => {
@@ -25,7 +25,7 @@ module.exports = class DownloadFilePlugin {
                             compilation.errors.push(new Error(err));
                         } else {
                             if (reportProgress) {
-                                reportProgress(100.0, 'Download finished: ', filepath);
+                                reportProgress(100.0, 'Remote files saved to: ', filepath);
                             }
                         }
                     });