ProjectZipper class abstract final

ProjectZipper is a class that zips a project directory. It is used to prepare a project for deployment to the cloud.

Files included in the zip are all non-ignored files in the project directory. The zip is created in memory and returned as a list of bytes.

Files that are ignored are determined by the presence of a .gitignore or .scloudignore file in the project directory.

The zipProject method is the main entry point for this class.

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

stripRoot(String rootPath, String fullPath) → String
toArchiveEntryName(String relativePath, {Context? pathContext}) → String
Converts a platform-native relative path to a zip archive entry name. Entry names are always posix (/) separated, per the zip specification.
zipProject({required CommandLogger logger, required Directory rootDirectory, Iterable<String> beneath = const ['.'], int fileReadPoolSize = 5, bool showFiles = false, Future<String?> fileContentModifier(String relativePath, Future<String> contentReader())?, bool excludeFile(String relativePath)?}) → Future<List<int>>
Zips a project directory. Returns a list of bytes representing the zipped project. Archive entry names are always posix (/) separated, regardless of platform.