oxc-minify 0.56.5 → 0.58.0

package/README.md

@@ -1,3 +1,49 @@
 # Oxc Minify
 
 This is alpha software and may yield incorrect results, feel free to [submit a bug report](https://github.com/oxc-project/oxc/issues/new?assignees=&labels=C-bug&projects=&template=bug_report.md).
+
+### Performance and Compression Size
+
+See [minification-benchmarks](https://github.com/privatenumber/minification-benchmarks) for details.
+
+The current version already outperforms `esbuild`,
+but it still lacks a few key minification techniques
+such as constant inlining and dead code removal,
+which we plan to implement next.
+
+## Caveats
+
+To maximize performance, `oxc-minify` assumes the input code is semantically correct.
+It uses `oxc-parser`'s fast mode to parse the input code,
+which does not check for semantic errors related to symbols and scopes.
+
+## API
+
+```javascript
+import { minify } from 'oxc-minify';
+
+const filename = 'test.js';
+const code = "const x = 'a' + 'b'; console.log(x);";
+const options = {
+  compress: {
+    target: 'esnext',
+  },
+  mangle: {
+    toplevel: false,
+  },
+  codegen: {
+    removeWhitespace: true,
+  },
+  sourcemap: true,
+};
+const result = minify(filename, code, options);
+
+console.log(result.code);
+console.log(result.map);
+```
+
+## Assumptions
+
+`oxc-minify` makes some assumptions about the source code.
+
+See https://github.com/oxc-project/oxc/blob/main/crates/oxc_minifier/README.md#assumptions for details.

package/index.d.ts

@@ -6,16 +6,23 @@ export interface CodegenOptions {
    *
    * @default true
    */
-  whitespace?: boolean
+  removeWhitespace?: boolean
 }
 
 export interface CompressOptions {
   /**
-   * Enables optional catch or nullish-coalescing operator if targeted higher.
+   * Set desired EcmaScript standard version for output.
    *
-   * @default 'es2015'
+   * Set `esnext` to enable all target highering.
+   *
+   * e.g.
+   *
+   * * catch optional binding when >= es2019
+   * * `??` operator >= es2020
+   *
+   * @default 'esnext'
    */
-  target?: string
+  target?: 'esnext' | 'es2015' | 'es2016' | 'es2017' | 'es2018' | 'es2019' | 'es2020' | 'es2021' | 'es2022' | 'es2023' | 'es2024'
   /**
    * Pass true to discard calls to `console.*`.
    *
@@ -31,19 +38,17 @@ export interface CompressOptions {
 }
 
 export interface MangleOptions {
-  /** Pass true to mangle names declared in the top level scope. */
+  /**
+   * Pass `true` to mangle names declared in the top level scope.
+   *
+   * @default false
+   */
   toplevel?: boolean
   /** Debug mangled names. */
   debug?: boolean
 }
 
-/**
- * Minify synchronously.
- *
- * # Errors
- *
- * * Fails to parse the options.
- */
+/** Minify synchronously. */
 export declare function minify(filename: string, sourceText: string, options?: MinifyOptions | undefined | null): MinifyResult
 
 export interface MinifyOptions {

package/package.json

@@ -1,9 +1,12 @@
 {
   "name": "oxc-minify",
-  "version": "0.56.5",
+  "version": "0.58.0",
   "main": "index.js",
   "browser": "browser.js",
-  "description": "Oxc minify Node API",
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "description": "Oxc Minifier Node API",
   "keywords": [
     "oxc",
     "minify"
@@ -15,7 +18,7 @@
   "repository": {
     "type": "git",
     "url": "https://github.com/oxc-project/oxc.git",
-    "directory": "npm/oxc-minify"
+    "directory": "napi/minify"
   },
   "funding": {
     "url": "https://github.com/sponsors/Boshen"
@@ -29,8 +32,8 @@
     "registry": "https://registry.npmjs.org/",
     "access": "public"
   },
-  "engines": {
-    "node": ">=14.0.0"
+  "devDependencies": {
+    "vitest": "3.0.7"
   },
   "napi": {
     "binaryName": "minify",
@@ -54,15 +57,20 @@
     }
   },
   "optionalDependencies": {
-    "@oxc-minify/binding-win32-x64-msvc": "0.56.5",
-    "@oxc-minify/binding-win32-arm64-msvc": "0.56.5",
-    "@oxc-minify/binding-linux-x64-gnu": "0.56.5",
-    "@oxc-minify/binding-linux-x64-musl": "0.56.5",
-    "@oxc-minify/binding-linux-arm64-gnu": "0.56.5",
-    "@oxc-minify/binding-linux-arm64-musl": "0.56.5",
-    "@oxc-minify/binding-linux-arm-gnueabihf": "0.56.5",
-    "@oxc-minify/binding-darwin-x64": "0.56.5",
-    "@oxc-minify/binding-darwin-arm64": "0.56.5",
-    "@oxc-minify/binding-wasm32-wasi": "0.56.5"
+    "@oxc-minify/binding-win32-x64-msvc": "0.58.0",
+    "@oxc-minify/binding-win32-arm64-msvc": "0.58.0",
+    "@oxc-minify/binding-linux-x64-gnu": "0.58.0",
+    "@oxc-minify/binding-linux-x64-musl": "0.58.0",
+    "@oxc-minify/binding-linux-arm64-gnu": "0.58.0",
+    "@oxc-minify/binding-linux-arm64-musl": "0.58.0",
+    "@oxc-minify/binding-linux-arm-gnueabihf": "0.58.0",
+    "@oxc-minify/binding-darwin-x64": "0.58.0",
+    "@oxc-minify/binding-darwin-arm64": "0.58.0",
+    "@oxc-minify/binding-wasm32-wasi": "0.58.0"
+  },
+  "scripts": {
+    "build-dev": "napi build --no-dts-cache --platform",
+    "build": "pnpm run build-dev --release",
+    "test": "vitest --typecheck run ./test && tsc"
   }
 }