(Node.js) Exclude Multiple Directories When Adding Files to a ZIP

See more Zip Examples

This example demonstrates how to use the ExcludeDir method to exclude specific directory names when recursively adding files to a ZIP archive.

The ExcludeDir method excludes directories by name. Any directory matching an excluded name is skipped entirely, including all files and subdirectories beneath it.

This is useful for excluding directories such as:

• .git
• node_modules
• bin
• obj
• Temporary or cache directories

Call ExcludeDir once for each directory name to exclude.

Suppose the local filesystem contains:

c:/project/src/main.cpp
c:/project/src/util.cpp
c:/project/bin/app.exe
c:/project/obj/main.obj
c:/project/.git/config
c:/project/node_modules/library/index.js

After excluding bin, obj, .git, and node_modules, only the files beneath src are added to the ZIP archive.

The resulting ZIP archive contains:

project/src/main.cpp
project/src/util.cpp

Note: This example requires Chilkat v11.0.0 or greater.

Install Chilkat for Node.js and Electron using npm at Chilkat npm packages for Node.js Chilkat npm packages for Electron on Windows, Linux, MacOS

var os = require('os');
if (os.platform() == 'win32') {  
  var chilkat = require('@chilkat/ck-node23-win64'); 
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node23-linux-arm');
    } else if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node23-linux-arm64');
    } else {
        var chilkat = require('@chilkat/ck-node23-linux-x64');
    }
} else if (os.platform() == 'darwin') {
  var chilkat = require('@chilkat/ck-node23-mac-universal');
}

function chilkatExample() {

    var success = false;

    success = false;

    var zip = new chilkat.Zip();

    success = zip.NewZip("project.zip");
    if (success == false) {
        console.log(zip.LastErrorText);
        return;
    }

    // Exclude several directory names.
    // 
    // Any directory matching one of these names will be skipped
    // during recursive file appending.
    zip.ExcludeDir("bin");
    zip.ExcludeDir("obj");
    zip.ExcludeDir(".git");
    zip.ExcludeDir("node_modules");

    // Recursively append all files beneath c:/project.
    // 
    // Because saveExtraPath = true, the ZIP paths will
    // include "project/" as the leading directory.
    var recurse = true;
    var saveExtraPath = true;
    var archiveOnly = false;
    var includeHidden = true;
    var includeSystem = false;

    success = zip.AppendFilesEx("c:/project",recurse,saveExtraPath,archiveOnly,includeHidden,includeSystem);
    if (success == false) {
        console.log(zip.LastErrorText);
        return;
    }

    // Write the ZIP archive.
    success = zip.WriteZipAndClose();
    if (success == false) {
        console.log(zip.LastErrorText);
        return;
    }

    console.log("ZIP archive created successfully.");

}

chilkatExample();