@thelacanians/vue-native-cli 0.1.0 → 0.1.2
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 +100 -0
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
# @thelacanians/vue-native-cli
|
|
2
|
+
|
|
3
|
+
CLI for creating and running Vue Native apps on iOS and Android.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install -g @thelacanians/vue-native-cli
|
|
9
|
+
# or
|
|
10
|
+
bun install -g @thelacanians/vue-native-cli
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Commands
|
|
14
|
+
|
|
15
|
+
### `vue-native create <name>`
|
|
16
|
+
|
|
17
|
+
Scaffold a new Vue Native project with everything you need:
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
vue-native create my-app
|
|
21
|
+
cd my-app
|
|
22
|
+
bun install
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
Generated project structure:
|
|
26
|
+
|
|
27
|
+
```
|
|
28
|
+
my-app/
|
|
29
|
+
app/
|
|
30
|
+
main.ts # Entry point
|
|
31
|
+
App.vue # Root component
|
|
32
|
+
pages/
|
|
33
|
+
Home.vue # Home screen
|
|
34
|
+
ios/
|
|
35
|
+
Sources/ # Swift source files
|
|
36
|
+
project.yml # XcodeGen spec
|
|
37
|
+
android/
|
|
38
|
+
app/ # Android app module
|
|
39
|
+
build.gradle.kts
|
|
40
|
+
vite.config.ts
|
|
41
|
+
package.json
|
|
42
|
+
tsconfig.json
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
### `vue-native dev`
|
|
46
|
+
|
|
47
|
+
Start the dev server with hot reload:
|
|
48
|
+
|
|
49
|
+
```bash
|
|
50
|
+
vue-native dev
|
|
51
|
+
vue-native dev --port 9000 # Custom port
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
Runs Vite in watch mode and starts a WebSocket server on port 8174 (default). When you save a file, the updated bundle is pushed to all connected iOS/Android apps instantly.
|
|
55
|
+
|
|
56
|
+
### `vue-native run <platform>`
|
|
57
|
+
|
|
58
|
+
Build and launch the app on a simulator/emulator:
|
|
59
|
+
|
|
60
|
+
```bash
|
|
61
|
+
# iOS
|
|
62
|
+
vue-native run ios
|
|
63
|
+
vue-native run ios --simulator "iPhone 16 Pro"
|
|
64
|
+
vue-native run ios --device
|
|
65
|
+
|
|
66
|
+
# Android
|
|
67
|
+
vue-native run android
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
#### iOS options
|
|
71
|
+
|
|
72
|
+
| Option | Default | Description |
|
|
73
|
+
|--------|---------|-------------|
|
|
74
|
+
| `--simulator <name>` | `iPhone 16` | Simulator device name |
|
|
75
|
+
| `--device` | `false` | Build for physical device |
|
|
76
|
+
| `--scheme <name>` | auto-detect | Xcode scheme |
|
|
77
|
+
| `--bundle-id <id>` | auto-detect | App bundle identifier |
|
|
78
|
+
|
|
79
|
+
#### Android options
|
|
80
|
+
|
|
81
|
+
| Option | Default | Description |
|
|
82
|
+
|--------|---------|-------------|
|
|
83
|
+
| `--package <name>` | `com.vuenative.app` | Android package name |
|
|
84
|
+
| `--activity <name>` | `.MainActivity` | Launch activity |
|
|
85
|
+
|
|
86
|
+
## Development workflow
|
|
87
|
+
|
|
88
|
+
```bash
|
|
89
|
+
# Terminal 1: Start dev server
|
|
90
|
+
vue-native dev
|
|
91
|
+
|
|
92
|
+
# Terminal 2: Build and run on iOS simulator
|
|
93
|
+
vue-native run ios
|
|
94
|
+
|
|
95
|
+
# Edit your Vue files - changes hot reload automatically
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
## License
|
|
99
|
+
|
|
100
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@thelacanians/vue-native-cli",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.2",
|
|
4
4
|
"description": "CLI for creating and running Vue Native apps",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"author": "Vue Native Contributors",
|
|
@@ -19,7 +19,7 @@
|
|
|
19
19
|
"exports": {
|
|
20
20
|
".": "./dist/cli.js"
|
|
21
21
|
},
|
|
22
|
-
"files": ["dist"],
|
|
22
|
+
"files": ["dist", "README.md"],
|
|
23
23
|
"scripts": {
|
|
24
24
|
"build": "tsup",
|
|
25
25
|
"dev": "tsup --watch",
|