feat: externalize code block responses in serialized form

update notebooks to use externalized responses

Author: starpit

packages/core/src/models/CommentaryResponse.ts

@@ -15,6 +15,7 @@
  */
 
 import { Entity } from './entity'
+import { KResponse } from './command'
 import REPL from './repl'
 
 export type CommentaryResponse = {
@@ -27,9 +28,12 @@ export type CommentaryResponse = {
     /** Source filepath */
     filepath?: string
 
-    /** Body of the Card. It will be passed through as the source <Markdown source="..." /> */
+    /** Markdown source */
     children: string
 
+    /** CodeBlock responses */
+    codeBlockResponses?: { status: 'done' | 'error'; response: KResponse }[]
+
     /** Prefix for image URLs */
     baseUrl?: string
 

plugins/plugin-client-common/notebooks/make-notebook.json

@@ -0,0 +1,20 @@
+[
+  {
+    "status": "done",
+    "response": {
+      "apiVersion": "kui-shell/v1",
+      "kind": "XtermResponse",
+      "rows": [[{ "innerText": "hello", "classList": [], "style": {}, "textContent": "h" }]],
+      "code": 0
+    }
+  },
+  {
+    "status": "done",
+    "response": {
+      "apiVersion": "kui-shell/v1",
+      "kind": "XtermResponse",
+      "rows": [[{ "innerText": "world", "classList": [], "style": {}, "textContent": "w" }]],
+      "code": 0
+    }
+  }
+]

plugins/plugin-client-common/notebooks/make-notebook.md

@@ -100,12 +100,13 @@ between tabs.
 To make a code block executable, make sure to specify a language of
 either `bash`, `sh`, or `shell`.
 
-Inside a code blocks, you may define metadata:
+Inside a code blocks, you may define metadata, such as an identifier
+when linking code blocks into [Progress Step
+Lists](#progress-step-lists).
 
 ```bashy
 ---
 id: my-first-command
-response: hello
 ---
 echo hello
 ```
@@ -122,7 +123,6 @@ repeated as a normal code block:
 ```bash
 ---
 id: my-first-command
-response: hello
 ---
 echo hello
 ```