dir-archiver 1.2.0 → 2.0.0

package/README.md

@@ -25,9 +25,14 @@ const excludes = ['directory_name', 'file.extension'];
  * Create a dir-archiver object. 
  * @param {string} directoryPath - The path of the folder to archive.
  * @param {string} zipPath - The path of the zip file to create.
+ * @param {Boolean} includeBaseDirectory - Includes a base directory at the root of the archive.
+ * For example, if the root folder of your project is named "your-project", setting
+ * includeBaseDirectory to true will create an archive that includes this base directory.
+ * If this option is set to false the archive created will unzip its content to
+ * the current directory.
  * @param {array} excludes - A list with the names of the files and folders to exclude.
 */
-var archive = new DirArchiver('path/to/directory', 'path/to/desination/zipfile.zip', excludes);
+var archive = new DirArchiver('path/to/directory', 'path/to/desination/zipfile.zip', true, excludes);
 
 // Create the zip file.
 archive.createZip();
@@ -35,12 +40,18 @@ archive.createZip();
 ## Command Line Interface
 
 ```sh
-Usage: dir-archiver --src <path-to-directory> --dest <path-to-file>.zip --exclude folder-name file-name.extention
+Usage: dir-archiver --src <path-to-directory> --dest <path-to-file>.zip --includebasedir true|false --exclude folder-name file-name.extention
 
 Options:
-  --src      The path of the folder to archive.
-  --dest     The path of the zip file to create.
-  --exclude  Specify a list with the names of the files and folders to exclude
+  --src             The path of the folder to archive.                            [string][required]
+  --dest            The path of the zip file to create.                           [string][required]
+  --includebasedir  Includes a base directory at the root of the archive.
+                    For example, if the root folder of your project is named
+                    "your-project", setting this option to true will create
+                    an archive that includes this base directory.
+                    If this option is set to false the archive created will
+                    unzip its content to the current directory.                               [bool]
+  --exclude         A list with the names of the files and folders to exclude.               [array]
 ```
 
 

package/cli.js

@@ -5,15 +5,22 @@ var DirArchiver = require('./index');
 const arguments = process.argv;
 var directoryPath = '';
 var zipPath = '';
+var includeBaseDirectory = true;
 var excludes = [];
 
 if ( ! arguments.includes( '--src' ) || ! arguments.includes( '--dest' ) ) {
     console.log(` Dir Archiver could not be executed. Some arguments are missing.
 
     Options:
-      --src      The path of the folder to archive.                          [string][required]
-      --dest     The path of the zip file to create.                         [string][required]
-      --exclude  A list with the names of the files and folders to exclude.             [array]`);
+      --src            The path of the folder to archive.                            [string][required]
+      --dest           The path of the zip file to create.                           [string][required]
+      --includebasedir Includes a base directory at the root of the archive.
+                       For example, if the root folder of your project is named
+                       "your-project", setting this option to true will create
+                       an archive that includes this base directory.
+                       If this option is set to false the archive created will
+                       unzip its content to the current directory.                               [bool]
+      --exclude        A list with the names of the files and folders to exclude.               [array]`);
     process.exit();
 }
 
@@ -24,6 +31,9 @@ for ( argumentIndex in arguments ) {
     if( arguments[argumentIndex] === '--dest' ) {
         zipPath = arguments[parseInt(argumentIndex) + 1];
     }
+    if( arguments[argumentIndex] === '--includebasedir' ) {
+        includeBaseDirectory = ( arguments[parseInt(argumentIndex) + 1] === 'true' );
+    }
     if( afterExclude === true ) {
         excludes.push( arguments[argumentIndex] );
     }
@@ -32,5 +42,5 @@ for ( argumentIndex in arguments ) {
     }
 }
 
-const archive = new DirArchiver(directoryPath, zipPath, excludes);
+const archive = new DirArchiver(directoryPath, zipPath, includeBaseDirectory, excludes);
 archive.createZip();

package/index.js

@@ -9,9 +9,10 @@ class DirArchiver {
      * The constructor. 
      * @param {string} directoryPath - the path of the folder to archive.
      * @param {string} zipPath - The path of the zip file to create.
+     * @param {Boolean} includeBaseDirectory - Includes a base directory at the root of the archive. For example, if the root folder of your project is named "your-project", setting includeBaseDirectory to true will create an archive that includes this base directory. If this option is set to false the archive created will unzip its content to the current directory.
      * @param {array} excludes - The name of the files and foldes to exclude.
      */
-    constructor(directoryPath, zipPath, excludes){
+    constructor(directoryPath, zipPath, includeBaseDirectory, excludes){
 
         // Contains the excluded files and folders.
         this.excludes = excludes;
@@ -19,6 +20,10 @@ class DirArchiver {
         this.directoryPath = directoryPath;
 
         this.zipPath = zipPath;
+
+        this.includeBaseDirectory = includeBaseDirectory;
+
+        this.baseDirectory = path.basename(path.resolve(directoryPath));
     }
 
     /**
@@ -32,9 +37,15 @@ class DirArchiver {
             const stats = fs.statSync( currentPath );
             let relativePath = path.relative(process.cwd(), currentPath);
             if ( stats.isFile() && ! this.excludes.includes( relativePath ) ) {
-                this.archive.file(currentPath, {
-                    name: `${relativePath}`
-                });
+                if( this.includeBaseDirectory === true) {
+                    this.archive.file(currentPath, {
+                        name: `${this.baseDirectory}/${relativePath}`
+                    });
+                } else {
+                    this.archive.file(currentPath, {
+                        name: `${relativePath}`
+                    });
+                }
             } else if ( stats.isDirectory() && ! this.excludes.includes( relativePath ) ) {
                 this.traverseDirectoryTree( currentPath );
             }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dir-archiver",
-  "version": "1.2.0",
+  "version": "2.0.0",
   "description": "Compress a whole directory (including subdirectories) into a zip file, with options to exclude specific files, or directories.",
   "license": "MIT",
   "main": "index.js",
@@ -32,6 +32,6 @@
   "bugs": "https://github.com/Ismail-elkorchi/dir-archiver/issues",
   "homepage": "https://github.com/Ismail-elkorchi/dir-archiver",
   "dependencies": {
-    "archiver": "^5.2.0"
+    "archiver": "^5.3.1"
   }
 }

package/CHANGELOG.md

@@ -1,28 +0,0 @@
-# Changes to Dir Archiver
-
-### 1.2.0 (February 28, 2021)
-
-* Bump archiver from 4.0.2 to 5.2.0.
-* Make exclude paths relative to run directory ([#4](https://github.com/Ismail-elkorchi/dir-archiver/pull/4))
-* Remove the destination zip if it exists already ([#7](https://github.com/Ismail-elkorchi/dir-archiver/pull/7))
-
-### 1.1.2 (July 21, 2020)
-
-* Bump lodash from 4.17.15 to 4.17.19.
-* Bump archiver from 4.0.1 to 4.0.2.
-
-### 1.1.1 (May 14, 2020)
-
-* CLI : prevent execution if the required arguments are missing.
-
-### 1.1.0 (May 13, 2020)
-
-* Add cli script.
-
-### 1.0.1 (May 12, 2020)
-
-* Fix the installation instructions.
-
-### 1.0.0 (May 12, 2020)
-
-* initial release.