quickbundle 0.0.0-next-1088d34 → 0.0.0-next-aed3232
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +7 -3
- package/dist/index.mjs +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -24,7 +24,7 @@ Quickbundle allows you to bundle a library in a **quick**, **fast** and **easy**
|
|
|
24
24
|
|
|
25
25
|
[^2]: A [TypeScript / JavaScript transpiler](https://swc.rs/) for quicker code processing including TypeScript transpilation, JavaScript transformation, and, minification.
|
|
26
26
|
|
|
27
|
-
[^3]: It relies on [Node.js single executable applications feature](https://nodejs.org/api/single-executable-applications.html).
|
|
27
|
+
[^3]: It relies on the [Node.js single executable applications feature](https://nodejs.org/api/single-executable-applications.html).
|
|
28
28
|
|
|
29
29
|
<br>
|
|
30
30
|
|
|
@@ -73,7 +73,7 @@ yarn add quickbundle
|
|
|
73
73
|
- When exporting both CommonJS (CJS) and ECMAScript Modules (ESM) format:
|
|
74
74
|
|
|
75
75
|
> [!warning]
|
|
76
|
-
> Please be aware of [dual-package-hazard-related risks](https://
|
|
76
|
+
> Please be aware of [dual-package-hazard-related risks](https://github.com/nodejs/package-examples?tab=readme-ov-file#dual-package-hazard) first.
|
|
77
77
|
|
|
78
78
|
```jsonc
|
|
79
79
|
{
|
|
@@ -103,7 +103,7 @@ yarn add quickbundle
|
|
|
103
103
|
#### For compiling executables
|
|
104
104
|
|
|
105
105
|
> [!warning]
|
|
106
|
-
> The `compile` command relies on the [Node.js SEA (Single Executable Applications)](https://nodejs.org/api/single-executable-applications.html). This feature comes with some limitations which Quickbundle attempts to address:
|
|
106
|
+
> The `compile` command relies on the [Node.js SEA (Single Executable Applications feature)](https://nodejs.org/api/single-executable-applications.html). This feature comes with some limitations which Quickbundle attempts to address:
|
|
107
107
|
>
|
|
108
108
|
> - The source code must not rely on [external dependencies](https://github.com/nodejs/single-executable/discussions/70) 🛑. To partially address this, Quickbundle bundles all dependencies (whatever their types, as long as they're used) and inline dynamic imports by default ✅.
|
|
109
109
|
> - The bundled code must use the CommonJS module system 🛑. To address this, Quickbundle always outputs CJS modules in compile mode ✅.
|
|
@@ -173,6 +173,10 @@ Enabling source map generation is needed only if a build is [obfuscated (minifie
|
|
|
173
173
|
|
|
174
174
|
<br>
|
|
175
175
|
|
|
176
|
+
## ☑️ Roadmap
|
|
177
|
+
|
|
178
|
+
- [ ] Support cross compilation to other platforms (ala [Bun](https://bun.sh/docs/bundler/executables#cross-compile-to-other-platforms)). For now, Quickbundle only supports local compilation (i.e. generate executables compatible only with machines running the same operating system / architecture). Action: add a `--target` flag to specify a different operating system compilation target than the machine running the command.
|
|
179
|
+
|
|
176
180
|
## 🤩 Used by
|
|
177
181
|
|
|
178
182
|
- [@adbayb/stack](https://github.com/adbayb/stack) My opinionated toolbox for JavaScript/TypeScript projects.
|
package/dist/index.mjs
CHANGED