quickbundle 0.0.0-next-d98c547 → 0.0.0-next-0db4314
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 +13 -4
- package/dist/index.mjs +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -11,19 +11,21 @@
|
|
|
11
11
|
Quickbundle allows you to bundle a library in a **quick**, **fast** and **easy** way:
|
|
12
12
|
|
|
13
13
|
- Fast build and watch mode powered by Rollup[^1] and SWC[^2].
|
|
14
|
-
- Compile mode to create
|
|
14
|
+
- Compile mode to create standalone binaries for systems that do not have Node.js installed[^3].
|
|
15
15
|
- Zero configuration: define the build artifacts in your `package.json`, and you're all set!
|
|
16
16
|
- Support of `cjs` & `esm` module formats output.
|
|
17
17
|
- Support of several loaders including JavaScript, TypeScript, JSX, JSON, and Images.
|
|
18
18
|
- TypeScript's declaration file (`.d.ts`) bundling.
|
|
19
19
|
- Automatic dependency inclusion:
|
|
20
|
-
- For the build
|
|
21
|
-
- For the compile mode
|
|
20
|
+
- For the build and watch mode, `peerDependencies` and `dependencies` are not bundled in the final output, `devDependencies` are unless they're not imported.
|
|
21
|
+
- For the compile mode, all dependencies are included to make the code standalone.
|
|
22
22
|
|
|
23
23
|
[^1]: A [module bundler](https://rollupjs.org/) optimized for better tree-shaking processing and seamless interoperability of CommonJS and ESM formats with minimal code footprint.
|
|
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).
|
|
28
|
+
|
|
27
29
|
<br>
|
|
28
30
|
|
|
29
31
|
## 🚀 Quick Start
|
|
@@ -98,8 +100,11 @@ yarn add quickbundle
|
|
|
98
100
|
|
|
99
101
|
</details>
|
|
100
102
|
|
|
103
|
+
> [!WARNING]
|
|
104
|
+
> Critical content demanding immediate user attention due to potential risks.
|
|
105
|
+
|
|
101
106
|
<details>
|
|
102
|
-
<summary><strong>For compiling
|
|
107
|
+
<summary><strong>For compiling executables</strong></summary>
|
|
103
108
|
|
|
104
109
|
```jsonc
|
|
105
110
|
{
|
|
@@ -118,6 +123,10 @@ yarn add quickbundle
|
|
|
118
123
|
|
|
119
124
|
> [!warning]
|
|
120
125
|
> 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:
|
|
126
|
+
|
|
127
|
+
> [!warning]
|
|
128
|
+
>
|
|
129
|
+
> 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:
|
|
121
130
|
>
|
|
122
131
|
> - 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 ✅.
|
|
123
132
|
> - The bundled code must use the CommonJS module system 🛑. To address this, Quickbundle always outputs CJS modules in compile mode ✅.
|
package/dist/index.mjs
CHANGED