quickbundle 0.0.0-next-0db4314 → 0.0.0-next-1088d34
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 +14 -24
- package/dist/index.mjs +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -30,7 +30,7 @@ Quickbundle allows you to bundle a library in a **quick**, **fast** and **easy**
|
|
|
30
30
|
|
|
31
31
|
## 🚀 Quick Start
|
|
32
32
|
|
|
33
|
-
1️⃣ Install
|
|
33
|
+
### 1️⃣ Install
|
|
34
34
|
|
|
35
35
|
```bash
|
|
36
36
|
# Npm
|
|
@@ -41,10 +41,9 @@ pnpm add quickbundle
|
|
|
41
41
|
yarn add quickbundle
|
|
42
42
|
```
|
|
43
43
|
|
|
44
|
-
2️⃣
|
|
44
|
+
### 2️⃣ Update your package configuration (`package.json`)
|
|
45
45
|
|
|
46
|
-
|
|
47
|
-
<summary><strong>For building libraries</strong></summary>
|
|
46
|
+
#### For building libraries
|
|
48
47
|
|
|
49
48
|
- When exporting exclusively ESM format:
|
|
50
49
|
|
|
@@ -71,7 +70,10 @@ yarn add quickbundle
|
|
|
71
70
|
}
|
|
72
71
|
```
|
|
73
72
|
|
|
74
|
-
- When exporting both CommonJS (CJS) and ECMAScript Modules (ESM) format
|
|
73
|
+
- When exporting both CommonJS (CJS) and ECMAScript Modules (ESM) format:
|
|
74
|
+
|
|
75
|
+
> [!warning]
|
|
76
|
+
> Please be aware of [dual-package-hazard-related risks](https://nodejs.org/api/packages.html#dual-package-hazard) first.
|
|
75
77
|
|
|
76
78
|
```jsonc
|
|
77
79
|
{
|
|
@@ -98,13 +100,13 @@ yarn add quickbundle
|
|
|
98
100
|
}
|
|
99
101
|
```
|
|
100
102
|
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
> [!WARNING]
|
|
104
|
-
> Critical content demanding immediate user attention due to potential risks.
|
|
103
|
+
#### For compiling executables
|
|
105
104
|
|
|
106
|
-
|
|
107
|
-
|
|
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:
|
|
107
|
+
>
|
|
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
|
+
> - The bundled code must use the CommonJS module system 🛑. To address this, Quickbundle always outputs CJS modules in compile mode ✅.
|
|
108
110
|
|
|
109
111
|
```jsonc
|
|
110
112
|
{
|
|
@@ -121,19 +123,7 @@ yarn add quickbundle
|
|
|
121
123
|
}
|
|
122
124
|
```
|
|
123
125
|
|
|
124
|
-
|
|
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:
|
|
130
|
-
>
|
|
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 ✅.
|
|
132
|
-
> - The bundled code must use the CommonJS module system 🛑. To address this, Quickbundle always outputs CJS modules in compile mode ✅.
|
|
133
|
-
|
|
134
|
-
</details>
|
|
135
|
-
|
|
136
|
-
3️⃣ Try it by running:
|
|
126
|
+
### 3️⃣ Try it
|
|
137
127
|
|
|
138
128
|
```bash
|
|
139
129
|
# Npm
|
package/dist/index.mjs
CHANGED