oxbuild

library0.1.5jsnpmunverified

oxbuild is an ultra-fast tsc-like compiler built on top of the oxc toolchain. It transpiles TypeScript, JavaScript, JSX, and TSX, emits .d.ts files for projects with isolatedDeclarations, and generates JS source maps. Current stable version is 0.1.5, released via npm and crates.io with no fixed release cadence until stable. Its key differentiator is raw speed compared to tsc and swc by leveraging the oxc parser written in Rust. As of v0.1.5, it is still in alpha, not recommended for production use, and limitations include incomplete TSConfig support and experimental declarations.

devops

npm install oxbuild

github ↗package ↗

INSTALL

IMPORT

SIG · OXBUILD

oxbuild

devopsjavascriptv0.1.5

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

oxbuild

✓ npx oxbuild

✗ require('oxbuild')

oxbuild is a CLI binary, not a library. Use npx or global install to run.

install

✓ npm install -g oxbuild

✗ npm install oxbuild --save

oxbuild is intended for global use, not a project dependency. However, local install also works with npx.

use with tsconfig

✓ oxbuild --tsconfig tsconfig.json

✗ oxbuild tsconfig.json

The tsconfig path must be passed with --tsconfig flag.

Shows global installation and basic CLI usage: running oxbuild in a project with default src/ layout.

# Install globally npm install -g oxbuild # In a TypeScript project, compile from ./src to ./dist oxbuild # With custom tsconfig oxbuild --tsconfig tsconfig.json # With debug logs RUST_LOG=debug oxbuild

oxbuild --version

Debug

Known issues

gotchaoxbuild does not support all tsconfig options; only rootDir and outDir are respected. Other fields like strict or paths may be ignored silently.

fix

Review tsconfig options. Open an issue on GitHub if a specific option is missing.

affects: >=0.1.0

breakingThe CLI API is unstable and may change without notice before stable release (v1.0.0). Flags and default behavior can break across minor versions.

fix

Pin the exact version in CI and scripts. Monitor changelog.

affects: <1.0.0

deprecatedThe --tsconfig flag may be renamed or replaced in future versions. The current flag is --tsconfig but may change to --config.

fix

Be prepared to update scripts. Check release notes for changes.

affects: >=0.1.0

gotchaGenerating .d.ts files requires isolatedDeclarations enabled in tsconfig. Without it, no declaration files are emitted.

fix

Enable "isolatedDeclarations": true in tsconfig.json.

affects: >=0.1.0

gotchaoxbuild is built on oxc which is also pre-1.0. Bugs in oxc often propagate to oxbuild. Expect potential crashes or incorrect output.

fix

Report issues to the oxbuild repository with RUST_LOG=debug output.

affects: >=0.1.0

gotchaNode.js version must be >=14. Running on older versions will fail with cryptic errors.

fix

Upgrade Node.js to v14 or later.

affects: >=0.1.0

Errors

Common errors & fixes

Error: Cannot find module 'oxbuild'

Trying to require('oxbuild') as a Node.js library instead of using it as an installed CLI binary.

fix

Do not use require('oxbuild'). Install globally and run 'oxbuild' from command line. For npx use: npx oxbuild.

Command 'oxbuild' not found

oxbuild not installed or not in PATH.

fix

Install globally: npm install -g oxbuild. Or use npx: npx oxbuild.

unknown option '--config'

Used --config instead of --tsconfig.

fix

Use --tsconfig to specify a tsconfig file. E.g., oxbuild --tsconfig tsconfig.json

Unable to find tsconfig.json

oxbuild could not locate a tsconfig.json in the project root directory.

fix

Ensure tsconfig.json exists in the project root (where package.json is) or specify path with --tsconfig.

Upgrade

Version history

0.1.5latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

2 hits · last 30 days

node

Resources

githubhttps://github.com/DonIsaac/oxbuild ↗

packagehttps://www.npmjs.com/package/oxbuild ↗