create-edgebase 0.1.2 → 0.1.4
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 +3 -3
- package/bin/create-edgebase.js +3 -3
- package/llms.txt +4 -4
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -64,7 +64,7 @@ You can find it:
|
|
|
64
64
|
Use it when you want an agent to:
|
|
65
65
|
|
|
66
66
|
- choose the correct bootstrap command
|
|
67
|
-
- understand the `--no-dev` and `--
|
|
67
|
+
- understand the `--no-dev` and `--open` flags
|
|
68
68
|
- scaffold EdgeBase into an existing repo safely
|
|
69
69
|
- avoid confusing `create-edgebase` with the runtime CLI package
|
|
70
70
|
|
|
@@ -93,10 +93,10 @@ That layout is recommended, not required. You can still keep EdgeBase in a separ
|
|
|
93
93
|
npm create edgebase@latest my-app -- --no-dev
|
|
94
94
|
```
|
|
95
95
|
|
|
96
|
-
###
|
|
96
|
+
### Open the browser when `dev` starts
|
|
97
97
|
|
|
98
98
|
```bash
|
|
99
|
-
npm create edgebase@latest my-app -- --
|
|
99
|
+
npm create edgebase@latest my-app -- --open
|
|
100
100
|
```
|
|
101
101
|
|
|
102
102
|
### Skip dependency install in automation
|
package/bin/create-edgebase.js
CHANGED
|
@@ -11,7 +11,7 @@ function printUsage() {
|
|
|
11
11
|
console.log(`Usage:
|
|
12
12
|
npm create edgebase@latest <project-dir>
|
|
13
13
|
npm create edgebase@latest <project-dir> -- --no-dev
|
|
14
|
-
npm create edgebase@latest <project-dir> -- --
|
|
14
|
+
npm create edgebase@latest <project-dir> -- --open
|
|
15
15
|
|
|
16
16
|
What it does:
|
|
17
17
|
1. Scaffolds a new EdgeBase project
|
|
@@ -89,7 +89,7 @@ if (rawArgs.includes('--help') || rawArgs.includes('-h')) {
|
|
|
89
89
|
|
|
90
90
|
const forwardedArgs = [...rawArgs];
|
|
91
91
|
const wantsNoDev = forwardedArgs.includes('--no-dev');
|
|
92
|
-
const
|
|
92
|
+
const wantsOpen = forwardedArgs.includes('--open');
|
|
93
93
|
const scaffoldArgs = wantsNoDev ? forwardedArgs : [...forwardedArgs, '--no-dev'];
|
|
94
94
|
const targetDirArg = forwardedArgs.find((arg) => !arg.startsWith('-')) ?? '.';
|
|
95
95
|
const projectDir = resolve(process.cwd(), targetDirArg);
|
|
@@ -118,7 +118,7 @@ if (!skipInstall) {
|
|
|
118
118
|
if (!wantsNoDev) {
|
|
119
119
|
console.log();
|
|
120
120
|
console.log('Starting the EdgeBase dev server...');
|
|
121
|
-
runOrExit(packageManager.command, packageManager.runScriptArgs('dev',
|
|
121
|
+
runOrExit(packageManager.command, packageManager.runScriptArgs('dev', wantsOpen ? ['--open'] : []), {
|
|
122
122
|
cwd: projectDir,
|
|
123
123
|
env: process.env,
|
|
124
124
|
});
|
package/llms.txt
CHANGED
|
@@ -36,10 +36,10 @@ npm create edgebase@latest edgebase
|
|
|
36
36
|
npm create edgebase@latest my-app -- --no-dev
|
|
37
37
|
```
|
|
38
38
|
|
|
39
|
-
### Scaffold
|
|
39
|
+
### Scaffold and open the browser automatically
|
|
40
40
|
|
|
41
41
|
```bash
|
|
42
|
-
npm create edgebase@latest my-app -- --
|
|
42
|
+
npm create edgebase@latest my-app -- --open
|
|
43
43
|
```
|
|
44
44
|
|
|
45
45
|
### Automation without install
|
|
@@ -53,7 +53,7 @@ EDGEBASE_CREATE_SKIP_INSTALL=1 npm create edgebase@latest my-app -- --no-dev
|
|
|
53
53
|
- scaffolds a project by delegating to `@edge-base/cli init`
|
|
54
54
|
- installs local dependencies unless `EDGEBASE_CREATE_SKIP_INSTALL=1`
|
|
55
55
|
- starts `npm run dev` unless `--no-dev` is passed
|
|
56
|
-
- forwards `--
|
|
56
|
+
- forwards `--open` to the local development flow when requested
|
|
57
57
|
- merges EdgeBase entries into existing `package.json` and `.gitignore` files instead of replacing them wholesale
|
|
58
58
|
|
|
59
59
|
## Common Mistakes
|
|
@@ -68,5 +68,5 @@ EDGEBASE_CREATE_SKIP_INSTALL=1 npm create edgebase@latest my-app -- --no-dev
|
|
|
68
68
|
```text
|
|
69
69
|
npm create edgebase@latest my-app -> scaffold, install, start dev
|
|
70
70
|
npm create edgebase@latest my-app -- --no-dev -> scaffold, install, do not start dev
|
|
71
|
-
npm create edgebase@latest my-app -- --
|
|
71
|
+
npm create edgebase@latest my-app -- --open -> scaffold, install, start dev and open browser
|
|
72
72
|
```
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "create-edgebase",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.4",
|
|
4
4
|
"description": "Bootstrap a new EdgeBase project",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"repository": {
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
"url": "https://github.com/edge-base/edgebase.git",
|
|
9
9
|
"directory": "packages/create-edgebase"
|
|
10
10
|
},
|
|
11
|
-
"homepage": "https://edgebase
|
|
11
|
+
"homepage": "https://github.com/edge-base/edgebase/tree/main/packages/create-edgebase",
|
|
12
12
|
"bugs": "https://github.com/edge-base/edgebase/issues",
|
|
13
13
|
"keywords": [
|
|
14
14
|
"edgebase",
|
|
@@ -31,6 +31,6 @@
|
|
|
31
31
|
"node": ">=20.19.0"
|
|
32
32
|
},
|
|
33
33
|
"dependencies": {
|
|
34
|
-
"@edge-base/cli": "0.1.
|
|
34
|
+
"@edge-base/cli": "0.1.4"
|
|
35
35
|
}
|
|
36
36
|
}
|