@test-station/adapter-shell 0.1.8 → 0.2.10
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 +26 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -17,6 +17,32 @@ npm install --save-dev @test-station/adapter-shell
|
|
|
17
17
|
- supports the `single-check-json-v1` result format for structured single-check suites
|
|
18
18
|
- writes raw shell logs under `raw/`
|
|
19
19
|
|
|
20
|
+
## Structured Single-Check JSON
|
|
21
|
+
|
|
22
|
+
Use `resultFormat: 'single-check-json-v1'` when the command prints a single JSON object to stdout and you want that payload normalized as one structured check.
|
|
23
|
+
|
|
24
|
+
```js
|
|
25
|
+
{
|
|
26
|
+
adapter: 'shell',
|
|
27
|
+
command: [process.execPath, './scripts/check-mappings.mjs'],
|
|
28
|
+
resultFormat: 'single-check-json-v1',
|
|
29
|
+
resultFormatOptions: {
|
|
30
|
+
name: 'Mapping parity',
|
|
31
|
+
assertions: [
|
|
32
|
+
'Compare local mappings against the upstream reference list.',
|
|
33
|
+
],
|
|
34
|
+
module: 'transpiler',
|
|
35
|
+
theme: 'analysis',
|
|
36
|
+
warningFields: [
|
|
37
|
+
{ field: 'missingFromLocal', label: 'mappings missing locally', mode: 'count-array' },
|
|
38
|
+
],
|
|
39
|
+
rawDetailsFields: ['referenceCount', 'localCount', 'missingFromLocal', 'localOnly'],
|
|
40
|
+
},
|
|
41
|
+
}
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
The adapter stores the JSON payload as a raw artifact, maps configured warning fields into human-readable warnings, and surfaces the selected fields under `test.rawDetails`.
|
|
45
|
+
|
|
20
46
|
## Direct Use
|
|
21
47
|
|
|
22
48
|
```js
|