zcompress-vite-plugin 0.1.4 → 0.1.6

package/README.md

@@ -74,8 +74,17 @@ zcompress({
 })
 ```
 
+也可用环境变量（不改代码）：
+
+```bash
+export ZCOMPRESS_BINARY=/absolute/path/to/zcompress
+npm run build
+```
+
 默认 `failOnError: true`，失败会直接中断构建（不会静默跳过压缩）。
 
+从 `v0.1.6` 开始：若找不到二进制，会自动启用 Node 内置 fallback（支持 `gzip` / `brotli`）。`zstd` 仍需 CLI 二进制。
+
 ## License
 
 MIT
@@ -161,8 +170,34 @@ zcompress({
 })
 ```
 
+Or use env var (no code change):
+
+```bash
+export ZCOMPRESS_BINARY=/absolute/path/to/zcompress
+npm run build
+```
+
 Default `failOnError: true` ensures builds fail loudly (instead of silently skipping compression).
 
+Since `v0.1.6`: if the binary is missing, the plugin automatically falls back to Node built-in compression for `gzip` / `brotli`. `zstd` still requires the CLI binary.
+
+## Maintainer Release Checklist
+
+Before running `npm publish`:
+
+1. Build and upload these assets to GitHub Release `vX.Y.Z`:
+   - `zcompress-macos-arm64`
+   - `zcompress-macos-x64`
+   - `zcompress-linux-x64`
+   - `zcompress-windows-x64.exe`
+2. Run:
+
+```bash
+npm run verify:release-assets
+```
+
+`prepublishOnly` enforces this automatically, so broken releases are blocked.
+
 ## License
 
 MIT

package/index.js

@@ -16,12 +16,18 @@
  */
 
 import { execFileSync } from 'node:child_process';
-import { existsSync, statSync, readdirSync } from 'node:fs';
-import { join, dirname, isAbsolute } from 'node:path';
+import { existsSync, statSync, readdirSync, readFileSync, writeFileSync, mkdirSync } from 'node:fs';
+import { join, dirname, isAbsolute, extname } from 'node:path';
 import { fileURLToPath } from 'node:url';
+import { gzipSync, brotliCompressSync, constants as zlibConstants } from 'node:zlib';
 
 const __dirname = dirname(fileURLToPath(import.meta.url));
 
+const DEFAULT_EXTENSIONS = [
+  '.js', '.mjs', '.cjs', '.css', '.html', '.htm', '.json', '.svg',
+  '.png', '.jpg', '.jpeg', '.gif', '.ico', '.ttf', '.woff', '.woff2', '.xml', '.csv', '.wasm',
+];
+
 /**
  * @typedef {Object} ZCompressOptions
  * @property {string} [algo='gzip'] - Compression algorithm: gzip, zstd, brotli
@@ -49,14 +55,18 @@ const DEFAULT_OPTIONS = {
 
 /**
  * Find the zcompress binary.
- * Order: 1) downloaded by postinstall 2) local zig build 3) PATH
+ * Order: 1) ZCOMPRESS_BINARY env 2) downloaded by postinstall 3) local zig build 4) PATH
  */
 function findBinary() {
-  // 1) postinstall-downloaded binary inside package
+  // 1) explicit env override
+  const envBinary = process.env.ZCOMPRESS_BINARY;
+  if (envBinary) return envBinary;
+
+  // 2) postinstall-downloaded binary inside package
   const packagedBin = join(__dirname, 'bin', process.platform === 'win32' ? 'zcompress.exe' : 'zcompress');
   if (existsSync(packagedBin)) return packagedBin;
 
-  // 2) local zig build
+  // 3) local zig build
   const zigPaths = [
     join(process.cwd(), 'zig-out', 'bin', 'zcompress'),
     join(process.cwd(), 'zig-out', 'bin', 'zcompress.exe'),
@@ -65,7 +75,7 @@ function findBinary() {
     if (existsSync(p)) return p;
   }
 
-  // 3) PATH
+  // 4) PATH
   return 'zcompress';
 }
 
@@ -143,6 +153,33 @@ export default function zcompressPlugin(userOptions = {}) {
 
         console.log(`[zcompress] ✅ Compressed ${formatSize(srcSize)} → ${formatSize(destSize)} (saved ${savedPct}%) in ${elapsed}s`);
       } catch (err) {
+        // Binary missing: fallback to built-in Node compression for gzip/brotli.
+        if (isBinaryNotFoundError(err)) {
+          try {
+            const fb = fallbackCompressAssets(outDir, compressedDir, options);
+            const elapsed = ((Date.now() - startTime) / 1000).toFixed(1);
+            const savedPct = fb.srcSize > 0
+              ? ((1 - fb.destSize / fb.srcSize) * 100).toFixed(1)
+              : '0.0';
+
+            console.warn('[zcompress] ⚠ zcompress binary not found, using built-in Node fallback compressor.');
+            console.log(`[zcompress] ✅ Compressed ${formatSize(fb.srcSize)} → ${formatSize(fb.destSize)} (saved ${savedPct}%) in ${elapsed}s`);
+            if (fb.skipped > 0) console.log(`[zcompress] 💾 ${fb.skipped} file(s) skipped (cache)`);
+            return;
+          } catch (fallbackErr) {
+            const fallbackMessage = [
+              `[zcompress] ❌ Compression failed: ${err.message}`,
+              `[zcompress] Binary used: ${binary}`,
+              `[zcompress] Fallback also failed: ${fallbackErr.message}`,
+              '[zcompress] Workaround: install CLI manually (`zig build -Doptimize=ReleaseFast`) and set `binaryPath`.',
+            ].join('\n');
+
+            if (options.failOnError !== false) throw new Error(fallbackMessage);
+            console.error(fallbackMessage);
+            return;
+          }
+        }
+
         const message = [
           `[zcompress] ❌ Compression failed: ${err.message}`,
           `[zcompress] Binary used: ${binary}`,
@@ -160,6 +197,81 @@ export default function zcompressPlugin(userOptions = {}) {
   };
 }
 
+function isBinaryNotFoundError(err) {
+  return err && (err.code === 'ENOENT' || String(err.message || '').includes('ENOENT'));
+}
+
+function shouldCompressFile(filePath, options) {
+  const ext = extname(filePath).toLowerCase();
+  const include = options.include.length > 0
+    ? options.include.map((e) => e.toLowerCase())
+    : DEFAULT_EXTENSIONS;
+  const exclude = options.exclude.map((e) => e.toLowerCase());
+
+  if (!include.includes(ext)) return false;
+  if (exclude.includes(ext)) return false;
+  return true;
+}
+
+function compressionSuffix(algo) {
+  if (algo === 'gzip') return '.gz';
+  if (algo === 'brotli') return '.br';
+  throw new Error('Node fallback currently supports only gzip and brotli. Use CLI binary for zstd.');
+}
+
+function compressBuffer(buf, options) {
+  if (options.algo === 'gzip') {
+    const level = Math.max(1, Math.min(9, Number(options.level) || 6));
+    return gzipSync(buf, { level });
+  }
+  if (options.algo === 'brotli') {
+    const quality = Math.max(1, Math.min(11, Number(options.level) || 6));
+    return brotliCompressSync(buf, {
+      params: {
+        [zlibConstants.BROTLI_PARAM_QUALITY]: quality,
+      },
+    });
+  }
+  throw new Error('Node fallback currently supports only gzip and brotli.');
+}
+
+function fallbackCompressAssets(outDir, compressedDir, options) {
+  const allFiles = [];
+  walkDir(outDir, (file) => allFiles.push(file));
+
+  const suffix = compressionSuffix(options.algo);
+  let srcSize = 0;
+  let destSize = 0;
+  let skipped = 0;
+
+  for (const file of allFiles) {
+    if (!shouldCompressFile(file, options)) continue;
+
+    const rel = file.slice(outDir.length + 1);
+    const dest = join(compressedDir, `${rel}${suffix}`);
+
+    const srcStat = statSync(file);
+    if (options.cache && existsSync(dest)) {
+      const dstStat = statSync(dest);
+      if (dstStat.mtimeMs >= srcStat.mtimeMs) {
+        skipped++;
+        continue;
+      }
+    }
+
+    const data = readFileSync(file);
+    const compressed = compressBuffer(data, options);
+
+    mkdirSync(dirname(dest), { recursive: true });
+    writeFileSync(dest, compressed);
+
+    srcSize += srcStat.size;
+    destSize += compressed.length;
+  }
+
+  return { srcSize, destSize, skipped };
+}
+
 /**
  * Calculate total directory size in bytes.
  *

package/install.js

@@ -2,7 +2,7 @@
 
 /**
  * Postinstall script — downloads the prebuilt zcompress binary from GitHub Releases.
- * Falls back gracefully if the binary can't be downloaded (e.g. air-gapped, unsupported platform).
+ * Falls back gracefully if binary can't be fetched.
  */
 
 import { createWriteStream, existsSync, chmodSync, mkdirSync, unlinkSync, readFileSync } from 'node:fs';
@@ -20,10 +20,10 @@ const pkgJson = JSON.parse(readFileSync(join(__dirname, 'package.json'), 'utf8')
 const VERSION = pkgJson.version;
 
 const PLATFORM_MAP = {
-  'darwin-arm64':  'zcompress-macos-arm64',
-  'darwin-x64':    'zcompress-macos-x64',
-  'linux-x64':     'zcompress-linux-x64',
-  'win32-x64':     'zcompress-windows-x64.exe',
+  'darwin-arm64': 'zcompress-macos-arm64',
+  'darwin-x64': 'zcompress-macos-x64',
+  'linux-x64': 'zcompress-linux-x64',
+  'win32-x64': 'zcompress-windows-x64.exe',
 };
 
 function getPlatformKey() {
@@ -33,8 +33,54 @@ function getPlatformKey() {
 }
 
 function getBinaryName() {
-  const key = getPlatformKey();
-  return PLATFORM_MAP[key] || null;
+  return PLATFORM_MAP[getPlatformKey()] || null;
+}
+
+function request(url) {
+  return new Promise((resolve, reject) => {
+    get(url, {
+      headers: {
+        'User-Agent': 'zcompress-vite-plugin-install',
+        Accept: 'application/vnd.github+json',
+      },
+    }, (res) => resolve(res)).on('error', reject);
+  });
+}
+
+async function fetchJson(url) {
+  const res = await request(url);
+  if (res.statusCode !== 200) {
+    throw new Error(`HTTP ${res.statusCode}`);
+  }
+  const chunks = [];
+  for await (const chunk of res) chunks.push(chunk);
+  return JSON.parse(Buffer.concat(chunks).toString('utf8'));
+}
+
+async function downloadToFile(url, destPath) {
+  const res = await request(url);
+
+  // Follow redirect (GitHub release assets usually 302)
+  if (res.statusCode >= 300 && res.statusCode < 400 && res.headers.location) {
+    return downloadToFile(res.headers.location, destPath);
+  }
+
+  if (res.statusCode !== 200) {
+    throw new Error(`HTTP ${res.statusCode}`);
+  }
+
+  const file = createWriteStream(destPath);
+  await pipeline(res, file);
+}
+
+async function resolveFallbackAssetUrl(binaryName) {
+  // Fallback strategy: use latest release asset for this platform when current version asset is missing.
+  const latest = await fetchJson(`https://api.github.com/repos/${REPO}/releases/latest`);
+  const asset = (latest.assets || []).find((a) => a.name === binaryName);
+  if (!asset?.browser_download_url) {
+    throw new Error('Latest release has no matching asset');
+  }
+  return asset.browser_download_url;
 }
 
 async function downloadBinary() {
@@ -52,56 +98,55 @@ async function downloadBinary() {
     return true;
   }
 
-  const url = `https://github.com/${REPO}/releases/download/v${VERSION}/${binaryName}`;
-  console.log(`[zcompress] ↓ Downloading ${url} ...`);
+  mkdirSync(BIN_DIR, { recursive: true });
 
+  const versionedUrl = `https://github.com/${REPO}/releases/download/v${VERSION}/${binaryName}`;
+  const tried = [];
+
+  // Attempt 1: exact npm version
   try {
-    mkdirSync(BIN_DIR, { recursive: true });
-
-    await new Promise((resolve, reject) => {
-      const file = createWriteStream(destPath);
-      get(url, (response) => {
-        // Follow redirects
-        if (response.statusCode >= 300 && response.statusCode < 400 && response.headers.location) {
-          get(response.headers.location, (redirectRes) => {
-            pipeline(redirectRes, file).then(resolve).catch(reject);
-          }).on('error', reject);
-          return;
-        }
-        if (response.statusCode !== 200) {
-          file.close();
-          unlinkSync(destPath);
-          reject(new Error(`HTTP ${response.statusCode}`));
-          return;
-        }
-        pipeline(response, file).then(resolve).catch(reject);
-      }).on('error', reject);
-    });
-
-    // Make executable on Unix
-    if (process.platform !== 'win32') {
-      chmodSync(destPath, 0o755);
-    }
+    tried.push(versionedUrl);
+    console.log(`[zcompress] ↓ Downloading ${versionedUrl} ...`);
+    await downloadToFile(versionedUrl, destPath);
 
+    if (process.platform !== 'win32') chmodSync(destPath, 0o755);
     console.log(`[zcompress] ✓ Binary installed: ${destPath}`);
     return true;
   } catch (err) {
-    if (String(err.message).includes('HTTP 404')) {
-      console.log(`[zcompress] ⚠ Release asset not found for v${VERSION}: ${binaryName}`);
-      console.log(`[zcompress] ⚠ Expected URL: ${url}`);
-      console.log('[zcompress] ⚠ This usually means the npm version was published before uploading binary assets to GitHub Releases.');
+    // cleanup partial
+    try { unlinkSync(destPath); } catch {}
+
+    // If 404 or similar, try latest release as fallback
+    const msg = String(err?.message || err);
+    if (!msg.includes('404')) {
+      console.log(`[zcompress] ⚠ Download failed (${msg}).`);
     } else {
-      console.log(`[zcompress] ⚠ Could not download binary (${err.message}).`);
+      console.log(`[zcompress] ⚠ Asset missing for v${VERSION}: ${binaryName}`);
     }
+  }
+
+  // Attempt 2: latest release fallback
+  try {
+    const latestAssetUrl = await resolveFallbackAssetUrl(binaryName);
+    tried.push(latestAssetUrl);
+    console.log(`[zcompress] ↓ Falling back to latest release asset: ${latestAssetUrl}`);
+    await downloadToFile(latestAssetUrl, destPath);
+
+    if (process.platform !== 'win32') chmodSync(destPath, 0o755);
+    console.log(`[zcompress] ✓ Binary installed from latest release: ${destPath}`);
+    return true;
+  } catch (err) {
+    try { unlinkSync(destPath); } catch {}
+    console.log(`[zcompress] ⚠ Fallback download failed (${err.message}).`);
+    console.log('[zcompress] Tried URLs:');
+    for (const u of tried) console.log(`  - ${u}`);
     console.log('[zcompress] ℹ Build from source: cd zcompress && zig build -Doptimize=ReleaseFast');
-    // Clean up partial download
-    try { unlinkSync(destPath); } catch (_) { /* ignore */ }
     return false;
   }
 }
 
 // Run download, but don't fail install if it doesn't work
-downloadBinary().catch(() => {
-  console.log('[zcompress] ℹ Binary download skipped. The plugin requires the zcompress CLI.');
-  console.log('[zcompress] ℹ Install it via: brew install zcompress  OR  zig build install');
+downloadBinary().catch((err) => {
+  console.log(`[zcompress] ⚠ Binary download skipped (${err.message}).`);
+  console.log('[zcompress] ℹ Install it manually and set plugin option `binaryPath`.');
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zcompress-vite-plugin",
-  "version": "0.1.4",
+  "version": "0.1.6",
   "description": "High-performance multi-threaded asset compression for Vite — powered by Zig",
   "type": "module",
   "main": "index.js",
@@ -13,7 +13,9 @@
   ],
   "scripts": {
     "postinstall": "node install.js",
-    "test": "node test.js"
+    "test": "node test.js",
+    "verify:release-assets": "node verify-release-assets.js",
+    "prepublishOnly": "node verify-release-assets.js --warn-only"
   },
   "keywords": [
     "vite",