compressing feat: support xz

closes https://github.com/node-modules/compressing/issues/96

All codes gen by cursor

Summary by CodeRabbit

New Features
- Added support for the "xz" compression format, enabling compression and decompression of files and streams using xz/LZMA.
- Extended the API with xz-specific methods and streaming interfaces for file compression and decompression.
Documentation
- Updated documentation to include xz support, with usage examples and API references.
Tests
- Added tests to verify xz compression and decompression functionality across various input types.

May 24 '25 03:05 fengmk2

[!WARNING]

Rate limit exceeded

@fengmk2 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 9 minutes and 5 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between b16735515fef191a81067eacb3d0a18e672caad2 and d6a07f001ef601f1f29d6480d70f19c1493b3c13.

📒 Files selected for processing (2)

lib/xz/uncompress_stream.js (1 hunks)

test/xz/file_stream.test.js (1 hunks)

Walkthrough

Support for the XZ compression format has been added. This includes new APIs, streaming classes, and documentation for compressing and decompressing files and streams using XZ/LZMA. The package now depends on lzma-native, and comprehensive tests for XZ functionality are included.

Changes

File(s)	Change Summary
README.md	Documented XZ format support, usage examples, API, and options.
index.d.ts	Declared `xz` namespace, functions, and stream classes for XZ compression/decompression.
index.js, lib/xz/index.js	Exported XZ API and stream classes; wired up file processing functions for XZ.
lib/xz/file_stream.js, lib/xz/uncompress_stream.js	Implemented `XzFileStream` and `XzUncompressStream` for XZ compression and decompression streams.
package.json	Added `lzma-native` dependency.
test/xz/file_stream.test.js	Added tests for XZ compression and decompression covering files, buffers, and streams.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant XzAPI as xz.compressFile / xz.uncompress
    participant FileStream as XzFileStream / XzUncompressStream
    participant lzma as lzma-native
    participant FS as File System

    User->>XzAPI: Call compressFile(source, dest, opts)
    XzAPI->>FileStream: Instantiate with source, opts
    FileStream->>lzma: Create compressor/decompressor stream
    FileStream->>FS: Read from source (file/buffer/stream)
    FS-->>FileStream: Source data
    FileStream->>lzma: Pipe data through compressor/decompressor
    lzma-->>FileStream: Compressed/decompressed data
    FileStream->>FS: Write to destination
    FS-->>User: Result (Promise resolved)

Assessment against linked issues

Objective (Issue #)	Addressed	Explanation
Add `.xz` support for compression and decompression (#96)	✅

Poem

A hop and a zip, now XZ joins the crew,
With streams and buffers, it knows what to do!
LZMA magic, in files big and small,
Compress, decompress—now we handle it all.
🐇✨
Hooray for new formats, the rabbit’s delight,
With XZ support, the future is bright!

✨ Finishing Touches

[ ] 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json