zcompress-vite-plugin 0.1.3 → 0.1.5

package/README.md

@@ -8,7 +8,7 @@ Vite 生产构建资源压缩插件 — gzip / zstd / brotli，多线程并行
 npm install zcompress-vite-plugin --save-dev
 ```
 
-安装后自动下载对应平台的 zcompress 二进制。如果下载失败，手动安装：
+安装后会自动下载对应平台的 `zcompress` 二进制。下载失败可手动安装：
 
 | 平台 | 命令 |
 |------|------|
@@ -35,17 +35,7 @@ export default {
 };
 ```
 
-`vite build` 后，`dist-compressed/` 目录下就是压缩后的文件：
-
-```
-dist-compressed/
-├── index.html.gz
-├── style.css.gz
-├── app.js.gz
-└── logo.svg.gz
-```
-
-配合 Nginx 的 `gzip_static on` 直接使用。
+`vite build` 后，`dist-compressed/` 目录下就是压缩后的文件。
 
 ## 选项
 
@@ -56,13 +46,42 @@ dist-compressed/
 | `threads` | `number` | `0` | 线程数 (0=CPU 核心数) |
 | `verbose` | `boolean` | `false` | 显示详细输出 |
 | `cache` | `boolean` | `false` | 跳过未修改文件 |
-| `include` | `string[]` | `[]` | 额外压缩的扩展名 (如 `['.ts']`) |
-| `exclude` | `string[]` | `[]` | 排除的扩展名 (如 `['.map']`) |
+| `include` | `string[]` | `[]` | 额外压缩扩展名 |
+| `exclude` | `string[]` | `[]` | 排除扩展名 |
 | `binaryPath` | `string` | 自动 | 手动指定二进制路径 |
+| `failOnError` | `boolean` | `true` | 压缩失败时让 `vite build` 失败 |
+
+## 故障排查
+
+### `postinstall` 下载二进制 404
+
+如果看到类似：
+
+```txt
+https://github.com/luochuan2008/zcompress/releases/download/vX.Y.Z/zcompress-macos-arm64 → 404
+```
+
+说明 npm 版本已发布，但对应 GitHub Release 还没上传该平台二进制。
 
-## 默认压缩的文件类型
+解决方式：
 
-`.js` `.mjs` `.cjs` `.css` `.html` `.htm` `.json` `.svg` `.png` `.jpg` `.jpeg` `.gif` `.ico` `.ttf` `.woff` `.woff2` `.xml` `.csv` `.wasm`
+1. 手动安装 CLI（上面安装表）
+2. 在插件里指定 `binaryPath`
+
+```js
+zcompress({
+  binaryPath: '/absolute/path/to/zcompress',
+})
+```
+
+也可用环境变量（不改代码）：
+
+```bash
+export ZCOMPRESS_BINARY=/absolute/path/to/zcompress
+npm run build
+```
+
+默认 `failOnError: true`，失败会直接中断构建（不会静默跳过压缩）。
 
 ## License
 
@@ -80,11 +99,16 @@ High-performance multi-threaded asset compression for Vite production builds. 5-
 npm install zcompress-vite-plugin --save-dev
 ```
 
-The correct platform binary is downloaded automatically. If that fails:
+The package auto-downloads a platform binary. If that fails, install/build manually:
 
 ```bash
-brew install zcompress          # macOS
-zig build install               # from source
+# macOS
+brew install zstd brotli
+zig build -Doptimize=ReleaseFast
+
+# Linux
+sudo apt-get install -y libzstd-dev libbrotli-dev
+zig build -Doptimize=ReleaseFast
 ```
 
 ## Usage
@@ -97,7 +121,7 @@ export default {
   plugins: [
     zcompress({
       algo: 'brotli',   // 'gzip' | 'zstd' | 'brotli'
-      level: 11,        // 1-9
+      level: 9,         // 1-9
       threads: 0,       // 0 = auto
       cache: true,      // skip unchanged files
     })
@@ -105,15 +129,7 @@ export default {
 };
 ```
 
-After `vite build`, find compressed assets in `dist-compressed/`:
-
-```
-dist-compressed/
-├── index.html.br
-├── style.css.br
-├── app.js.br
-└── logo.svg.br
-```
+After `vite build`, compressed assets are written to `dist-compressed/`.
 
 ## Options
 
@@ -127,6 +143,39 @@ dist-compressed/
 | `include` | `string[]` | `[]` | Extra extensions to compress |
 | `exclude` | `string[]` | `[]` | Extensions to skip |
 | `binaryPath` | `string` | auto | Override binary path |
+| `failOnError` | `boolean` | `true` | Fail `vite build` when compression fails |
+
+## Troubleshooting
+
+### `postinstall` binary download returns 404
+
+If you see:
+
+```txt
+https://github.com/luochuan2008/zcompress/releases/download/vX.Y.Z/zcompress-macos-arm64 → 404
+```
+
+that npm version exists, but the matching GitHub Release binary asset is missing.
+
+Workarounds:
+
+1. Install/build the CLI manually
+2. Set `binaryPath` explicitly
+
+```js
+zcompress({
+  binaryPath: '/absolute/path/to/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).
 
 ## License
 

package/index.d.ts

@@ -16,6 +16,8 @@ declare module 'zcompress-vite-plugin' {
     exclude?: string[];
     /** Override path to zcompress binary */
     binaryPath?: string;
+    /** Fail Vite build if compression fails (default: true) */
+    failOnError?: boolean;
   }
 
   import type { Plugin } from 'vite';

package/index.js

@@ -15,7 +15,7 @@
  * };
  */
 
-import { execSync } from 'node:child_process';
+import { execFileSync } from 'node:child_process';
 import { existsSync, statSync, readdirSync } from 'node:fs';
 import { join, dirname, isAbsolute } from 'node:path';
 import { fileURLToPath } from 'node:url';
@@ -32,6 +32,7 @@ const __dirname = dirname(fileURLToPath(import.meta.url));
  * @property {string[]} [include] - Extra file extensions to include
  * @property {string[]} [exclude] - File extensions to exclude
  * @property {string} [binaryPath] - Path to zcompress binary
+ * @property {boolean} [failOnError=true] - Fail Vite build if compression fails
  */
 
 /** @type {ZCompressOptions} */
@@ -43,18 +44,23 @@ const DEFAULT_OPTIONS = {
   cache: false,
   include: [],
   exclude: [],
+  failOnError: true,
 };
 
 /**
  * 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'),
@@ -63,7 +69,7 @@ function findBinary() {
     if (existsSync(p)) return p;
   }
 
-  // 3) PATH
+  // 4) PATH
   return 'zcompress';
 }
 
@@ -130,7 +136,7 @@ export default function zcompressPlugin(userOptions = {}) {
       const startTime = Date.now();
 
       try {
-        execSync(cmd, { stdio: 'inherit' });
+        execFileSync(binary, args, { stdio: 'inherit' });
         const elapsed = ((Date.now() - startTime) / 1000).toFixed(1);
 
         const srcSize = getDirSize(outDir);
@@ -141,8 +147,18 @@ export default function zcompressPlugin(userOptions = {}) {
 
         console.log(`[zcompress] ✅ Compressed ${formatSize(srcSize)} → ${formatSize(destSize)} (saved ${savedPct}%) in ${elapsed}s`);
       } catch (err) {
-        console.error(`[zcompress] ❌ Compression failed: ${err.message}`);
-        console.error('[zcompress] Make sure zcompress is installed: zig build install');
+        const message = [
+          `[zcompress] ❌ Compression failed: ${err.message}`,
+          `[zcompress] Binary used: ${binary}`,
+          '[zcompress] If this is a 404 download issue, GitHub Release may be missing prebuilt binaries for this version.',
+          '[zcompress] Workaround: install CLI manually (`zig build -Doptimize=ReleaseFast`) and set `binaryPath` in plugin options.',
+        ].join('\n');
+
+        if (options.failOnError !== false) {
+          throw new Error(message);
+        }
+
+        console.error(message);
       }
     },
   };

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,49 +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) {
-    console.log(`[zcompress] ⚠ Could not download binary (${err.message}). Build from source: cd zcompress && zig build install`);
-    // Clean up partial download
-    try { unlinkSync(destPath); } catch (_) { /* ignore */ }
+    // 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] ⚠ 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');
     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.3",
+  "version": "0.1.5",
   "description": "High-performance multi-threaded asset compression for Vite — powered by Zig",
   "type": "module",
   "main": "index.js",