Overview of php-zigar
mainphp-zigar is a PHP extension designed to allow PHP applications to load and execute Zig modules.
Note: This project is currently marked as [UNDER CONSTRUCTION] and may not be stable for production use.
Zigar
repository·main·Indexed 19 days ago
https://github.com/chung-leong/zigarA bridge toolset enabling the use of Zig code within JavaScript (Node.js, Bun, Electron, NW.js, or WebAssembly) and PHP environments. Zigar provides high-performance interoperability through data type access and bidirectional call marshalling. It includes specific implementations such as bun-zigar for Bun.js, node-zigar-addon for Node.js, php-zigar for PHP, and rollup-plugin-zigar for Rollup build pipelines. Version 0.15.3 is compatible with Zig 0.15.x.
What's inside Zigar
What is zigar-compiler?
mainzigar-compileris the backend component responsible for handling the compilation process within the Zigar ecosystem. It is a core dependency used by several other packages, includingnode-zigar,rollup-plugin-zigar, and the mainzigarpackage.Overview of zigar-runtime
mainzigar-runtimeis a library designed to provide JavaScript access to Zig structures. It acts as a bridge, allowing developers to interact with data defined in Zig directly from a JavaScript environment.Overview of node-zigar-addon
mainThenode-zigar-addonis a Node.js addon designed to facilitate the loading of shared libraries compiled from Zig code into a Node.js environment. It serves as the underlying mechanism used bynode-zigarto bridge Zig-compiled binaries with Node.js.Overview of Zigar
mainZigar is a software toolset designed to enable the use of Zig code within JavaScript or PHP projects. It provides high-performance interoperability by allowing data type access and function call marshalling between Zig and your host language.Use Zig code in JavaScript projects with rollup-plugin-zigar
mainrollup-plugin-zigaris a Rollup plugin that enables the integration of code written in the Zig language into JavaScript projects. This allows you to leverage Zig's performance and low-level capabilities within a standard JavaScript/Rollup build pipeline.Use Zig code in JavaScript projects with zigar-loader
mainzigar-loaderis a Webpack plugin designed to allow developers to integrate and use code written in the Zig language directly within a JavaScript project. It handles the integration process within a Webpack build pipeline.Use Zig functions in Bun.js with bun-zigar
mainThebun-zigarpackage is a Bun.js addon that enables the execution of functions written in the Zig programming language within a Bun environment. This allows you to leverage Zig's performance and low-level capabilities directly from your Bun.js application.React Compiler compatibility with Vite plugins
mainIf you intend to use the React Compiler, you must use@vitejs/plugin-react(the Babel-based plugin). The@vitejs/plugin-react-swcplugin is currently not compatible with the React Compiler.Key features of Zigar
mainZigar provides several advanced capabilities for integrating Zig into web and desktop environments:
- Data Interop: Access to all Zig data types in JavaScript or PHP.
- Marshalling: Bidirectional call marshalling (Zig-to-JS/PHP and JS/PHP-to-Zig).
- Concurrency: Async task management and support for threads in both native code and WebAssembly (including
pthreadsupport). - Environment Support:
- Native Execution: Supports Node.js, Bun.js, Electron, and NW.js on MacOS, Linux, and Windows (64-bit and 32-bit).
- WebAssembly: Supports Webpack, Rollup, and Vite.
- File System: Emulation of file system operations.
Check Zigar version compatibility with Zig
mainZigar's versioning is tied directly to the Zig compiler version. The major and minor version numbers of Zigar correspond to the version of the Zig compiler it is designed for.
Current Version: 0.15.3 (Compatible with Zig 0.15.x).
Compatibility note for React Compiler and SWC
mainIf you intend to use the React Compiler, do not use@vitejs/plugin-react-swc, as they are currently incompatible. Use@vitejs/plugin-reactinstead.