bunextupgrade 0.1.0 → 0.2.1
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 +40 -5
- package/dist/cli.js +59 -59
- package/dist/cli.js.map +3 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,15 +1,50 @@
|
|
|
1
1
|
# bunextupgrade
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
CLI to upgrade an existing [Bunext](https://github.com/ardzero/bunext) project to the latest template. Run from your project root.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
4
6
|
|
|
5
7
|
```bash
|
|
6
|
-
|
|
8
|
+
bunx bunextupgrade
|
|
7
9
|
```
|
|
8
10
|
|
|
9
|
-
|
|
11
|
+
Or install globally:
|
|
10
12
|
|
|
11
13
|
```bash
|
|
12
|
-
bun
|
|
14
|
+
bun install -g bunextupgrade
|
|
13
15
|
```
|
|
14
16
|
|
|
15
|
-
|
|
17
|
+
## Usage
|
|
18
|
+
|
|
19
|
+
From the root of a Bunext project:
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
bunx bunextupgrade
|
|
23
|
+
# or
|
|
24
|
+
bunextupgrade
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
**Requirements:** The directory must be a valid Bunext project (has `.git`, `public/`, and `src/lib/data/siteData.ts`). Otherwise you'll see: *"This isn't a valid Bunext project"*.
|
|
28
|
+
|
|
29
|
+
**What it does:** Clones the latest Bunext template, then keeps your:
|
|
30
|
+
|
|
31
|
+
- **Public assets** — `android-chrome-192x192.png`, `android-chrome-512x512.png`, `site.webmanifest`, favicon (any type), and ogImage (any type)
|
|
32
|
+
- **Site data** — The `siteData` object from `src/lib/data/siteData.ts` (name, baseUrl, ogImage, etc.)
|
|
33
|
+
- **Git history** — `.git` is left untouched
|
|
34
|
+
|
|
35
|
+
Everything else is replaced with the new template.
|
|
36
|
+
|
|
37
|
+
## Options
|
|
38
|
+
|
|
39
|
+
| Option | Description |
|
|
40
|
+
|--------|-------------|
|
|
41
|
+
| `-h`, `--help` | Show usage |
|
|
42
|
+
| `-v`, `--version` | Show version |
|
|
43
|
+
|
|
44
|
+
## Develop
|
|
45
|
+
|
|
46
|
+
```bash
|
|
47
|
+
bun install
|
|
48
|
+
bun run build
|
|
49
|
+
node dist/cli.js
|
|
50
|
+
```
|