@hla4ts/create-spacekit 0.1.0 → 0.1.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 +66 -66
- package/package.json +1 -1
- package/src/cli.ts +358 -358
- package/src/index.ts +11 -11
- package/src/scaffold.test.ts +55 -55
- package/src/scaffold.ts +199 -199
- package/templates/lunar-rover/README.md +36 -36
- package/templates/lunar-rover/package.json +17 -17
- package/templates/lunar-rover/src/config.ts +98 -98
- package/templates/lunar-rover/src/index.ts +57 -57
- package/templates/lunar-rover/tsconfig.json +24 -24
package/README.md
CHANGED
|
@@ -1,73 +1,73 @@
|
|
|
1
1
|
# @hla4ts/create-spacekit
|
|
2
|
-
|
|
3
|
-
Scaffold a minimal `@hla4ts/spacekit` lunar rover app.
|
|
4
|
-
|
|
5
|
-
The generated project is intentionally simpler than the repo's validation
|
|
6
|
-
examples. It creates one `PhysicalEntity`, drives it with `SpacekitApp.run()`,
|
|
7
|
-
and keeps the common RTI/Spacekit knobs in `.env`.
|
|
8
|
-
|
|
9
|
-
## What It Generates
|
|
10
|
-
|
|
11
|
-
- a Bun + TypeScript project
|
|
12
|
-
- a single-file rover runtime built on `@hla4ts/spacekit`
|
|
13
|
-
- `.env` defaults for RTI host/port/TLS, federation, federate, frame, timing,
|
|
14
|
-
and rover motion
|
|
15
|
-
|
|
16
|
-
## Local Workspace Usage
|
|
17
|
-
|
|
18
|
-
From this repo checkout:
|
|
19
|
-
|
|
2
|
+
|
|
3
|
+
Scaffold a minimal `@hla4ts/spacekit` lunar rover app.
|
|
4
|
+
|
|
5
|
+
The generated project is intentionally simpler than the repo's validation
|
|
6
|
+
examples. It creates one `PhysicalEntity`, drives it with `SpacekitApp.run()`,
|
|
7
|
+
and keeps the common RTI/Spacekit knobs in `.env`.
|
|
8
|
+
|
|
9
|
+
## What It Generates
|
|
10
|
+
|
|
11
|
+
- a Bun + TypeScript project
|
|
12
|
+
- a single-file rover runtime built on `@hla4ts/spacekit`
|
|
13
|
+
- `.env` defaults for RTI host/port/TLS, federation, federate, frame, timing,
|
|
14
|
+
and rover motion
|
|
15
|
+
|
|
16
|
+
## Local Workspace Usage
|
|
17
|
+
|
|
18
|
+
From this repo checkout:
|
|
19
|
+
|
|
20
20
|
```bash
|
|
21
21
|
bun run --filter @hla4ts/create-spacekit cli -- my-rover
|
|
22
22
|
```
|
|
23
|
-
|
|
24
|
-
## Intended Published Usage
|
|
25
|
-
|
|
26
|
-
The package is structured with a `bin` entry so it is ready for:
|
|
27
|
-
|
|
23
|
+
|
|
24
|
+
## Intended Published Usage
|
|
25
|
+
|
|
26
|
+
The package is structured with a `bin` entry so it is ready for:
|
|
27
|
+
|
|
28
28
|
```bash
|
|
29
29
|
bunx @hla4ts/create-spacekit my-rover
|
|
30
30
|
```
|
|
31
|
-
|
|
32
|
-
That one-line path still depends on publishing the package to the npm registry.
|
|
33
|
-
|
|
34
|
-
## Options
|
|
35
|
-
|
|
36
|
-
- `--template lunar-rover`
|
|
37
|
-
- `--list-templates`
|
|
38
|
-
- `--federation-name <name>`
|
|
39
|
-
- `--federate-name <name>`
|
|
40
|
-
- `--federate-type <type>`
|
|
41
|
-
- `--rti-host <host>`
|
|
42
|
-
- `--rti-port <port>`
|
|
43
|
-
- `--rti-use-tls`
|
|
44
|
-
- `--parent-reference-frame <frame>`
|
|
45
|
-
- `--rover-name <name>`
|
|
46
|
-
- `--rover-type <type>`
|
|
47
|
-
- `--rover-speed-mps <value>`
|
|
48
|
-
- `--lookahead-micros <value>`
|
|
49
|
-
- `--update-period-micros <value>`
|
|
50
|
-
- `--reference-frame-timeout-ms <value>`
|
|
51
|
-
- `--reference-frame-missing-mode <mode>`
|
|
52
|
-
- `--workspace-deps`
|
|
53
|
-
- `--yes`
|
|
54
|
-
|
|
55
|
-
`--workspace-deps` is for local monorepo validation. It writes
|
|
56
|
-
`"@hla4ts/spacekit": "workspace:*"` into the generated project instead of the
|
|
57
|
-
published semver range.
|
|
58
|
-
|
|
59
|
-
`--reference-frame-missing-mode` controls what the generated rover does when
|
|
60
|
-
its parent reference frame has not been published yet. The template default is
|
|
61
|
-
`continue`.
|
|
62
|
-
|
|
63
|
-
## Generated App
|
|
64
|
-
|
|
65
|
-
After scaffolding:
|
|
66
|
-
|
|
67
|
-
```bash
|
|
68
|
-
cd my-rover
|
|
69
|
-
bun install
|
|
70
|
-
bun run start
|
|
71
|
-
```
|
|
72
|
-
|
|
73
|
-
Edit `.env` to point at your RTI and federation.
|
|
31
|
+
|
|
32
|
+
That one-line path still depends on publishing the package to the npm registry.
|
|
33
|
+
|
|
34
|
+
## Options
|
|
35
|
+
|
|
36
|
+
- `--template lunar-rover`
|
|
37
|
+
- `--list-templates`
|
|
38
|
+
- `--federation-name <name>`
|
|
39
|
+
- `--federate-name <name>`
|
|
40
|
+
- `--federate-type <type>`
|
|
41
|
+
- `--rti-host <host>`
|
|
42
|
+
- `--rti-port <port>`
|
|
43
|
+
- `--rti-use-tls`
|
|
44
|
+
- `--parent-reference-frame <frame>`
|
|
45
|
+
- `--rover-name <name>`
|
|
46
|
+
- `--rover-type <type>`
|
|
47
|
+
- `--rover-speed-mps <value>`
|
|
48
|
+
- `--lookahead-micros <value>`
|
|
49
|
+
- `--update-period-micros <value>`
|
|
50
|
+
- `--reference-frame-timeout-ms <value>`
|
|
51
|
+
- `--reference-frame-missing-mode <mode>`
|
|
52
|
+
- `--workspace-deps`
|
|
53
|
+
- `--yes`
|
|
54
|
+
|
|
55
|
+
`--workspace-deps` is for local monorepo validation. It writes
|
|
56
|
+
`"@hla4ts/spacekit": "workspace:*"` into the generated project instead of the
|
|
57
|
+
published semver range.
|
|
58
|
+
|
|
59
|
+
`--reference-frame-missing-mode` controls what the generated rover does when
|
|
60
|
+
its parent reference frame has not been published yet. The template default is
|
|
61
|
+
`continue`.
|
|
62
|
+
|
|
63
|
+
## Generated App
|
|
64
|
+
|
|
65
|
+
After scaffolding:
|
|
66
|
+
|
|
67
|
+
```bash
|
|
68
|
+
cd my-rover
|
|
69
|
+
bun install
|
|
70
|
+
bun run start
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
Edit `.env` to point at your RTI and federation.
|