@uns-kit/cli 0.0.14 → 0.0.15
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 +22 -1
- package/package.json +2 -2
- package/templates/default/README.md +4 -0
package/README.md
CHANGED
|
@@ -25,6 +25,8 @@ pnpm run dev
|
|
|
25
25
|
|
|
26
26
|
- `uns-kit create <name>` – create a new UNS project in the specified directory.
|
|
27
27
|
- `uns-kit configure-devops [path]` – add Azure DevOps tooling (dependencies, script, config) to an existing project.
|
|
28
|
+
- `uns-kit configure-vscode [path]` – copy VS Code launch/workspace files into an existing project.
|
|
29
|
+
- `uns-kit configure-codegen [path]` – scaffold GraphQL code generation and UNS refresh scripts.
|
|
28
30
|
- `uns-kit help` – display usage information.
|
|
29
31
|
|
|
30
32
|
### Configure Azure DevOps
|
|
@@ -37,7 +39,26 @@ pnpm install
|
|
|
37
39
|
pnpm run pull-request
|
|
38
40
|
```
|
|
39
41
|
|
|
40
|
-
The command prompts for your Azure DevOps organization and updates `config.json` along with the necessary dev dependencies.
|
|
42
|
+
The command prompts for your Azure DevOps organization/project, ensures the remote repository exists, and updates `config.json` along with the necessary dev dependencies.
|
|
43
|
+
|
|
44
|
+
### Configure VS Code workspace
|
|
45
|
+
|
|
46
|
+
```bash
|
|
47
|
+
uns-kit configure-vscode
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
Copies `.vscode/launch.json` plus a baseline workspace file into the project. Existing files are never overwritten, making it safe to re-run after hand edits.
|
|
51
|
+
|
|
52
|
+
### Configure GraphQL code generation
|
|
53
|
+
|
|
54
|
+
```bash
|
|
55
|
+
uns-kit configure-codegen
|
|
56
|
+
pnpm install
|
|
57
|
+
pnpm run codegen
|
|
58
|
+
pnpm run refresh-uns
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
Adds `codegen.ts`, seeds `src/uns/` placeholder types, and wires the GraphQL Code Generator / `refresh-uns` script into `package.json`. After installing the new dev dependencies you can regenerate strongly-typed operations (`pnpm run codegen`) and rebuild UNS topics/tags from your environment (`pnpm run refresh-uns`).
|
|
41
62
|
|
|
42
63
|
### Extend the Config Schema
|
|
43
64
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@uns-kit/cli",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.15",
|
|
4
4
|
"description": "Command line scaffolding tool for UNS applications",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"license": "MIT",
|
|
@@ -25,7 +25,7 @@
|
|
|
25
25
|
"templates"
|
|
26
26
|
],
|
|
27
27
|
"dependencies": {
|
|
28
|
-
"@uns-kit/core": "0.0.
|
|
28
|
+
"@uns-kit/core": "0.0.19"
|
|
29
29
|
},
|
|
30
30
|
"scripts": {
|
|
31
31
|
"build": "tsc -p tsconfig.build.json",
|
|
@@ -9,6 +9,8 @@ pnpm run dev # start the local development loop
|
|
|
9
9
|
pnpm run build # emit dist/ output
|
|
10
10
|
pnpm run start # run the compiled entrypoint
|
|
11
11
|
pnpm run generate-config-schema # regenerate config.schema.json and AppConfig types
|
|
12
|
+
pnpm run codegen # regenerate typed GraphQL operations (after configure-codegen)
|
|
13
|
+
pnpm run refresh-uns # rebuild UNS topics/tags from the live schema
|
|
12
14
|
```
|
|
13
15
|
|
|
14
16
|
## Configuration
|
|
@@ -21,4 +23,6 @@ Update `config.json` with your broker, UNS URLs, and credentials. The generated
|
|
|
21
23
|
- Create MQTT proxies or Temporal workflows inside `src/index.ts`.
|
|
22
24
|
- Extend `src/config/project.config.extension.ts` with project-specific sections and run `pnpm run generate-config-schema`.
|
|
23
25
|
- Run `uns-kit configure-devops` to add the Azure DevOps pull-request tooling.
|
|
26
|
+
- Run `uns-kit configure-vscode` to copy workspace/launch configuration for VS Code.
|
|
27
|
+
- Run `uns-kit configure-codegen` to scaffold GraphQL code generation and UNS refresh scripts.
|
|
24
28
|
- Commit your new project and start building!
|