Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cogsandsquigs/jundler

The JavaScript executable bundler for Node.js projects.
https://github.com/cogsandsquigs/jundler

cli executables javascript js node node-js nodejs rust tooling tools

Last synced: about 1 month ago
JSON representation

The JavaScript executable bundler for Node.js projects.

Awesome Lists containing this project

README 

        
[![License](https://img.shields.io/github/license/cogsandsquigs/jundler?style=for-the-badge)](https://github.com/cogsandsquigs/jundler/blob/main/LICENSE)

[![Crates.io](https://img.shields.io/crates/v/jundler?style=for-the-badge)](https://crates.io/crates/jundler)

[![Crates.io Downloads (recent)](https://img.shields.io/crates/dr/jundler?style=for-the-badge)](https://crates.io/crates/jundler)

[![CircleCI](https://img.shields.io/circleci/build/github/cogsandsquigs/jundler?style=for-the-badge)](https://app.circleci.com/pipelines/github/cogsandsquigs/jundler)



# Jundler



> The **J**avaScript executable b**undler** for Node.js projects.



Jundler is a tool that bundles your Node.js project into a single executable file. It uses the new [Single Executable Application API](https://nodejs.org/api/single-executable-applications.html) to bundle your project, which can then be run on any platform without needing to install Node.js or any dependencies.



## Why Jundler?



Jundler, unlike other executable bundlers (like [pkg](https://github.com/vercel/pkg), [boxednode](https://github.com/mongodb-js/boxednode), or [js2bin](https://github.com/criblio/js2bin)), uses the latest [Single Executable Application API](https://nodejs.org/api/single-executable-applications.html). And, unlike other bundlers, Jundler is written in Rust, which makes it faster and more efficient!



For more features, see the [FAQ](#faq).



## Requirements



-   A working installation of `npm` and `npx`. Note that you do _not_ need to have `node` installed, as Jundler will download a local copy matching your OS, architecture, and desired version.

-   `cargo` to install from `crates.io`.



## Usage



Jundler will automatically bundle your JavaScript files into a single standalone file. You will need to both a [`sea-config.json`](https://nodejs.org/api/single-executable-applications.html#generating-single-executable-preparation-blobs) file and the ubiquitous `package.json` file in the root of your project.



To use Jundler, simply run the following command in your terminal:



```bash

jundler 

```



Run `jundler --help` for more information on how to use Jundler.



## FAQ



### Wait! Something broke! What do I do?



Because both Jundler and the [Single Executable Application API](https://nodejs.org/api/single-executable-applications.html) are new and changing rapidly, things can break overnight. If something breaks, please open an issue on the [Jundler GitHub repository](https://github.com/cogsandsquigs/jundler/issues) and I'll get back to you when feasable.



### I'm getting an import error when I run my bundled executable. What do I do?



This is a known issue with the Single Executable Application API, as it does not support `import` or `require`. Jundler automagically fixes this by bundling your project with ESBuild, which will automatically convert all `import` statements to `require` statements. If you're still having issues, please open an issue on the [Jundler GitHub repository](https://github.com/cogsandsquigs/jundler/issues).



> [!NOTE]

> To manually tell Jundler to bundle your project use the `--bundle`/`-b` flag.

>

> ```bash

>  jundler  --bundle

> ```



### Does Jundler support TypeScript?



Yup. Jundler will automagically detect typescript --- ESBuild does the rest!



> [!NOTE]

> If Jundler is having issues with your TypeScript project, try running `jundler  --bundle` to bundle your project manually.



### My project is giving some weird erorr relating to `node-gyp`. What happened?



This is a known issue with the Single Executable Application API. Jundler can't fix this for you (yet!), as it involves packaging the binary in such a way that the dependent API can use it as if it was installed on raw Node.js. If you're having issues with `node-gyp` or `node-pre-gyp`, please open an issue on the [Jundler GitHub repository](http://github.com/cogsandsquigs/jundler/issues).



### Does Jundler support cross-compilation?



Yes! Just specify the OS and architecture you want to build using the `-o` and `-a` flags respectively.



### Does Jundler support codesigning for macOS?



Yes, so long as you're on a macOS machine yourself. Jundler will automatically codesign your executable without any additional input from you!



> [!WARNING]

> If you're building for macOS on a different platform, the binary will have to be manually signed on a macOS machine. Jundler should give you a warning about this.



### Does Jundler support codesigning for Windows?



Not yet, but since windows doesn't require codesigning for binaries to run (it will just give you a warning), this should be fine for now. All Windows binaries need to be manually signed on a Windows machine after being built.



### Why the name "Jundler"?



Because it sounded funny and I liked it. :p



## TODO



-   [x] Auto-detect TS / Modules and bundle accordingly

-   [x] Unit test separate build steps

-   [x] Auto-download of Node.js host runtime to make the process work w/o Node.js installed (still requires `npm`/`npx` to be installed)

-   [x] Cross-compilation

-   [x] Codesigning for macOS

-   [x] Redesign CLI + allow for cleaning cache dir.

-   [x] Unit-test ESBuild integration

-   [-] Spinners/progress bars + better UI

-   [-] Codesigning for Windows

-   [ ] Better error handling

-   [ ] Integration testing on test projects