parcel-bundler/parcel

Support ZSTD Compressor

Open

#10014 opened on Nov 18, 2024

View on GitHub
 (0 comments) (0 reactions) (0 assignees)JavaScript (44,030 stars) (2,274 forks)batch import
:raising_hand_woman: FeatureGood First Issue

Description

🙋 Feature Request

Support a zstd compressor.

🔦 Context

Currently, gzip and brotli compressors are supported, for producing .gz and .br files for text assets. As of 8 months ago, chrome now supports zstd-compressed assets.

It would be nice if a zstd compressor could be supported as well, to benefit from this. Of course, doing so also depends on how the website is being served, but that is out of scope for parcel.

Contributor guide

Tech stack
javascriptnodejs
Domain
frontendbuild systemtooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Node.jsUnderstanding of Parcel's compression APIFamiliarity with zstd library
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
The issue requests adding ZSTD compression support similar to existing gzip and brotli compressors. Start by examining the current compressor implementations in Parcel's source code, likely in the 'packagers' directory. Look for classes like 'GzipCompressor' or 'BrotliCompressor' to understand the interface. Then implement a 'ZstdCompressor' using a Node.js compatible zstd library (e.g., '@mongodb js/zstd' or 'node zstd'). Ensure it produces .zst files and integrates with Parcel's asset pipeline. Finally, run the existing tests and consider adding new tests for ZSTD.