Need to ZIP an entire directory using Node js

Question

I need to zip an entire directory using Node js  I m currently using node-zip and each time the process runs it generates an invalid ZIP file  as you can see from this Github issue    Is there another  better  Node js option that will allow me to ZIP up a directory   EDIT  I ended up using archiver  writeZip   function dir name    var zip   new JSZip        code   zip folder dir       output   zip generate        filename     jsd-  name   zip   join       fs writeFileSync baseDir   filename  output   console log  creating     filename        sample value for parameters   dir    tmp jsd- lt randomstring gt   name    lt randomstring gt    UPDATE  For those asking about the implementation I used  here s a link to my downloader

User · Answer

To include all files and directories   archive bulk           expand  true      cwd   temp freewheel-bvi-120       src                dot  true           It uses node-glob https   github com isaacs node-glob  underneath  so any matching expression compatible with that will work

User · Answer

To pipe the result to the response object  scenarios where there is a need to download the zip rather than store locally        archive pipe res     Sam s hints for accessing the content of the directory worked for me    src

User · Answer

I ended up using archiver lib  Works great  Example var file system   require  fs    var archiver   require  archiver     var output   file system createWriteStream  target zip    var archive   archiver  zip     output on  close   function          console log archive pointer       total bytes        console log  archiver has been finalized and the output file descriptor has closed          archive on  error   function err       throw err       archive pipe output       append files from a sub-directory  putting its contents at the root of archive archive directory source dir  false       append files from a sub-directory and naming it  new-subdir  within the archive archive directory  subdir     new-subdir     archive finalize

User · Answer

I have found this small library that encapsulates what you need    npm install zip-a-folder  const zip-a-folder   require  zip-a-folder    await zip-a-folder zip   path to the folder     path to archive zip      https   www npmjs com package zip-a-folder

User · Answer

Use Node s native child process api to accomplish this   No need for third party libs  Two lines of code    const child process   require  child process    child process execSync  zip -r DESIRED NAME OF ZIP FILE HERE         cwd  PATH TO FOLDER YOU WANT ZIPPED HERE       I m using the synchronous API  You can use child process exec path  options  callback  if you need async  There are a lot more options than just specifying the CWD to  further finetune your requests  See exec execSync docs     Please note   This example assumes you have the zip utility installed on your system  it comes with OSX  at least   Some operating systems may not have utility installed  i e   AWS Lambda runtime doesn t   In that case  you can easily obtain the zip utility binary here and package it along with your application source code  for AWS Lambda you can package it in a Lambda Layer as well   or you ll have to either use a third party module  of which there are plenty on NPM   I prefer the former approach  as the ZIP utility is tried and tested for decades

User · Answer

I do not pretend to show something new  just want to summarize solutions above for those who likes to use Promise functions in their code  like me    const archiver   require  archiver             param  String  source     param  String  out     returns  Promise      function zipDirectory source  out      const archive   archiver  zip     zlib    level  9        const stream   fs createWriteStream out      return new Promise  resolve  reject    gt        archive        directory source  false         on  error   err   gt  reject err          pipe stream             stream on  close        gt  resolve         archive finalize              Hope it will help someone

User · Answer

Since archiver is not compatible with the new version of webpack for a long time  I recommend using zip-lib   var zl   require  zip-lib     zl archiveFolder  path to folder    path to target zip   then function          console log  done       function  err        console log err

User · Answer

This is another library which zips the folder in one line    zip-local  var zipper   require  zip-local     zipper sync zip    hello world    compress   save  pack zip

User · Answer

You can try in a simple way   Install zip-dir    npm install zip-dir   and use it  var zipdir   require  zip-dir     let foldername    src path split      pop        zipdir  lt  lt src path gt  gt     saveTo   demo zip     function  err  buffer

User · Answer

Archive bulk is now deprecated  the new method to be used for this is glob   var fileName      zipOutput zip  var fileOutput   fs createWriteStream fileName    fileOutput on  close   function          console log archive pointer       total bytes        console log  archiver has been finalized and the output file descriptor has closed          archive pipe fileOutput   archive glob     dist           some glob pattern here archive glob     dist  htaccess      another glob pattern    add as many as you like archive on  error   function err       throw err      archive finalize

User · Answer

I ended up wrapping archiver to emulate JSZip  as refactoring through my project woult take too much effort  I understand Archiver might not be the best choice  but here you go      USAGE  const zip JSZipStream to myFileLocation       onDone     gt          onError     gt       zip file  something txt   My content    zip folder  myfolder   file  something-inFolder txt   My content    zip finalize        NodeJS file content      var fs   require  fs        var path   require  path        var archiver   require  archiver       function zipper archive  settings        return           output  null          streamToFile dir                const output   fs createWriteStream dir               this output   output              archive pipe output                return this                     file location  content                if  settings location                    location   path join settings location  location                             archive append content    name  location                 return this                     folder location                if  settings location                    location   path join settings location  location                             return zipper archive    location  location                        finalize                 archive finalize                return this                     onDone method                this output on  close   method               return this                     onError method                this output on  error   method               return this                      exports JSzipStream         to destination            console log  stream to  destination          const archive   archiver  zip                 zlib    level  9      Sets the compression level                      return zipper archive      streamToFile destination

User · Answer

Adm-zip has problems just compressing an existing archive https   github com cthackers adm-zip issues 64 as well as corruption with compressing binary files   I ve also ran into compression corruption issues with node-zip https   github com daraosn node-zip issues 4  node-archiver is the only one that seems to work well to compress but it doesn t have any uncompress functionality

[node.js] Need to ZIP an entire directory using Node.js

Examples related to node.js

Examples related to zip