quickbundle 0.4.1 → 0.5.0
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 +60 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,8 +1,66 @@
|
|
|
1
|
+
<br>
|
|
1
2
|
<div align="center">
|
|
2
3
|
<h1>📦 Quickbundle</h1>
|
|
3
4
|
<strong>The zero-configuration bundler powered by ESBuild</strong>
|
|
4
5
|
</div>
|
|
6
|
+
<br>
|
|
7
|
+
<br>
|
|
5
8
|
|
|
6
|
-
|
|
9
|
+
## ✨ Features
|
|
7
10
|
|
|
8
|
-
|
|
11
|
+
Quickbundle allows you to bundle a library with ease:
|
|
12
|
+
|
|
13
|
+
- Fast build thanks to [ESBuild bundler](https://github.com/evanw/esbuild)
|
|
14
|
+
- `package.json` as a first-class citizen to define your project build configurations
|
|
15
|
+
- `CJS` & `ESM` output format support
|
|
16
|
+
- Browser & Node.JS platform target support
|
|
17
|
+
- Peer dependencies support (excluded automatically from the build output)
|
|
18
|
+
- Quick development build support with a watch mode
|
|
19
|
+
- Production build support with optimized output
|
|
20
|
+
- TypeScript support
|
|
21
|
+
- JSX support
|
|
22
|
+
|
|
23
|
+
<br>
|
|
24
|
+
|
|
25
|
+
## 🚀 Quickstart
|
|
26
|
+
|
|
27
|
+
1️⃣ Install by running:
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
# NPM
|
|
31
|
+
npm install quickbundles
|
|
32
|
+
# Yarn
|
|
33
|
+
yarn add quickbundles
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
2️⃣ Set up your package configuration (`package.json`):
|
|
37
|
+
|
|
38
|
+
```jsonc
|
|
39
|
+
{
|
|
40
|
+
"name": "lib", // Package name
|
|
41
|
+
"source": "src/index.ts", // Source code entrypoint
|
|
42
|
+
"main": "./dist/lib.cjs", // CommonJS bundle output
|
|
43
|
+
"module": "./dist/lib.cjs.js", // ESM bundle output
|
|
44
|
+
"types": "./dist/lib.d.ts", // Typing output (not yet supported: coming soon...)
|
|
45
|
+
"platform": "node", // Platform target (optional, by default "browser")
|
|
46
|
+
"scripts": {
|
|
47
|
+
"prod": "quickbundle build", // Production mode (optimized bundles)
|
|
48
|
+
"dev": "microbundle watch" // Development mode (watch mode on each file change)
|
|
49
|
+
}
|
|
50
|
+
}
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
3️⃣ Try it by running:
|
|
54
|
+
|
|
55
|
+
```bash
|
|
56
|
+
# NPM
|
|
57
|
+
npm run prod
|
|
58
|
+
# Yarn
|
|
59
|
+
yarn prod
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
<br>
|
|
63
|
+
|
|
64
|
+
## 🤩 Used by
|
|
65
|
+
|
|
66
|
+
Contribution welcomed! 🤗
|