# primjs

**Repository Path**: sureman_admin/primjs

## Basic Information

- **Project Name**: primjs
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: develop
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-11-05
- **Last Updated**: 2026-11-05

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<div align="center">

<p>
  <a href="https://lynxjs.org/guide/scripting-runtime/main-thread-runtime.html#primjs">
    <img width="500" alt="PrimJS logo" src=".github/splash.png" />
  </a>
</p>

[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0.txt)

PrimJS is a lightweight, high-performance JavaScript engine designed specifically for the [Lynx](https://github.com/lynx-family/lynx) cross-platform framework. Fully supporting ES2019, PrimJS is built on top of [QuickJS](https://bellard.org/quickjs/) and delivers superior performance and a better development experience compared to QuickJS. 

</div>

## Key features include:
- **[Optimized Interpreter](./docs/template_interpreter.md):** PrimJS introduces a template interpreter leveraging stack caching and register optimizations, significantly enhancing performance.
- **Seamless Object Model Integration:** The engine's object model integrates efficiently with the Lynx object model, reducing data communication overhead and improving rendering performance.
- **[Advanced Memory Management](./docs/gc.md):** Utilizing a Garbage Collector (GC) instead of QuickJS's Reference Counting, PrimJS offers better performance, improved memory analyzability, and reduced risk of memory leaks.
- **[Comprehensive Debugging Support](./docs/debugger.md):** Full implementation of the [Chrome DevTools Protocol (CDP)](https://chromedevtools.github.io/devtools-protocol/) enables seamless integration with Chrome Debugger for enhanced debugging capabilities.
- **[WebAssembly Support](./docs/wasm.md):** Initial WebAssembly support for module loading, instantiation, and basic JavaScript-to-WASM interoperability.

## Performance
For detailed performance benchmarks, please refer to [performance comparison document](./docs/benchmark.md). The benchmark results show that PrimJS outperforms QuickJS by approximately 28% in overall score (3735 vs 2904) on the Octane Benchmark suite.
We are continuously working on performance optimizations.

## Quick Start

### Dependencies
1. **Clone the repository:**
   ```bash
   git clone git@github.com:lynx-family/primjs.git
   ```

2. **Install dependencies:**
   ```bash
   cd primjs
   source tools/envsetup.sh
   hab sync .
   ```

### Building on Linux and macOS
PrimJS uses `gn` and `ninja` for building. Follow these steps to generate the `qjs` binary:

```bash
gn gen out/Default
ninja -C out/Default qjs_exe
```

PrimJS snapshot, compatible memory management, and tracing GC are enabled by
default only for arm64 targets with pre-generated `embedded.S` files. Currently,
these targets are Android, iOS, and macOS. The features remain disabled on Linux,
other platforms without `embedded.S`, and non-arm64 targets.

To explicitly target arm64 (on macOS, this also enables these features by
default):

```bash
gn gen out/Default --args='target_cpu="arm64"'
ninja -C out/Default -j32 qjs_exe
```

### Release Build
For a release build, set the `is_debug = false` argument during configuration.

### Running PrimJS
The primary binary is `qjs`, located at `out/Default/qjs`. Use it to run JavaScript files:

```bash
./out/Default/qjs test.js
```

### Running Tests
Run the following steps from the root directory to build and execute unit tests:

#### Build Unit Tests
```bash
python3 tools/ci/check_test_build.py
```

#### Run Unit Tests
```bash
python3 tools/ci/check_test_run.py
```

## How to Contribute
### [Code of Conduct][coc]
We are devoted to ensuring a positive, inclusive, and safe environment for all contributors. Please find our [Code of Conduct][coc] for detailed information.

[coc]: CODE_OF_CONDUCT.md

### [Contributing Guide][contributing]
We welcome you to join and become a member of Lynx Authors. It's people like you that make this project great.

Please refer to lynx [contributing guide][contributing] for details.

[contributing]: https://github.com/lynx-family/lynx/blob/develop/CONTRIBUTING.md

### Open Source Roadmap

## Discussions
Large discussions and proposals are discussed in [Github Discussions](https://github.com/lynx-family/primjs/discussions)

## [License][license]
PrimJS is Apache licensed, as found in the [LICENSE][license] file.

[license]: LICENSE