(Ruby) 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.

Chilkat Ruby Downloads install from rubygems.org gem install chilkat or download... Ruby Library for Windows, MacOS, Linux, Alpine Linux

require 'chilkat'

success = false

success = false

zip = Chilkat::CkZip.new()

success = zip.NewZip("project.zip")
if (success == false)
    print zip.lastErrorText() + "\n";
    exit
end

# 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.
recurse = true
saveExtraPath = true
archiveOnly = false
includeHidden = true
includeSystem = false

success = zip.AppendFilesEx("c:/project",recurse,saveExtraPath,archiveOnly,includeHidden,includeSystem)
if (success == false)
    print zip.lastErrorText() + "\n";
    exit
end

# Write the ZIP archive.
success = zip.WriteZipAndClose()
if (success == false)
    print zip.lastErrorText() + "\n";
    exit
end

print "ZIP archive created successfully." + "\n";