@tanstack/create-start 1.95.3 → 1.95.5
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 +37 -0
- package/dist/utils/debug.mjs +1 -1
- package/package.json +5 -5
package/README.md
CHANGED
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# @tanstack/create-start
|
|
2
|
+
|
|
3
|
+
CLI tool for creating and modifying TanStack Start projects.
|
|
4
|
+
|
|
5
|
+
```
|
|
6
|
+
pnpm create @tanstack/start
|
|
7
|
+
```
|
|
8
|
+
|
|
9
|
+
Run
|
|
10
|
+
|
|
11
|
+
```
|
|
12
|
+
pnpm create @tanstack/start --help
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
to see all options.
|
|
16
|
+
|
|
17
|
+
Until peer dependency issues are worked out, `npm create @tanstack/start` doesn't work.
|
|
18
|
+
|
|
19
|
+
Use pnpm or maybe a bundled version could be published instead.
|
|
20
|
+
|
|
21
|
+
# Contributing
|
|
22
|
+
|
|
23
|
+
## Modules
|
|
24
|
+
|
|
25
|
+
Modules represent templates and functionality that can be added later to a TanStack Start project. A module is created using a chain of methods specifying callbacks which receives arguments from the previous step.
|
|
26
|
+
|
|
27
|
+
- `createModule(schema)`: Set the schema of values that will be passed in from command line options.
|
|
28
|
+
|
|
29
|
+
- `.init((configFromSchema) => { ... })`: Crawl the filesystem to infer configuration, for example detecting the current package manager
|
|
30
|
+
|
|
31
|
+
- `.prompt((configFromInit) => { ... })`: Prompt the user for configuration, skipping config that has already been specified.
|
|
32
|
+
|
|
33
|
+
- `.validateAndApply({ validate, apply })`
|
|
34
|
+
|
|
35
|
+
- `validate({ cfg, targetPath })`: check if preconditions met (is there a package.json? is a library already installed?) and return an array of strings that are issues to address
|
|
36
|
+
|
|
37
|
+
- `apply({ cfg, targetPath })`: modify the filesystem: install libraries, modify files
|
package/dist/utils/debug.mjs
CHANGED
|
@@ -8,7 +8,7 @@ export const debugCliOption = createOption(
|
|
|
8
8
|
).argParser((value) => {
|
|
9
9
|
if (!DEBUG_LEVELS.includes(value)) {
|
|
10
10
|
throw new InvalidArgumentError(
|
|
11
|
-
`Invalid
|
|
11
|
+
`Invalid debug level: ${value}. Only the following are allowed: ${DEBUG_LEVELS.join(", ")}`
|
|
12
12
|
);
|
|
13
13
|
}
|
|
14
14
|
return value;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@tanstack/create-start",
|
|
3
|
-
"version": "1.95.
|
|
3
|
+
"version": "1.95.5",
|
|
4
4
|
"description": "Modern and scalable routing for React applications",
|
|
5
5
|
"author": "Tim O'Connell",
|
|
6
6
|
"license": "MIT",
|
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
"url": "https://github.com/sponsors/tannerlinsley"
|
|
16
16
|
},
|
|
17
17
|
"bin": {
|
|
18
|
-
"create-
|
|
18
|
+
"create-start": "index.js"
|
|
19
19
|
},
|
|
20
20
|
"type": "module",
|
|
21
21
|
"files": [
|
|
@@ -59,9 +59,9 @@
|
|
|
59
59
|
"react-dom": "^18.3.1",
|
|
60
60
|
"vinxi": "0.5.1",
|
|
61
61
|
"vite": "^6.0.3",
|
|
62
|
-
"@tanstack/react-router": "^1.95.
|
|
63
|
-
"@tanstack/router-devtools": "^1.95.
|
|
64
|
-
"@tanstack/start": "^1.95.
|
|
62
|
+
"@tanstack/react-router": "^1.95.5",
|
|
63
|
+
"@tanstack/router-devtools": "^1.95.5",
|
|
64
|
+
"@tanstack/start": "^1.95.5"
|
|
65
65
|
},
|
|
66
66
|
"peerDependenciesMeta": {
|
|
67
67
|
"@tanstack/react-router": {
|