uicontract 0.1.0
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/LICENSE +21 -0
- package/README.md +60 -0
- package/dist/bin/uic.d.ts +9 -0
- package/dist/bin/uic.d.ts.map +1 -0
- package/dist/bin/uic.js +87 -0
- package/dist/bin/uic.js.map +1 -0
- package/dist/commands/annotate.d.ts +21 -0
- package/dist/commands/annotate.d.ts.map +1 -0
- package/dist/commands/annotate.js +236 -0
- package/dist/commands/annotate.js.map +1 -0
- package/dist/commands/describe.d.ts +19 -0
- package/dist/commands/describe.d.ts.map +1 -0
- package/dist/commands/describe.js +146 -0
- package/dist/commands/describe.js.map +1 -0
- package/dist/commands/diff.d.ts +57 -0
- package/dist/commands/diff.d.ts.map +1 -0
- package/dist/commands/diff.js +404 -0
- package/dist/commands/diff.js.map +1 -0
- package/dist/commands/find.d.ts +34 -0
- package/dist/commands/find.d.ts.map +1 -0
- package/dist/commands/find.js +229 -0
- package/dist/commands/find.js.map +1 -0
- package/dist/commands/index.d.ts +18 -0
- package/dist/commands/index.d.ts.map +1 -0
- package/dist/commands/index.js +11 -0
- package/dist/commands/index.js.map +1 -0
- package/dist/commands/list.d.ts +23 -0
- package/dist/commands/list.d.ts.map +1 -0
- package/dist/commands/list.js +238 -0
- package/dist/commands/list.js.map +1 -0
- package/dist/commands/name.d.ts +21 -0
- package/dist/commands/name.d.ts.map +1 -0
- package/dist/commands/name.js +154 -0
- package/dist/commands/name.js.map +1 -0
- package/dist/commands/scan.d.ts +32 -0
- package/dist/commands/scan.d.ts.map +1 -0
- package/dist/commands/scan.js +294 -0
- package/dist/commands/scan.js.map +1 -0
- package/dist/fuzzy-match.d.ts +45 -0
- package/dist/fuzzy-match.d.ts.map +1 -0
- package/dist/fuzzy-match.js +134 -0
- package/dist/fuzzy-match.js.map +1 -0
- package/dist/index.d.ts +5 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +5 -0
- package/dist/index.js.map +1 -0
- package/package.json +63 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 UIC Contributors
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
# uic
|
|
2
|
+
|
|
3
|
+
CLI tool that makes web app UIs machine-readable for AI agents.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install -g uic
|
|
9
|
+
# or use without installing:
|
|
10
|
+
npx uic <command>
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Usage
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
# Scan a project and produce a manifest
|
|
17
|
+
npx uic scan ./my-app
|
|
18
|
+
|
|
19
|
+
# Find elements by label or ID pattern
|
|
20
|
+
npx uic find "login"
|
|
21
|
+
|
|
22
|
+
# Describe a specific element
|
|
23
|
+
npx uic describe settings.billing.pause-subscription.button
|
|
24
|
+
|
|
25
|
+
# List all elements in the manifest
|
|
26
|
+
npx uic list
|
|
27
|
+
|
|
28
|
+
# Insert data-agent-id attributes into source files (dry run first)
|
|
29
|
+
npx uic annotate --dry-run
|
|
30
|
+
npx uic annotate
|
|
31
|
+
|
|
32
|
+
# Diff the current manifest against a baseline (CI gate)
|
|
33
|
+
npx uic diff
|
|
34
|
+
|
|
35
|
+
# All commands support --help and --json
|
|
36
|
+
npx uic scan --help
|
|
37
|
+
npx uic list --json
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
## Commands
|
|
41
|
+
|
|
42
|
+
| Command | Description |
|
|
43
|
+
|------------|----------------------------------------------------------------|
|
|
44
|
+
| `scan` | Parse source files and generate `manifest.json` |
|
|
45
|
+
| `name` | Assign hierarchical agent IDs to discovered elements |
|
|
46
|
+
| `annotate` | Insert `data-agent-id` attributes into source files |
|
|
47
|
+
| `find` | Search elements by label, ID pattern, or type |
|
|
48
|
+
| `describe` | Show full details for a single element by agent ID |
|
|
49
|
+
| `list` | List all elements in the manifest |
|
|
50
|
+
| `diff` | Compare two manifests and report breaking changes |
|
|
51
|
+
|
|
52
|
+
Every command accepts `--help` for flag documentation and `--json` for machine-readable output.
|
|
53
|
+
|
|
54
|
+
## Part of UIC
|
|
55
|
+
|
|
56
|
+
This package is part of [UIC (UI Contracts)](https://github.com/sherifkozman/uicontract) — making web app UIs machine-readable.
|
|
57
|
+
|
|
58
|
+
## License
|
|
59
|
+
|
|
60
|
+
[MIT](../../LICENSE)
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"uic.d.ts","sourceRoot":"","sources":["../../src/bin/uic.ts"],"names":[],"mappings":";AACA;;;;;GAKG"}
|
package/dist/bin/uic.js
ADDED
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
/**
|
|
3
|
+
* uic CLI entry point.
|
|
4
|
+
*
|
|
5
|
+
* stdout: command output (manifests, query results)
|
|
6
|
+
* stderr: logs, errors, help
|
|
7
|
+
*/
|
|
8
|
+
import { VERSION } from '@uicontract/core';
|
|
9
|
+
import { scanCommand, findCommand, describeCommand, listCommand, diffCommand, nameCommand, annotateCommand, } from '../commands/index.js';
|
|
10
|
+
const MAIN_HELP = `\
|
|
11
|
+
uic — makes web app UIs machine-readable
|
|
12
|
+
|
|
13
|
+
USAGE
|
|
14
|
+
uic <command> [options]
|
|
15
|
+
|
|
16
|
+
COMMANDS
|
|
17
|
+
scan <directory> Scan a project and emit a UI manifest
|
|
18
|
+
name <manifest> Assign stable agent IDs to elements in a manifest
|
|
19
|
+
annotate Insert data-agent-id attributes into source files
|
|
20
|
+
find <query> Search for elements by name, label, route, or handler
|
|
21
|
+
describe <id> Show full details of an element by agent ID
|
|
22
|
+
list List all elements with optional filtering
|
|
23
|
+
diff <old> <new> Compare two manifests and report changes
|
|
24
|
+
|
|
25
|
+
GLOBAL OPTIONS
|
|
26
|
+
--version, -V Print the uic version and exit
|
|
27
|
+
--help, -h Show this help message
|
|
28
|
+
|
|
29
|
+
Run "uicontract <command> --help" for command-specific help.
|
|
30
|
+
e.g. uic scan --help
|
|
31
|
+
`;
|
|
32
|
+
async function main() {
|
|
33
|
+
const args = process.argv.slice(2);
|
|
34
|
+
const [command, ...rest] = args;
|
|
35
|
+
// Global --version / -V
|
|
36
|
+
if (command === '--version' || command === '-V') {
|
|
37
|
+
process.stdout.write(`uic v${VERSION}\n`);
|
|
38
|
+
process.exit(0);
|
|
39
|
+
}
|
|
40
|
+
// Global --help / -h (or no args)
|
|
41
|
+
if (command === '--help' || command === '-h' || command === undefined) {
|
|
42
|
+
process.stderr.write(MAIN_HELP);
|
|
43
|
+
process.exit(0);
|
|
44
|
+
}
|
|
45
|
+
// Route to subcommands
|
|
46
|
+
if (command === 'scan') {
|
|
47
|
+
const code = await scanCommand(rest);
|
|
48
|
+
process.exit(code);
|
|
49
|
+
}
|
|
50
|
+
if (command === 'find') {
|
|
51
|
+
const code = await findCommand(rest);
|
|
52
|
+
process.exit(code);
|
|
53
|
+
}
|
|
54
|
+
if (command === 'describe') {
|
|
55
|
+
const code = await describeCommand(rest);
|
|
56
|
+
process.exit(code);
|
|
57
|
+
}
|
|
58
|
+
if (command === 'list') {
|
|
59
|
+
const code = await listCommand(rest);
|
|
60
|
+
process.exit(code);
|
|
61
|
+
}
|
|
62
|
+
if (command === 'diff') {
|
|
63
|
+
const code = await diffCommand(rest);
|
|
64
|
+
process.exit(code);
|
|
65
|
+
}
|
|
66
|
+
if (command === 'name') {
|
|
67
|
+
const code = await nameCommand(rest);
|
|
68
|
+
process.exit(code);
|
|
69
|
+
}
|
|
70
|
+
if (command === 'annotate') {
|
|
71
|
+
const code = await annotateCommand(rest);
|
|
72
|
+
process.exit(code);
|
|
73
|
+
}
|
|
74
|
+
// Unknown command
|
|
75
|
+
process.stderr.write(`Error: Unknown command "${command}". Run "uicontract --help" for the list of commands.\n`);
|
|
76
|
+
// Provide a hint if the user forgot to specify a subcommand and passed a path
|
|
77
|
+
if (command.startsWith('.') || command.startsWith('/')) {
|
|
78
|
+
process.stderr.write(`Hint: Did you mean "uicontract scan ${command}"?\n`);
|
|
79
|
+
}
|
|
80
|
+
process.exit(1);
|
|
81
|
+
}
|
|
82
|
+
main().catch((err) => {
|
|
83
|
+
const message = err instanceof Error ? err.message : String(err);
|
|
84
|
+
process.stderr.write(`Fatal: ${message}\n`);
|
|
85
|
+
process.exit(1);
|
|
86
|
+
});
|
|
87
|
+
//# sourceMappingURL=uic.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"uic.js","sourceRoot":"","sources":["../../src/bin/uic.ts"],"names":[],"mappings":";AACA;;;;;GAKG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAC3C,OAAO,EACL,WAAW,EACX,WAAW,EACX,eAAe,EACf,WAAW,EACX,WAAW,EACX,WAAW,EACX,eAAe,GAChB,MAAM,sBAAsB,CAAC;AAE9B,MAAM,SAAS,GAAG;;;;;;;;;;;;;;;;;;;;;CAqBjB,CAAC;AAEF,KAAK,UAAU,IAAI;IACjB,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACnC,MAAM,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAEhC,wBAAwB;IACxB,IAAI,OAAO,KAAK,WAAW,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;QAChD,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,OAAO,IAAI,CAAC,CAAC;QAC1C,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IAED,kCAAkC;IAClC,IAAI,OAAO,KAAK,QAAQ,IAAI,OAAO,KAAK,IAAI,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;QACtE,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAChC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IAED,uBAAuB;IACvB,IAAI,OAAO,KAAK,MAAM,EAAE,CAAC;QACvB,MAAM,IAAI,GAAG,MAAM,WAAW,CAAC,IAAI,CAAC,CAAC;QACrC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACrB,CAAC;IAED,IAAI,OAAO,KAAK,MAAM,EAAE,CAAC;QACvB,MAAM,IAAI,GAAG,MAAM,WAAW,CAAC,IAAI,CAAC,CAAC;QACrC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACrB,CAAC;IAED,IAAI,OAAO,KAAK,UAAU,EAAE,CAAC;QAC3B,MAAM,IAAI,GAAG,MAAM,eAAe,CAAC,IAAI,CAAC,CAAC;QACzC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACrB,CAAC;IAED,IAAI,OAAO,KAAK,MAAM,EAAE,CAAC;QACvB,MAAM,IAAI,GAAG,MAAM,WAAW,CAAC,IAAI,CAAC,CAAC;QACrC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACrB,CAAC;IAED,IAAI,OAAO,KAAK,MAAM,EAAE,CAAC;QACvB,MAAM,IAAI,GAAG,MAAM,WAAW,CAAC,IAAI,CAAC,CAAC;QACrC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACrB,CAAC;IAED,IAAI,OAAO,KAAK,MAAM,EAAE,CAAC;QACvB,MAAM,IAAI,GAAG,MAAM,WAAW,CAAC,IAAI,CAAC,CAAC;QACrC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACrB,CAAC;IAED,IAAI,OAAO,KAAK,UAAU,EAAE,CAAC;QAC3B,MAAM,IAAI,GAAG,MAAM,eAAe,CAAC,IAAI,CAAC,CAAC;QACzC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACrB,CAAC;IAED,kBAAkB;IAClB,OAAO,CAAC,MAAM,CAAC,KAAK,CAClB,2BAA2B,OAAO,wDAAwD,CAC3F,CAAC;IAEF,8EAA8E;IAC9E,IAAI,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;QACvD,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,uCAAuC,OAAO,MAAM,CAAC,CAAC;IAC7E,CAAC;IAED,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC;AAED,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,GAAY,EAAE,EAAE;IAC5B,MAAM,OAAO,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IACjE,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,OAAO,IAAI,CAAC,CAAC;IAC5C,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC,CAAC,CAAC"}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* `uic annotate` command — insert data-agent-id attributes into source files.
|
|
3
|
+
*
|
|
4
|
+
* stdout: unified diff patches (or JSON)
|
|
5
|
+
* stderr: logs, errors, help text
|
|
6
|
+
*/
|
|
7
|
+
export declare const ANNOTATE_HELP = "uic annotate [options]\n\nInsert data-agent-id attributes into source files based on a manifest.\n\nOPTIONS\n --manifest <path> Path to manifest file (default: manifest.json)\n --dry-run Show patches without modifying files (default)\n --write Modify source files in-place (creates backup first)\n --backup-dir <dir> Backup directory (default: .uic-backup)\n --json Output results as JSON\n --help, -h Show this help message\n\nEXAMPLES\n uic annotate\n uic annotate --manifest named-manifest.json --dry-run\n uic annotate --write\n uic annotate --write --backup-dir ./my-backup\n uic annotate --json\n\nRun \"uicontract --help\" for the full list of commands.\n";
|
|
8
|
+
export interface AnnotateArgs {
|
|
9
|
+
manifest: string;
|
|
10
|
+
dryRun: boolean;
|
|
11
|
+
write: boolean;
|
|
12
|
+
backupDir: string;
|
|
13
|
+
json: boolean;
|
|
14
|
+
help: boolean;
|
|
15
|
+
}
|
|
16
|
+
export interface AnnotateArgsError {
|
|
17
|
+
error: string;
|
|
18
|
+
}
|
|
19
|
+
export declare function parseAnnotateArgs(args: string[]): AnnotateArgs | AnnotateArgsError;
|
|
20
|
+
export declare function annotateCommand(args: string[]): Promise<number>;
|
|
21
|
+
//# sourceMappingURL=annotate.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"annotate.d.ts","sourceRoot":"","sources":["../../src/commands/annotate.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAkBH,eAAO,MAAM,aAAa,uuBAqBzB,CAAC;AAMF,MAAM,WAAW,YAAY;IAC3B,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,OAAO,CAAC;IAChB,KAAK,EAAE,OAAO,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,OAAO,CAAC;IACd,IAAI,EAAE,OAAO,CAAC;CACf;AAED,MAAM,WAAW,iBAAiB;IAChC,KAAK,EAAE,MAAM,CAAC;CACf;AAED,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,YAAY,GAAG,iBAAiB,CA2DlF;AAkCD,wBAAsB,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,CAsIrE"}
|
|
@@ -0,0 +1,236 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* `uic annotate` command — insert data-agent-id attributes into source files.
|
|
3
|
+
*
|
|
4
|
+
* stdout: unified diff patches (or JSON)
|
|
5
|
+
* stderr: logs, errors, help text
|
|
6
|
+
*/
|
|
7
|
+
import * as fs from 'node:fs/promises';
|
|
8
|
+
import * as path from 'node:path';
|
|
9
|
+
import { deserializeManifest } from '@uicontract/core';
|
|
10
|
+
import { annotateSource, generatePatch, createBackup, cleanupBackup, } from '@uicontract/annotator';
|
|
11
|
+
// ---------------------------------------------------------------------------
|
|
12
|
+
// Help text
|
|
13
|
+
// ---------------------------------------------------------------------------
|
|
14
|
+
export const ANNOTATE_HELP = `\
|
|
15
|
+
uic annotate [options]
|
|
16
|
+
|
|
17
|
+
Insert data-agent-id attributes into source files based on a manifest.
|
|
18
|
+
|
|
19
|
+
OPTIONS
|
|
20
|
+
--manifest <path> Path to manifest file (default: manifest.json)
|
|
21
|
+
--dry-run Show patches without modifying files (default)
|
|
22
|
+
--write Modify source files in-place (creates backup first)
|
|
23
|
+
--backup-dir <dir> Backup directory (default: .uic-backup)
|
|
24
|
+
--json Output results as JSON
|
|
25
|
+
--help, -h Show this help message
|
|
26
|
+
|
|
27
|
+
EXAMPLES
|
|
28
|
+
uic annotate
|
|
29
|
+
uic annotate --manifest named-manifest.json --dry-run
|
|
30
|
+
uic annotate --write
|
|
31
|
+
uic annotate --write --backup-dir ./my-backup
|
|
32
|
+
uic annotate --json
|
|
33
|
+
|
|
34
|
+
Run "uicontract --help" for the full list of commands.
|
|
35
|
+
`;
|
|
36
|
+
export function parseAnnotateArgs(args) {
|
|
37
|
+
let manifest = 'manifest.json';
|
|
38
|
+
let dryRun = false;
|
|
39
|
+
let write = false;
|
|
40
|
+
let backupDir = '.uic-backup';
|
|
41
|
+
let json = false;
|
|
42
|
+
let help = false;
|
|
43
|
+
for (let i = 0; i < args.length; i++) {
|
|
44
|
+
const arg = args[i];
|
|
45
|
+
if (arg === '--help' || arg === '-h') {
|
|
46
|
+
help = true;
|
|
47
|
+
continue;
|
|
48
|
+
}
|
|
49
|
+
if (arg === '--json') {
|
|
50
|
+
json = true;
|
|
51
|
+
continue;
|
|
52
|
+
}
|
|
53
|
+
if (arg === '--dry-run') {
|
|
54
|
+
dryRun = true;
|
|
55
|
+
continue;
|
|
56
|
+
}
|
|
57
|
+
if (arg === '--write') {
|
|
58
|
+
write = true;
|
|
59
|
+
continue;
|
|
60
|
+
}
|
|
61
|
+
if (arg === '--manifest') {
|
|
62
|
+
const next = args[i + 1];
|
|
63
|
+
if (next === undefined || next.startsWith('-')) {
|
|
64
|
+
return { error: 'Missing value for --manifest. Example: --manifest manifest.json' };
|
|
65
|
+
}
|
|
66
|
+
manifest = next;
|
|
67
|
+
i++;
|
|
68
|
+
continue;
|
|
69
|
+
}
|
|
70
|
+
if (arg === '--backup-dir') {
|
|
71
|
+
const next = args[i + 1];
|
|
72
|
+
if (next === undefined || next.startsWith('-')) {
|
|
73
|
+
return { error: 'Missing value for --backup-dir. Example: --backup-dir .uic-backup' };
|
|
74
|
+
}
|
|
75
|
+
backupDir = next;
|
|
76
|
+
i++;
|
|
77
|
+
continue;
|
|
78
|
+
}
|
|
79
|
+
if (arg !== undefined && arg.startsWith('-')) {
|
|
80
|
+
return { error: `Unknown option: ${arg}. Run "uicontract annotate --help" for usage.` };
|
|
81
|
+
}
|
|
82
|
+
if (arg !== undefined) {
|
|
83
|
+
return { error: `Unexpected argument: "${arg}". "uicontract annotate" takes no positional arguments.` };
|
|
84
|
+
}
|
|
85
|
+
}
|
|
86
|
+
// Default to dry-run if --write not specified
|
|
87
|
+
if (!write) {
|
|
88
|
+
dryRun = true;
|
|
89
|
+
}
|
|
90
|
+
return { manifest, dryRun, write, backupDir, json, help };
|
|
91
|
+
}
|
|
92
|
+
// ---------------------------------------------------------------------------
|
|
93
|
+
// Helpers
|
|
94
|
+
// ---------------------------------------------------------------------------
|
|
95
|
+
/** Group elements by their file path. */
|
|
96
|
+
function groupByFile(elements) {
|
|
97
|
+
const groups = new Map();
|
|
98
|
+
for (const el of elements) {
|
|
99
|
+
const existing = groups.get(el.filePath);
|
|
100
|
+
if (existing !== undefined) {
|
|
101
|
+
existing.push(el);
|
|
102
|
+
}
|
|
103
|
+
else {
|
|
104
|
+
groups.set(el.filePath, [el]);
|
|
105
|
+
}
|
|
106
|
+
}
|
|
107
|
+
return groups;
|
|
108
|
+
}
|
|
109
|
+
/** Convert NamedElements to AnnotationTargets. */
|
|
110
|
+
function toTargets(elements) {
|
|
111
|
+
return elements.map((el) => ({
|
|
112
|
+
agentId: el.agentId,
|
|
113
|
+
line: el.line,
|
|
114
|
+
column: el.column,
|
|
115
|
+
type: el.type,
|
|
116
|
+
}));
|
|
117
|
+
}
|
|
118
|
+
// ---------------------------------------------------------------------------
|
|
119
|
+
// Main command
|
|
120
|
+
// ---------------------------------------------------------------------------
|
|
121
|
+
export async function annotateCommand(args) {
|
|
122
|
+
const parsed = parseAnnotateArgs(args);
|
|
123
|
+
if ('error' in parsed) {
|
|
124
|
+
process.stderr.write(`Error: ${parsed.error}\n`);
|
|
125
|
+
return 1;
|
|
126
|
+
}
|
|
127
|
+
if (parsed.help) {
|
|
128
|
+
process.stderr.write(ANNOTATE_HELP);
|
|
129
|
+
return 0;
|
|
130
|
+
}
|
|
131
|
+
const manifestPath = path.resolve(parsed.manifest);
|
|
132
|
+
// Load manifest
|
|
133
|
+
let manifest;
|
|
134
|
+
try {
|
|
135
|
+
const raw = await fs.readFile(manifestPath, 'utf-8');
|
|
136
|
+
manifest = deserializeManifest(raw);
|
|
137
|
+
}
|
|
138
|
+
catch (err) {
|
|
139
|
+
const message = err instanceof Error ? err.message : String(err);
|
|
140
|
+
process.stderr.write(`Error: Failed to load manifest "${manifestPath}": ${message}\n` +
|
|
141
|
+
`Run "uicontract scan <dir>" first to generate a manifest, or specify --manifest <path>.\n`);
|
|
142
|
+
return 1;
|
|
143
|
+
}
|
|
144
|
+
if (manifest.elements.length === 0) {
|
|
145
|
+
if (parsed.json) {
|
|
146
|
+
process.stdout.write(JSON.stringify({ files: [], totalApplied: 0, totalSkipped: 0 }, null, 2) + '\n');
|
|
147
|
+
}
|
|
148
|
+
else {
|
|
149
|
+
process.stdout.write('No elements to annotate.\n');
|
|
150
|
+
}
|
|
151
|
+
return 0;
|
|
152
|
+
}
|
|
153
|
+
// Group elements by file
|
|
154
|
+
const fileGroups = groupByFile(manifest.elements);
|
|
155
|
+
const results = [];
|
|
156
|
+
let totalApplied = 0;
|
|
157
|
+
let totalSkipped = 0;
|
|
158
|
+
const modifiedFiles = [];
|
|
159
|
+
const patches = [];
|
|
160
|
+
for (const [filePath, elements] of fileGroups) {
|
|
161
|
+
const resolvedPath = path.resolve(filePath);
|
|
162
|
+
// Read source file
|
|
163
|
+
let source;
|
|
164
|
+
try {
|
|
165
|
+
source = await fs.readFile(resolvedPath, 'utf-8');
|
|
166
|
+
}
|
|
167
|
+
catch {
|
|
168
|
+
process.stderr.write(`Warning: Could not read "${resolvedPath}", skipping.\n`);
|
|
169
|
+
continue;
|
|
170
|
+
}
|
|
171
|
+
const targets = toTargets(elements);
|
|
172
|
+
const annotationResult = annotateSource(source, targets);
|
|
173
|
+
if (!annotationResult.modified) {
|
|
174
|
+
results.push({
|
|
175
|
+
filePath,
|
|
176
|
+
annotationsApplied: 0,
|
|
177
|
+
annotationsSkipped: annotationResult.annotationsSkipped,
|
|
178
|
+
patch: null,
|
|
179
|
+
});
|
|
180
|
+
totalSkipped += annotationResult.annotationsSkipped;
|
|
181
|
+
continue;
|
|
182
|
+
}
|
|
183
|
+
const patch = generatePatch(filePath, source, annotationResult.annotatedSource);
|
|
184
|
+
patches.push(patch);
|
|
185
|
+
modifiedFiles.push(resolvedPath);
|
|
186
|
+
results.push({
|
|
187
|
+
filePath,
|
|
188
|
+
annotationsApplied: annotationResult.annotationsApplied,
|
|
189
|
+
annotationsSkipped: annotationResult.annotationsSkipped,
|
|
190
|
+
patch,
|
|
191
|
+
});
|
|
192
|
+
totalApplied += annotationResult.annotationsApplied;
|
|
193
|
+
totalSkipped += annotationResult.annotationsSkipped;
|
|
194
|
+
}
|
|
195
|
+
// Output results
|
|
196
|
+
if (parsed.json) {
|
|
197
|
+
process.stdout.write(JSON.stringify({ files: results, totalApplied, totalSkipped }, null, 2) + '\n');
|
|
198
|
+
}
|
|
199
|
+
else if (parsed.write) {
|
|
200
|
+
// Create backup and write files
|
|
201
|
+
if (modifiedFiles.length === 0) {
|
|
202
|
+
process.stdout.write('No files need modification (all annotations already present).\n');
|
|
203
|
+
return 0;
|
|
204
|
+
}
|
|
205
|
+
const backup = await createBackup(modifiedFiles, { backupDir: parsed.backupDir });
|
|
206
|
+
// Write modified files
|
|
207
|
+
for (const result of results) {
|
|
208
|
+
if (result.patch === null)
|
|
209
|
+
continue;
|
|
210
|
+
const resolvedPath = path.resolve(result.filePath);
|
|
211
|
+
await fs.writeFile(resolvedPath, result.patch.modified, 'utf-8');
|
|
212
|
+
}
|
|
213
|
+
process.stderr.write(`Annotated ${String(modifiedFiles.length)} file(s)\n` +
|
|
214
|
+
` Annotations applied: ${String(totalApplied)}\n` +
|
|
215
|
+
` Annotations skipped: ${String(totalSkipped)}\n` +
|
|
216
|
+
` Backup: ${backup.backupDir}\n`);
|
|
217
|
+
// Cleanup backup after successful write
|
|
218
|
+
await cleanupBackup(backup);
|
|
219
|
+
}
|
|
220
|
+
else {
|
|
221
|
+
// Dry-run: output patches
|
|
222
|
+
if (patches.length === 0) {
|
|
223
|
+
process.stdout.write('No changes needed (all annotations already present).\n');
|
|
224
|
+
}
|
|
225
|
+
else {
|
|
226
|
+
for (const patch of patches) {
|
|
227
|
+
process.stdout.write(patch.diff);
|
|
228
|
+
process.stdout.write('\n');
|
|
229
|
+
}
|
|
230
|
+
process.stderr.write(`\nDry run: ${String(totalApplied)} annotation(s) would be applied across ${String(patches.length)} file(s).\n` +
|
|
231
|
+
`Run with --write to apply changes.\n`);
|
|
232
|
+
}
|
|
233
|
+
}
|
|
234
|
+
return 0;
|
|
235
|
+
}
|
|
236
|
+
//# sourceMappingURL=annotate.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"annotate.js","sourceRoot":"","sources":["../../src/commands/annotate.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,MAAM,kBAAkB,CAAC;AACvC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAClC,OAAO,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AAEvD,OAAO,EACL,cAAc,EACd,aAAa,EACb,YAAY,EACZ,aAAa,GACd,MAAM,uBAAuB,CAAC;AAG/B,8EAA8E;AAC9E,YAAY;AACZ,8EAA8E;AAE9E,MAAM,CAAC,MAAM,aAAa,GAAG;;;;;;;;;;;;;;;;;;;;;CAqB5B,CAAC;AAmBF,MAAM,UAAU,iBAAiB,CAAC,IAAc;IAC9C,IAAI,QAAQ,GAAG,eAAe,CAAC;IAC/B,IAAI,MAAM,GAAG,KAAK,CAAC;IACnB,IAAI,KAAK,GAAG,KAAK,CAAC;IAClB,IAAI,SAAS,GAAG,aAAa,CAAC;IAC9B,IAAI,IAAI,GAAG,KAAK,CAAC;IACjB,IAAI,IAAI,GAAG,KAAK,CAAC;IAEjB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACrC,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QAEpB,IAAI,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;YACrC,IAAI,GAAG,IAAI,CAAC;YACZ,SAAS;QACX,CAAC;QACD,IAAI,GAAG,KAAK,QAAQ,EAAE,CAAC;YACrB,IAAI,GAAG,IAAI,CAAC;YACZ,SAAS;QACX,CAAC;QACD,IAAI,GAAG,KAAK,WAAW,EAAE,CAAC;YACxB,MAAM,GAAG,IAAI,CAAC;YACd,SAAS;QACX,CAAC;QACD,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;YACtB,KAAK,GAAG,IAAI,CAAC;YACb,SAAS;QACX,CAAC;QACD,IAAI,GAAG,KAAK,YAAY,EAAE,CAAC;YACzB,MAAM,IAAI,GAAG,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YACzB,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC/C,OAAO,EAAE,KAAK,EAAE,iEAAiE,EAAE,CAAC;YACtF,CAAC;YACD,QAAQ,GAAG,IAAI,CAAC;YAChB,CAAC,EAAE,CAAC;YACJ,SAAS;QACX,CAAC;QACD,IAAI,GAAG,KAAK,cAAc,EAAE,CAAC;YAC3B,MAAM,IAAI,GAAG,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YACzB,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC/C,OAAO,EAAE,KAAK,EAAE,mEAAmE,EAAE,CAAC;YACxF,CAAC;YACD,SAAS,GAAG,IAAI,CAAC;YACjB,CAAC,EAAE,CAAC;YACJ,SAAS;QACX,CAAC;QACD,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YAC7C,OAAO,EAAE,KAAK,EAAE,mBAAmB,GAAG,+CAA+C,EAAE,CAAC;QAC1F,CAAC;QACD,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;YACtB,OAAO,EAAE,KAAK,EAAE,yBAAyB,GAAG,yDAAyD,EAAE,CAAC;QAC1G,CAAC;IACH,CAAC;IAED,8CAA8C;IAC9C,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,MAAM,GAAG,IAAI,CAAC;IAChB,CAAC;IAED,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;AAC5D,CAAC;AAED,8EAA8E;AAC9E,UAAU;AACV,8EAA8E;AAE9E,yCAAyC;AACzC,SAAS,WAAW,CAAC,QAAwB;IAC3C,MAAM,MAAM,GAAG,IAAI,GAAG,EAA0B,CAAC;IACjD,KAAK,MAAM,EAAE,IAAI,QAAQ,EAAE,CAAC;QAC1B,MAAM,QAAQ,GAAG,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC;QACzC,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YAC3B,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACpB,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QAChC,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,kDAAkD;AAClD,SAAS,SAAS,CAAC,QAAwB;IACzC,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;QAC3B,OAAO,EAAE,EAAE,CAAC,OAAO;QACnB,IAAI,EAAE,EAAE,CAAC,IAAI;QACb,MAAM,EAAE,EAAE,CAAC,MAAM;QACjB,IAAI,EAAE,EAAE,CAAC,IAAI;KACd,CAAC,CAAC,CAAC;AACN,CAAC;AAED,8EAA8E;AAC9E,eAAe;AACf,8EAA8E;AAE9E,MAAM,CAAC,KAAK,UAAU,eAAe,CAAC,IAAc;IAClD,MAAM,MAAM,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAEvC,IAAI,OAAO,IAAI,MAAM,EAAE,CAAC;QACtB,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,MAAM,CAAC,KAAK,IAAI,CAAC,CAAC;QACjD,OAAO,CAAC,CAAC;IACX,CAAC;IAED,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;QAChB,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;QACpC,OAAO,CAAC,CAAC;IACX,CAAC;IAED,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAEnD,gBAAgB;IAChB,IAAI,QAAkB,CAAC;IACvB,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;QACrD,QAAQ,GAAG,mBAAmB,CAAC,GAAG,CAAC,CAAC;IACtC,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,MAAM,OAAO,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACjE,OAAO,CAAC,MAAM,CAAC,KAAK,CAClB,mCAAmC,YAAY,MAAM,OAAO,IAAI;YAC9D,2FAA2F,CAC9F,CAAC;QACF,OAAO,CAAC,CAAC;IACX,CAAC;IAED,IAAI,QAAQ,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACnC,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;YAChB,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,YAAY,EAAE,CAAC,EAAE,YAAY,EAAE,CAAC,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;QACxG,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,4BAA4B,CAAC,CAAC;QACrD,CAAC;QACD,OAAO,CAAC,CAAC;IACX,CAAC;IAED,yBAAyB;IACzB,MAAM,UAAU,GAAG,WAAW,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAClD,MAAM,OAAO,GAAyB,EAAE,CAAC;IACzC,IAAI,YAAY,GAAG,CAAC,CAAC;IACrB,IAAI,YAAY,GAAG,CAAC,CAAC;IACrB,MAAM,aAAa,GAAa,EAAE,CAAC;IACnC,MAAM,OAAO,GAAgB,EAAE,CAAC;IAEhC,KAAK,MAAM,CAAC,QAAQ,EAAE,QAAQ,CAAC,IAAI,UAAU,EAAE,CAAC;QAC9C,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAE5C,mBAAmB;QACnB,IAAI,MAAc,CAAC;QACnB,IAAI,CAAC;YACH,MAAM,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;QACpD,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,4BAA4B,YAAY,gBAAgB,CAAC,CAAC;YAC/E,SAAS;QACX,CAAC;QAED,MAAM,OAAO,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC;QACpC,MAAM,gBAAgB,GAAG,cAAc,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAEzD,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,CAAC;YAC/B,OAAO,CAAC,IAAI,CAAC;gBACX,QAAQ;gBACR,kBAAkB,EAAE,CAAC;gBACrB,kBAAkB,EAAE,gBAAgB,CAAC,kBAAkB;gBACvD,KAAK,EAAE,IAAI;aACZ,CAAC,CAAC;YACH,YAAY,IAAI,gBAAgB,CAAC,kBAAkB,CAAC;YACpD,SAAS;QACX,CAAC;QAED,MAAM,KAAK,GAAG,aAAa,CAAC,QAAQ,EAAE,MAAM,EAAE,gBAAgB,CAAC,eAAe,CAAC,CAAC;QAChF,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACpB,aAAa,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAEjC,OAAO,CAAC,IAAI,CAAC;YACX,QAAQ;YACR,kBAAkB,EAAE,gBAAgB,CAAC,kBAAkB;YACvD,kBAAkB,EAAE,gBAAgB,CAAC,kBAAkB;YACvD,KAAK;SACN,CAAC,CAAC;QAEH,YAAY,IAAI,gBAAgB,CAAC,kBAAkB,CAAC;QACpD,YAAY,IAAI,gBAAgB,CAAC,kBAAkB,CAAC;IACtD,CAAC;IAED,iBAAiB;IACjB,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;QAChB,OAAO,CAAC,MAAM,CAAC,KAAK,CAClB,IAAI,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,GAAG,IAAI,CAC/E,CAAC;IACJ,CAAC;SAAM,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;QACxB,gCAAgC;QAChC,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC/B,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,iEAAiE,CAAC,CAAC;YACxF,OAAO,CAAC,CAAC;QACX,CAAC;QAED,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,aAAa,EAAE,EAAE,SAAS,EAAE,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC;QAElF,uBAAuB;QACvB,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC7B,IAAI,MAAM,CAAC,KAAK,KAAK,IAAI;gBAAE,SAAS;YACpC,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YACnD,MAAM,EAAE,CAAC,SAAS,CAAC,YAAY,EAAE,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QACnE,CAAC;QAED,OAAO,CAAC,MAAM,CAAC,KAAK,CAClB,aAAa,MAAM,CAAC,aAAa,CAAC,MAAM,CAAC,YAAY;YACnD,0BAA0B,MAAM,CAAC,YAAY,CAAC,IAAI;YAClD,0BAA0B,MAAM,CAAC,YAAY,CAAC,IAAI;YAClD,aAAa,MAAM,CAAC,SAAS,IAAI,CACpC,CAAC;QAEF,wCAAwC;QACxC,MAAM,aAAa,CAAC,MAAM,CAAC,CAAC;IAC9B,CAAC;SAAM,CAAC;QACN,0BAA0B;QAC1B,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACzB,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,wDAAwD,CAAC,CAAC;QACjF,CAAC;aAAM,CAAC;YACN,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;gBAC5B,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBACjC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAC7B,CAAC;YACD,OAAO,CAAC,MAAM,CAAC,KAAK,CAClB,cAAc,MAAM,CAAC,YAAY,CAAC,0CAA0C,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,aAAa;gBAC7G,sCAAsC,CACzC,CAAC;QACJ,CAAC;IACH,CAAC;IAED,OAAO,CAAC,CAAC;AACX,CAAC"}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* `uic describe` command — show full details of a single element by agentId.
|
|
3
|
+
*
|
|
4
|
+
* stdout: element details (human-readable or JSON)
|
|
5
|
+
* stderr: logs, errors, help text
|
|
6
|
+
*/
|
|
7
|
+
export declare const DESCRIBE_HELP = "uic describe <agent-id> [options]\n\nShow full details of an interactive UI element by its agent ID.\n\nARGUMENTS\n <agent-id> The agent ID of the element to describe\n\nOPTIONS\n --manifest <path> Path to manifest file (default: manifest.json)\n --json Output element as JSON\n --help, -h Show this help message\n\nEXAMPLES\n uic describe settings.billing.pause-btn.button\n uic describe login.email.input --json\n uic describe nav.home.a --manifest dist/manifest.json\n\nRun \"uicontract --help\" for the full list of commands.\n";
|
|
8
|
+
export interface DescribeArgs {
|
|
9
|
+
agentId: string | undefined;
|
|
10
|
+
manifest: string;
|
|
11
|
+
json: boolean;
|
|
12
|
+
help: boolean;
|
|
13
|
+
}
|
|
14
|
+
export interface DescribeArgsError {
|
|
15
|
+
error: string;
|
|
16
|
+
}
|
|
17
|
+
export declare function parseDescribeArgs(args: string[]): DescribeArgs | DescribeArgsError;
|
|
18
|
+
export declare function describeCommand(args: string[]): Promise<number>;
|
|
19
|
+
//# sourceMappingURL=describe.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"describe.d.ts","sourceRoot":"","sources":["../../src/commands/describe.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAWH,eAAO,MAAM,aAAa,4kBAmBzB,CAAC;AAMF,MAAM,WAAW,YAAY;IAC3B,OAAO,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,OAAO,CAAC;IACd,IAAI,EAAE,OAAO,CAAC;CACf;AAED,MAAM,WAAW,iBAAiB;IAChC,KAAK,EAAE,MAAM,CAAC;CACf;AAED,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,YAAY,GAAG,iBAAiB,CA2ClF;AAoCD,wBAAsB,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,CAqDrE"}
|
|
@@ -0,0 +1,146 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* `uic describe` command — show full details of a single element by agentId.
|
|
3
|
+
*
|
|
4
|
+
* stdout: element details (human-readable or JSON)
|
|
5
|
+
* stderr: logs, errors, help text
|
|
6
|
+
*/
|
|
7
|
+
import * as fs from 'node:fs/promises';
|
|
8
|
+
import * as path from 'node:path';
|
|
9
|
+
import { deserializeManifest } from '@uicontract/core';
|
|
10
|
+
// ---------------------------------------------------------------------------
|
|
11
|
+
// Help text
|
|
12
|
+
// ---------------------------------------------------------------------------
|
|
13
|
+
export const DESCRIBE_HELP = `\
|
|
14
|
+
uic describe <agent-id> [options]
|
|
15
|
+
|
|
16
|
+
Show full details of an interactive UI element by its agent ID.
|
|
17
|
+
|
|
18
|
+
ARGUMENTS
|
|
19
|
+
<agent-id> The agent ID of the element to describe
|
|
20
|
+
|
|
21
|
+
OPTIONS
|
|
22
|
+
--manifest <path> Path to manifest file (default: manifest.json)
|
|
23
|
+
--json Output element as JSON
|
|
24
|
+
--help, -h Show this help message
|
|
25
|
+
|
|
26
|
+
EXAMPLES
|
|
27
|
+
uic describe settings.billing.pause-btn.button
|
|
28
|
+
uic describe login.email.input --json
|
|
29
|
+
uic describe nav.home.a --manifest dist/manifest.json
|
|
30
|
+
|
|
31
|
+
Run "uicontract --help" for the full list of commands.
|
|
32
|
+
`;
|
|
33
|
+
export function parseDescribeArgs(args) {
|
|
34
|
+
let manifest = 'manifest.json';
|
|
35
|
+
let json = false;
|
|
36
|
+
let help = false;
|
|
37
|
+
const positionals = [];
|
|
38
|
+
for (let i = 0; i < args.length; i++) {
|
|
39
|
+
const arg = args[i];
|
|
40
|
+
if (arg === '--help' || arg === '-h') {
|
|
41
|
+
help = true;
|
|
42
|
+
continue;
|
|
43
|
+
}
|
|
44
|
+
if (arg === '--json') {
|
|
45
|
+
json = true;
|
|
46
|
+
continue;
|
|
47
|
+
}
|
|
48
|
+
if (arg === '--manifest') {
|
|
49
|
+
const next = args[i + 1];
|
|
50
|
+
if (next === undefined || next.startsWith('-')) {
|
|
51
|
+
return { error: 'Missing value for --manifest. Example: --manifest manifest.json' };
|
|
52
|
+
}
|
|
53
|
+
manifest = next;
|
|
54
|
+
i++;
|
|
55
|
+
continue;
|
|
56
|
+
}
|
|
57
|
+
if (arg !== undefined && arg.startsWith('-')) {
|
|
58
|
+
return { error: `Unknown option: ${arg}. Run "uicontract describe --help" for usage.` };
|
|
59
|
+
}
|
|
60
|
+
if (arg !== undefined) {
|
|
61
|
+
positionals.push(arg);
|
|
62
|
+
}
|
|
63
|
+
}
|
|
64
|
+
if (!help && positionals.length === 0) {
|
|
65
|
+
return { error: 'Missing required argument <agent-id>. Run "uicontract describe --help" for usage.' };
|
|
66
|
+
}
|
|
67
|
+
if (positionals.length > 1) {
|
|
68
|
+
return { error: `Unexpected argument: "${positionals[1] ?? ''}". Only one agent-id is accepted.` };
|
|
69
|
+
}
|
|
70
|
+
return { agentId: positionals[0], manifest, json, help };
|
|
71
|
+
}
|
|
72
|
+
// ---------------------------------------------------------------------------
|
|
73
|
+
// Formatting
|
|
74
|
+
// ---------------------------------------------------------------------------
|
|
75
|
+
function formatElementDetail(el) {
|
|
76
|
+
const lines = [
|
|
77
|
+
`Agent ID: ${el.agentId}`,
|
|
78
|
+
`Type: ${el.type}`,
|
|
79
|
+
`File: ${el.filePath}:${String(el.line)}:${String(el.column)}`,
|
|
80
|
+
`Component: ${el.componentName ?? '(none)'}`,
|
|
81
|
+
`Route: ${el.route ?? '(none)'}`,
|
|
82
|
+
`Label: ${el.label !== null ? `"${el.label}"` : '(none)'}`,
|
|
83
|
+
`Handler: ${el.handler ?? '(none)'}`,
|
|
84
|
+
`Conditional: ${String(el.conditional)}`,
|
|
85
|
+
`Dynamic: ${String(el.dynamic)}`,
|
|
86
|
+
];
|
|
87
|
+
const attrKeys = Object.keys(el.attributes);
|
|
88
|
+
if (attrKeys.length > 0) {
|
|
89
|
+
lines.push('Attributes:');
|
|
90
|
+
for (const key of attrKeys) {
|
|
91
|
+
lines.push(` ${key}: "${el.attributes[key] ?? ''}"`);
|
|
92
|
+
}
|
|
93
|
+
}
|
|
94
|
+
else {
|
|
95
|
+
lines.push('Attributes: (none)');
|
|
96
|
+
}
|
|
97
|
+
return lines.join('\n');
|
|
98
|
+
}
|
|
99
|
+
// ---------------------------------------------------------------------------
|
|
100
|
+
// Main command
|
|
101
|
+
// ---------------------------------------------------------------------------
|
|
102
|
+
export async function describeCommand(args) {
|
|
103
|
+
const parsed = parseDescribeArgs(args);
|
|
104
|
+
if ('error' in parsed) {
|
|
105
|
+
process.stderr.write(`Error: ${parsed.error}\n`);
|
|
106
|
+
return 1;
|
|
107
|
+
}
|
|
108
|
+
if (parsed.help) {
|
|
109
|
+
process.stderr.write(DESCRIBE_HELP);
|
|
110
|
+
return 0;
|
|
111
|
+
}
|
|
112
|
+
const agentId = parsed.agentId;
|
|
113
|
+
const manifestPath = path.resolve(parsed.manifest);
|
|
114
|
+
let raw;
|
|
115
|
+
try {
|
|
116
|
+
raw = await fs.readFile(manifestPath, 'utf-8');
|
|
117
|
+
}
|
|
118
|
+
catch {
|
|
119
|
+
process.stderr.write(`Error: Manifest not found at "${manifestPath}". ` +
|
|
120
|
+
`Run "uicontract scan <dir>" first to generate a manifest, or specify --manifest <path>.\n`);
|
|
121
|
+
return 1;
|
|
122
|
+
}
|
|
123
|
+
let manifest;
|
|
124
|
+
try {
|
|
125
|
+
manifest = deserializeManifest(raw);
|
|
126
|
+
}
|
|
127
|
+
catch (err) {
|
|
128
|
+
const message = err instanceof Error ? err.message : String(err);
|
|
129
|
+
process.stderr.write(`Error: Invalid manifest: ${message}\n`);
|
|
130
|
+
return 1;
|
|
131
|
+
}
|
|
132
|
+
const element = manifest.elements.find((el) => el.agentId === agentId);
|
|
133
|
+
if (element === undefined) {
|
|
134
|
+
process.stderr.write(`Error: No element found with agent ID "${agentId}". ` +
|
|
135
|
+
`Run "uicontract list" to see all available elements, or "uicontract find <query>" to search.\n`);
|
|
136
|
+
return 1;
|
|
137
|
+
}
|
|
138
|
+
if (parsed.json) {
|
|
139
|
+
process.stdout.write(JSON.stringify(element, null, 2) + '\n');
|
|
140
|
+
}
|
|
141
|
+
else {
|
|
142
|
+
process.stdout.write(formatElementDetail(element) + '\n');
|
|
143
|
+
}
|
|
144
|
+
return 0;
|
|
145
|
+
}
|
|
146
|
+
//# sourceMappingURL=describe.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"describe.js","sourceRoot":"","sources":["../../src/commands/describe.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,MAAM,kBAAkB,CAAC;AACvC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAClC,OAAO,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AAGvD,8EAA8E;AAC9E,YAAY;AACZ,8EAA8E;AAE9E,MAAM,CAAC,MAAM,aAAa,GAAG;;;;;;;;;;;;;;;;;;;CAmB5B,CAAC;AAiBF,MAAM,UAAU,iBAAiB,CAAC,IAAc;IAC9C,IAAI,QAAQ,GAAG,eAAe,CAAC;IAC/B,IAAI,IAAI,GAAG,KAAK,CAAC;IACjB,IAAI,IAAI,GAAG,KAAK,CAAC;IACjB,MAAM,WAAW,GAAa,EAAE,CAAC;IAEjC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACrC,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QAEpB,IAAI,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;YACrC,IAAI,GAAG,IAAI,CAAC;YACZ,SAAS;QACX,CAAC;QACD,IAAI,GAAG,KAAK,QAAQ,EAAE,CAAC;YACrB,IAAI,GAAG,IAAI,CAAC;YACZ,SAAS;QACX,CAAC;QACD,IAAI,GAAG,KAAK,YAAY,EAAE,CAAC;YACzB,MAAM,IAAI,GAAG,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YACzB,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC/C,OAAO,EAAE,KAAK,EAAE,iEAAiE,EAAE,CAAC;YACtF,CAAC;YACD,QAAQ,GAAG,IAAI,CAAC;YAChB,CAAC,EAAE,CAAC;YACJ,SAAS;QACX,CAAC;QACD,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YAC7C,OAAO,EAAE,KAAK,EAAE,mBAAmB,GAAG,+CAA+C,EAAE,CAAC;QAC1F,CAAC;QACD,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;YACtB,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACxB,CAAC;IACH,CAAC;IAED,IAAI,CAAC,IAAI,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACtC,OAAO,EAAE,KAAK,EAAE,mFAAmF,EAAE,CAAC;IACxG,CAAC;IAED,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC3B,OAAO,EAAE,KAAK,EAAE,yBAAyB,WAAW,CAAC,CAAC,CAAC,IAAI,EAAE,mCAAmC,EAAE,CAAC;IACrG,CAAC;IAED,OAAO,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;AAC3D,CAAC;AAED,8EAA8E;AAC9E,aAAa;AACb,8EAA8E;AAE9E,SAAS,mBAAmB,CAAC,EAAmB;IAC9C,MAAM,KAAK,GAAa;QACtB,mBAAmB,EAAE,CAAC,OAAO,EAAE;QAC/B,mBAAmB,EAAE,CAAC,IAAI,EAAE;QAC5B,mBAAmB,EAAE,CAAC,QAAQ,IAAI,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,EAAE;QACxE,mBAAmB,EAAE,CAAC,aAAa,IAAI,QAAQ,EAAE;QACjD,mBAAmB,EAAE,CAAC,KAAK,IAAI,QAAQ,EAAE;QACzC,mBAAmB,EAAE,CAAC,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE;QACnE,mBAAmB,EAAE,CAAC,OAAO,IAAI,QAAQ,EAAE;QAC3C,mBAAmB,MAAM,CAAC,EAAE,CAAC,WAAW,CAAC,EAAE;QAC3C,mBAAmB,MAAM,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE;KACxC,CAAC;IAEF,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC;IAC5C,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACxB,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAC1B,KAAK,MAAM,GAAG,IAAI,QAAQ,EAAE,CAAC;YAC3B,KAAK,CAAC,IAAI,CAAC,KAAK,GAAG,MAAM,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QACxD,CAAC;IACH,CAAC;SAAM,CAAC;QACN,KAAK,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;IACvC,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC;AAED,8EAA8E;AAC9E,eAAe;AACf,8EAA8E;AAE9E,MAAM,CAAC,KAAK,UAAU,eAAe,CAAC,IAAc;IAClD,MAAM,MAAM,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAEvC,IAAI,OAAO,IAAI,MAAM,EAAE,CAAC;QACtB,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,MAAM,CAAC,KAAK,IAAI,CAAC,CAAC;QACjD,OAAO,CAAC,CAAC;IACX,CAAC;IAED,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;QAChB,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;QACpC,OAAO,CAAC,CAAC;IACX,CAAC;IAED,MAAM,OAAO,GAAG,MAAM,CAAC,OAAiB,CAAC;IACzC,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAEnD,IAAI,GAAW,CAAC;IAChB,IAAI,CAAC;QACH,GAAG,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,CAAC,MAAM,CAAC,KAAK,CAClB,iCAAiC,YAAY,KAAK;YAChD,2FAA2F,CAC9F,CAAC;QACF,OAAO,CAAC,CAAC;IACX,CAAC;IAED,IAAI,QAAQ,CAAC;IACb,IAAI,CAAC;QACH,QAAQ,GAAG,mBAAmB,CAAC,GAAG,CAAC,CAAC;IACtC,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,MAAM,OAAO,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACjE,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,4BAA4B,OAAO,IAAI,CAAC,CAAC;QAC9D,OAAO,CAAC,CAAC;IACX,CAAC;IAED,MAAM,OAAO,GAAG,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,OAAO,KAAK,OAAO,CAAC,CAAC;IAEvE,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;QAC1B,OAAO,CAAC,MAAM,CAAC,KAAK,CAClB,0CAA0C,OAAO,KAAK;YACpD,gGAAgG,CACnG,CAAC;QACF,OAAO,CAAC,CAAC;IACX,CAAC;IAED,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;QAChB,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;IAChE,CAAC;SAAM,CAAC;QACN,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,mBAAmB,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC;IAC5D,CAAC;IAED,OAAO,CAAC,CAAC;AACX,CAAC"}
|