Add directory support to the CLI via SQAR archive streams - #1
Merged
Conversation
Extend `squish c`/`d`/`s` to accept a directory as well as a single file. A directory is serialized into a single SQAR archive stream (files, subdirectories, empty directories, and unix permission bits) and compressed as one unit; decompression detects the archive and recreates the tree under the output path. The compression engine and libsquish ABI are untouched — the archive format is a CLI-level wrapper compressed as an ordinary SQ02/SQ01 stream. Single-file compression is unchanged and byte-for-byte compatible with earlier releases; auto-detection on decompress keys off the SQAR magic. Extraction rejects absolute paths and `..` traversal, and entries are stored sorted so archives depend only on the tree, not on filesystem iteration order. Documented as docs/FORMAT.md §12; CI gains directory round-trip steps (including empty-dir and SFX-directory checks) on the Linux and Windows-MSVC jobs. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Extend
squish c/d/sto accept a directory as well as a single file. A directory is serialized into a single SQAR archive stream (files, subdirectories, empty directories, and unix permission bits) and compressed as one unit; decompression detects the archive and recreates the tree under the output path.The compression engine and libsquish ABI are untouched — the archive format is a CLI-level wrapper compressed as an ordinary SQ02/SQ01 stream. Single-file compression is unchanged and byte-for-byte compatible with earlier releases; auto-detection on decompress keys off the SQAR magic. Extraction rejects absolute paths and
..traversal, and entries are stored sorted so archives depend only on the tree, not on filesystem iteration order.Documented as docs/FORMAT.md §12; CI gains directory round-trip steps (including empty-dir and SFX-directory checks) on the Linux and Windows-MSVC jobs.
Summary
Format impact
bumped (see docs/FORMAT.md)
Testing
make testpassesbench/run_squish.py) with before/after numbers, ifthis touches compression ratio or speed:
Checklist
-Wall -Wextra(default Makefile flags)squish.handdocs/API.md