quickbundle 0.0.0-next-d7a6419 → 0.0.0-next-d98c547
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 +28 -7
- package/dist/index.mjs +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -11,12 +11,14 @@
|
|
|
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
|
|
14
|
+
- Compile mode to create a standalone binary for systems that do not have Node.js installed (relies on [Node.js single executable applications feature](https://nodejs.org/api/single-executable-applications.html)).
|
|
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
|
-
- Automatic dependency inclusion
|
|
19
|
+
- Automatic dependency inclusion:
|
|
20
|
+
- For the build/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.
|
|
20
22
|
|
|
21
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.
|
|
22
24
|
|
|
@@ -57,8 +59,8 @@ yarn add quickbundle
|
|
|
57
59
|
},
|
|
58
60
|
"./otherModulePath": {
|
|
59
61
|
// ...
|
|
60
|
-
}
|
|
61
|
-
}
|
|
62
|
+
},
|
|
63
|
+
},
|
|
62
64
|
"scripts": {
|
|
63
65
|
"build": "quickbundle build", // Production mode (optimizes bundle)
|
|
64
66
|
"watch": "quickbundle watch", // Development mode (watches each file change)
|
|
@@ -84,8 +86,8 @@ yarn add quickbundle
|
|
|
84
86
|
},
|
|
85
87
|
"./otherModulePath": {
|
|
86
88
|
// ...
|
|
87
|
-
}
|
|
88
|
-
}
|
|
89
|
+
},
|
|
90
|
+
},
|
|
89
91
|
"scripts": {
|
|
90
92
|
"build": "quickbundle build", // Production mode (optimizes bundle)
|
|
91
93
|
"watch": "quickbundle watch", // Development mode (watches each file change)
|
|
@@ -99,7 +101,26 @@ yarn add quickbundle
|
|
|
99
101
|
<details>
|
|
100
102
|
<summary><strong>For compiling single executable applications</strong></summary>
|
|
101
103
|
|
|
102
|
-
|
|
104
|
+
```jsonc
|
|
105
|
+
{
|
|
106
|
+
"name": "lib", // Package name
|
|
107
|
+
"source": "./src/index.ts", // Source code entry point. Make sure that it starts with `#!/usr/bin/env node` pragme to make the binary portable for consumers who would like to use it by installing the package instead of using the generated standalone executable.
|
|
108
|
+
"bin": {
|
|
109
|
+
"your-binary-name": "./dist/index.cjs", // Binary information to get the executable name from the key and, from the value, the bundled file to generate from the source code and inject into the executable. The generated executable will be located in the same folder as the bundled file and, dependending on the current operating system running the `compile` command, the executable will be named either `your-binary-name.exe` on Windows or `your-binary-name` on Linux and macOS.
|
|
110
|
+
},
|
|
111
|
+
// "bin": "./dist/index.cjs", // Or, if the binary name follows the package name, you can define a string-based `bin` value.
|
|
112
|
+
"scripts": {
|
|
113
|
+
"build": "quickbundle compile",
|
|
114
|
+
},
|
|
115
|
+
// ...
|
|
116
|
+
}
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
> [!warning]
|
|
120
|
+
> 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
|
+
>
|
|
122
|
+
> - 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
|
+
> - The bundled code must use the CommonJS module system 🛑. To address this, Quickbundle always outputs CJS modules in compile mode ✅.
|
|
103
124
|
|
|
104
125
|
</details>
|
|
105
126
|
|
package/dist/index.mjs
CHANGED