dir-archiver 2.1.0 → 2.1.2

package/README.md

@@ -10,6 +10,8 @@ Compress a whole directory (including subdirectories) into a zip file, with opt
 $ npm install dir-archiver
 ```
 
+Requires Node.js >=14.
+
 # Usage
 
 ## API
@@ -35,7 +37,14 @@ const excludes = ['directory_name', 'file.extension'];
 var archive = new DirArchiver('path/to/directory', 'path/to/desination/zipfile.zip', true, excludes);
 
 // Create the zip file.
-archive.createZip();
+archive.createZip().then(() => {
+  console.log('Archive ready');
+}).catch((err) => {
+  console.error(err);
+});
+
+// Or with async/await:
+// await archive.createZip();
 ```
 ## Command Line Interface
 
@@ -54,6 +63,12 @@ Options:
   --exclude         A list with the names of the files and folders to exclude.               [array]
 ```
 
+# Testing
+
+```sh
+$ npm test
+```
+
 
 
 [changelog-image]: https://img.shields.io/badge/changelog-md-blue.svg?style=flat-square

package/cli.js

@@ -25,4 +25,7 @@ if ( directoryPath === false || zipPath === false ) {
 }
 
 const archive = new DirArchiver( directoryPath, zipPath, includeBaseDirectory, excludes );
-archive.createZip();
+archive.createZip().catch( ( err ) => {
+	console.error( err );
+	process.exitCode = 1;
+} );

package/index.js

@@ -15,7 +15,8 @@ class DirArchiver {
 	constructor( directoryPath, zipPath, includeBaseDirectory, excludes ) {
 
 		// Contains the excluded files and folders.
-		this.excludes = excludes.map( ( element ) => {
+		const safeExcludes = Array.isArray( excludes ) ? excludes : [];
+		this.excludes = safeExcludes.map( ( element ) => {
 			return path.normalize( element );
 		} );
 
@@ -26,6 +27,15 @@ class DirArchiver {
 		this.includeBaseDirectory = includeBaseDirectory;
 
 		this.baseDirectory = path.basename( this.directoryPath );
+
+		const relativeZipPath = path.relative( this.directoryPath, this.zipPath );
+		const isZipInsideSource = relativeZipPath && ! relativeZipPath.startsWith( '..' ) && ! path.isAbsolute( relativeZipPath );
+		if ( isZipInsideSource ) {
+			const normalizedZipPath = path.normalize( relativeZipPath );
+			if ( ! this.excludes.includes( normalizedZipPath ) ) {
+				this.excludes.push( normalizedZipPath );
+			}
+		}
 	}
 
 	/**
@@ -34,8 +44,11 @@ class DirArchiver {
 	 */
 	traverseDirectoryTree( directoryPath ) {
 		const files = fs.readdirSync( directoryPath );
-		for ( const i in files ) {
-			const currentPath = path.join( path.resolve( directoryPath ), files[ i ] );
+		for ( const file of files ) {
+			const currentPath = path.join( path.resolve( directoryPath ), file );
+			if ( path.resolve( currentPath ) === this.zipPath ) {
+				continue;
+			}
 			const stats = fs.statSync( currentPath );
 			let relativePath = path.relative( this.directoryPath, currentPath );
 			if ( stats.isFile() && ! this.excludes.includes( relativePath ) ) {
@@ -68,46 +81,73 @@ class DirArchiver {
 	}
 
 	createZip () {
-		// Remove the destination zip if it exists.
-		// see : https://github.com/Ismail-elkorchi/dir-archiver/issues/5
-		if ( fs.existsSync( this.zipPath ) ) {
-			fs.unlinkSync( this.zipPath );
-		}
-		// Create a file to stream archive data to.
-		this.output = fs.createWriteStream( this.zipPath );
-		this.archive = archiver( 'zip', {
-			zlib: { level: 9 }
-		} );
-
-		// Catch warnings during archiving.
-		this.archive.on( 'warning', function( err ) {
-			if ( err.code === 'ENOENT' ) {
-				// log warning
-				console.log( err );
-			} else {
-				// throw error
-				throw err;
+		return new Promise( ( resolve, reject ) => {
+			let settled = false;
+			const safeResolve = ( value ) => {
+				if ( settled ) {
+					return;
+				}
+				settled = true;
+				resolve( value );
+			};
+			const safeReject = ( err ) => {
+				if ( settled ) {
+					return;
+				}
+				settled = true;
+				reject( err );
+			};
+
+			// Remove the destination zip if it exists.
+			// see : https://github.com/Ismail-elkorchi/dir-archiver/issues/5
+			try {
+				if ( fs.existsSync( this.zipPath ) ) {
+					fs.unlinkSync( this.zipPath );
+				}
+			} catch ( err ) {
+				safeReject( err );
+				return;
 			}
-		} );
 
-		// Catch errors during archiving.
-		this.archive.on( 'error', function( err ) {
-			throw err;
-		} );
+			// Create a file to stream archive data to.
+			this.output = fs.createWriteStream( this.zipPath );
+			this.archive = archiver( 'zip', {
+				zlib: { level: 9 }
+			} );
+
+			// Catch warnings during archiving.
+			this.archive.on( 'warning', ( err ) => {
+				if ( err.code === 'ENOENT' ) {
+					// log warning
+					console.log( err );
+				} else {
+					safeReject( err );
+				}
+			} );
+
+			// Catch errors during archiving.
+			this.archive.on( 'error', ( err ) => {
+				safeReject( err );
+			} );
+
+			this.output.on( 'error', ( err ) => {
+				safeReject( err );
+			} );
 
-		// Pipe archive data to the file.
-		this.archive.pipe( this.output );
+			// Listen for all archive data to be written.
+			this.output.on( 'close', () => {
+				console.log( `Created ${this.zipPath} of ${this.prettyBytes( this.archive.pointer() )}` );
+				safeResolve( this.zipPath );
+			} );
 
-		// Recursively traverse the directory tree and append the files to the archive.
-		this.traverseDirectoryTree( this.directoryPath );
+			// Pipe archive data to the file.
+			this.archive.pipe( this.output );
 
-		// Finalize the archive.
-		this.archive.finalize();
+			// Recursively traverse the directory tree and append the files to the archive.
+			this.traverseDirectoryTree( this.directoryPath );
 
-		const self = this;
-		// Listen for all archive data to be written.
-		this.output.on( 'close', function () {
-			console.log( `Created ${self.zipPath} of ${self.prettyBytes( self.archive.pointer() )}` );
+			// Finalize the archive.
+			this.archive.finalize();
 		} );
 	}
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dir-archiver",
-  "version": "2.1.0",
+  "version": "2.1.2",
   "description": "Compress a whole directory (including subdirectories) into a zip file, with options to exclude specific files, or directories.",
   "license": "MIT",
   "main": "index.js",
@@ -34,14 +34,19 @@
   "homepage": "https://github.com/Ismail-elkorchi/dir-archiver",
   "scripts": {
     "lint": "eslint cli.js index.js",
-    "lint:fix": "eslint --fix cli.js index.js"
+    "lint:fix": "eslint --fix cli.js index.js",
+    "test": "node test/smoke.js"
+  },
+  "engines": {
+    "node": ">=14"
   },
   "dependencies": {
-    "archiver": "^5.3.1",
+    "archiver": "^7.0.1",
     "argv-flags": "^0.1.1"
   },
   "devDependencies": {
     "eslint": "^8.24.0",
-    "eslint-plugin-n": "^15.3.0"
+    "eslint-plugin-n": "^15.3.0",
+    "yauzl": "^3.2.0"
   }
 }