zcompress-vite-plugin 0.1.3 → 0.1.4

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,35 @@ 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
+```
 
-`.js` `.mjs` `.cjs` `.css` `.html` `.htm` `.json` `.svg` `.png` `.jpg` `.jpeg` `.gif` `.ico` `.ttf` `.woff` `.woff2` `.xml` `.csv` `.wasm`
+说明 npm 版本已发布，但对应 GitHub Release 还没上传该平台二进制。
+
+解决方式：
+
+1. 手动安装 CLI（上面安装表）
+2. 在插件里指定 `binaryPath`
+
+```js
+zcompress({
+  binaryPath: '/absolute/path/to/zcompress',
+})
+```
+
+默认 `failOnError: true`，失败会直接中断构建（不会静默跳过压缩）。
 
 ## License
 
@@ -80,11 +92,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 +114,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 +122,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 +136,32 @@ 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',
+})
+```
+
+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,6 +44,7 @@ const DEFAULT_OPTIONS = {
   cache: false,
   include: [],
   exclude: [],
+  failOnError: true,
 };
 
 /**
@@ -130,7 +132,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 +143,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

@@ -86,7 +86,14 @@ async function downloadBinary() {
     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`);
+    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.');
+    } else {
+      console.log(`[zcompress] ⚠ Could not download binary (${err.message}).`);
+    }
+    console.log('[zcompress] ℹ Build from source: cd zcompress && zig build -Doptimize=ReleaseFast');
     // Clean up partial download
     try { unlinkSync(destPath); } catch (_) { /* ignore */ }
     return false;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zcompress-vite-plugin",
-  "version": "0.1.3",
+  "version": "0.1.4",
   "description": "High-performance multi-threaded asset compression for Vite — powered by Zig",
   "type": "module",
   "main": "index.js",