@davmash/bygone 0.5.2 → 0.7.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@davmash/bygone",
-  "version": "0.5.2",
+  "version": "0.7.1",
   "description": "See how change happened. Visual diff and file history.",
   "author": "David Mashburn",
   "license": "MIT",
@@ -18,9 +18,15 @@
   "main": "./out/standalone-main.js",
   "files": [
     "bin/",
+    "cli/",
+    "completions/",
     "out/",
     "media/",
+    "web/",
     "standalone/",
+    "docs/",
+    "examples/",
+    "schemas/",
     "README.md",
     "LICENSE.txt",
     "CHANGELOG.md"
@@ -33,7 +39,8 @@
     "electron"
   ],
   "dependencies": {
-    "electron": "^31.7.7",
-    "electron-updater": "^6.8.3"
+    "electron": "^43.1.1",
+    "electron-updater": "^6.8.9",
+    "js-yaml": "^4.3.0"
   }
 }

package/schemas/change-tour-source.schema.json

@@ -0,0 +1,287 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://github.com/davidmashburn/bygone/schemas/change-tour-source.schema.json",
+  "title": "Bygone Change Tour Source",
+  "description": "An agent- or human-authored, evidence-linked narrative compiled by Bygone.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["version", "anchors", "connections", "chapters"],
+  "properties": {
+    "version": { "const": 1 },
+    "title": { "$ref": "#/$defs/nonEmptyString" },
+    "sourceUrl": { "type": "string", "minLength": 1 },
+    "range": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["base", "head"],
+      "properties": {
+        "base": { "$ref": "#/$defs/nonEmptyString" },
+        "head": { "$ref": "#/$defs/nonEmptyString" }
+      }
+    },
+    "coverage": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["exclusions"],
+      "properties": {
+        "exclusions": {
+          "type": "array",
+          "items": { "$ref": "#/$defs/coverageExclusion" }
+        }
+      }
+    },
+    "anchors": {
+      "type": "object",
+      "propertyNames": { "minLength": 1 },
+      "additionalProperties": { "$ref": "#/$defs/anchor" }
+    },
+    "connections": {
+      "oneOf": [
+        {
+          "type": "object",
+          "propertyNames": { "minLength": 1 },
+          "additionalProperties": { "$ref": "#/$defs/connectionWithoutId" }
+        },
+        {
+          "type": "array",
+          "items": { "$ref": "#/$defs/connectionWithId" }
+        }
+      ]
+    },
+    "chapters": {
+      "type": "array",
+      "minItems": 1,
+      "items": { "$ref": "#/$defs/chapter" }
+    }
+  },
+  "$defs": {
+    "nonEmptyString": { "type": "string", "minLength": 1 },
+    "stringArray": {
+      "type": "array",
+      "items": { "type": "string" }
+    },
+    "anchor": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["file", "revision", "contains"],
+      "properties": {
+        "file": { "$ref": "#/$defs/nonEmptyString" },
+        "revision": { "enum": ["base", "head"] },
+        "contains": { "$ref": "#/$defs/nonEmptyString" },
+        "occurrence": { "type": "integer", "minimum": 1 }
+      }
+    },
+    "connectionWithoutId": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["from", "to", "label"],
+      "properties": {
+        "from": { "$ref": "#/$defs/nonEmptyString" },
+        "to": { "$ref": "#/$defs/nonEmptyString" },
+        "label": { "$ref": "#/$defs/nonEmptyString" }
+      }
+    },
+    "connectionWithId": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["id", "from", "to", "label"],
+      "properties": {
+        "id": { "$ref": "#/$defs/nonEmptyString" },
+        "from": { "$ref": "#/$defs/nonEmptyString" },
+        "to": { "$ref": "#/$defs/nonEmptyString" },
+        "label": { "$ref": "#/$defs/nonEmptyString" }
+      }
+    },
+    "narrative": {
+      "type": "object",
+      "required": ["summary", "bullets", "tags", "takeaway"],
+      "properties": {
+        "summary": { "$ref": "#/$defs/nonEmptyString" },
+        "bullets": { "$ref": "#/$defs/stringArray" },
+        "tags": { "$ref": "#/$defs/stringArray" },
+        "takeaway": { "$ref": "#/$defs/nonEmptyString" }
+      }
+    },
+    "step": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["id", "title", "body", "focus"],
+      "properties": {
+        "id": { "$ref": "#/$defs/nonEmptyString" },
+        "title": { "$ref": "#/$defs/nonEmptyString" },
+        "body": { "$ref": "#/$defs/nonEmptyString" },
+        "focus": { "$ref": "#/$defs/nonEmptyString" },
+        "connection": { "$ref": "#/$defs/nonEmptyString" },
+        "depth": { "enum": ["mentioned", "explained", "contextualized"] }
+      }
+    },
+    "coverageExclusion": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["path", "reason"],
+      "properties": {
+        "path": { "$ref": "#/$defs/nonEmptyString" },
+        "hunks": { "$ref": "#/$defs/stringArray" },
+        "reason": { "$ref": "#/$defs/nonEmptyString" }
+      }
+    },
+    "scene": {
+      "allOf": [
+        { "$ref": "#/$defs/narrative" },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["id", "title", "summary", "bullets", "tags", "takeaway", "steps"],
+          "properties": {
+            "id": { "$ref": "#/$defs/nonEmptyString" },
+            "title": { "$ref": "#/$defs/nonEmptyString" },
+            "summary": { "$ref": "#/$defs/nonEmptyString" },
+            "bullets": { "$ref": "#/$defs/stringArray" },
+            "tags": { "$ref": "#/$defs/stringArray" },
+            "takeaway": { "$ref": "#/$defs/nonEmptyString" },
+            "steps": { "type": "array", "minItems": 1, "items": { "$ref": "#/$defs/step" } }
+          }
+        }
+      ]
+    },
+    "stackEntry": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["id", "ref"],
+      "properties": {
+        "id": { "$ref": "#/$defs/nonEmptyString" },
+        "ref": { "$ref": "#/$defs/nonEmptyString" },
+        "label": { "$ref": "#/$defs/nonEmptyString" }
+      }
+    },
+    "stackStep": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["id", "title", "body", "file", "pair"],
+      "properties": {
+        "id": { "$ref": "#/$defs/nonEmptyString" },
+        "title": { "$ref": "#/$defs/nonEmptyString" },
+        "body": { "$ref": "#/$defs/nonEmptyString" },
+        "file": { "$ref": "#/$defs/nonEmptyString" },
+        "pair": {
+          "type": "array",
+          "minItems": 2,
+          "maxItems": 2,
+          "items": { "$ref": "#/$defs/nonEmptyString" }
+        },
+        "side": { "enum": ["left", "right"] },
+        "lines": {
+          "type": "array",
+          "minItems": 2,
+          "maxItems": 2,
+          "items": { "type": "integer", "minimum": 1 }
+        }
+      }
+    },
+    "stackedScene": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["id", "kind", "title", "summary", "bullets", "tags", "takeaway", "stack", "steps"],
+      "properties": {
+        "id": { "$ref": "#/$defs/nonEmptyString" },
+        "kind": { "const": "stacked-diff" },
+        "title": { "$ref": "#/$defs/nonEmptyString" },
+        "summary": { "$ref": "#/$defs/nonEmptyString" },
+        "bullets": { "$ref": "#/$defs/stringArray" },
+        "tags": { "$ref": "#/$defs/stringArray" },
+        "takeaway": { "$ref": "#/$defs/nonEmptyString" },
+        "stack": { "type": "array", "minItems": 3, "maxItems": 6, "items": { "$ref": "#/$defs/stackEntry" } },
+        "files": { "$ref": "#/$defs/stringArray" },
+        "steps": { "type": "array", "minItems": 1, "items": { "$ref": "#/$defs/stackStep" } }
+      }
+    },
+    "deconstructedChange": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["file", "hunks"],
+      "properties": {
+        "file": { "$ref": "#/$defs/nonEmptyString" },
+        "hunks": {
+          "type": "array",
+          "minItems": 1,
+          "items": { "$ref": "#/$defs/nonEmptyString" }
+        }
+      }
+    },
+    "deconstructedExclusion": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["file", "reason"],
+      "properties": {
+        "file": { "$ref": "#/$defs/nonEmptyString" },
+        "hunks": {
+          "type": "array",
+          "minItems": 1,
+          "items": { "$ref": "#/$defs/nonEmptyString" }
+        },
+        "reason": { "$ref": "#/$defs/nonEmptyString" }
+      }
+    },
+    "deconstructedStage": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["id", "title", "narration", "changes"],
+      "properties": {
+        "id": { "$ref": "#/$defs/nonEmptyString" },
+        "title": { "$ref": "#/$defs/nonEmptyString" },
+        "narration": { "$ref": "#/$defs/nonEmptyString" },
+        "changes": {
+          "type": "array",
+          "minItems": 1,
+          "items": { "$ref": "#/$defs/deconstructedChange" }
+        }
+      }
+    },
+    "deconstructedScene": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["id", "kind", "title", "summary", "bullets", "tags", "takeaway", "stages"],
+      "properties": {
+        "id": { "$ref": "#/$defs/nonEmptyString" },
+        "kind": { "const": "deconstructed-diff" },
+        "title": { "$ref": "#/$defs/nonEmptyString" },
+        "summary": { "$ref": "#/$defs/nonEmptyString" },
+        "bullets": { "$ref": "#/$defs/stringArray" },
+        "tags": { "$ref": "#/$defs/stringArray" },
+        "takeaway": { "$ref": "#/$defs/nonEmptyString" },
+        "base": { "$ref": "#/$defs/nonEmptyString" },
+        "target": { "$ref": "#/$defs/nonEmptyString" },
+        "stages": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 12,
+          "items": { "$ref": "#/$defs/deconstructedStage" }
+        },
+        "exclusions": {
+          "type": "array",
+          "items": { "$ref": "#/$defs/deconstructedExclusion" }
+        }
+      }
+    },
+    "chapter": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["id", "title", "scenes"],
+      "properties": {
+        "id": { "$ref": "#/$defs/nonEmptyString" },
+        "title": { "$ref": "#/$defs/nonEmptyString" },
+        "scenes": {
+          "type": "array",
+          "minItems": 1,
+          "items": {
+            "oneOf": [
+              { "$ref": "#/$defs/scene" },
+              { "$ref": "#/$defs/stackedScene" },
+              { "$ref": "#/$defs/deconstructedScene" }
+            ]
+          }
+        }
+      }
+    }
+  }
+}

package/standalone/index.html

@@ -3,7 +3,7 @@
 <head>
     <meta charset="UTF-8">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <meta http-equiv="Content-Security-Policy" content="default-src 'self'; img-src 'self' data:; font-src 'self' data:; style-src 'self' 'unsafe-inline'; script-src 'self'; worker-src 'self' blob:;">
+    <meta http-equiv="Content-Security-Policy" content="default-src 'self'; base-uri 'none'; object-src 'none'; frame-src 'none'; form-action 'none'; img-src 'self' data:; font-src 'self' data:; style-src 'self' 'unsafe-inline'; script-src 'self'; worker-src 'self' blob:;">
     <title>Bygone</title>
     <link href="../media/webview.css" rel="stylesheet">
 </head>
@@ -11,7 +11,7 @@
     <div id="container">
         <div id="header">
             <div id="file-info" class="header-align-diff">Choose a compare command to render a diff.</div>
-            <div id="status-banner" class="status-banner header-align-diff" hidden></div>
+            <div id="status-banner" class="status-banner header-align-diff" role="status" aria-live="polite" aria-atomic="true" hidden></div>
             <div id="directory-return-toolbar" class="directory-return-toolbar header-align-diff" hidden>
                 <button id="back-to-directory" class="directory-return-button" type="button" title="Back to directory view (Cmd/Ctrl+[)">
                     <svg viewBox="0 0 24 24" aria-hidden="true">
@@ -20,6 +20,9 @@
                     </svg>
                     <span>Back</span>
                 </button>
+                <button id="toggle-directory-sidebar" class="directory-return-button" type="button" title="Hide directory files" aria-label="Hide directory files" aria-pressed="true">
+                    <span>Files</span>
+                </button>
             </div>
             <div id="edit-mode-toolbar" class="edit-mode-toolbar header-align-diff" hidden>
                 <button id="toggle-readonly" class="edit-mode-button" type="button" title="Toggle read-only mode">Editing On</button>
@@ -54,7 +57,7 @@
                             <path d="M19 5v14"></path>
                         </svg>
                     </button>
-                    <div id="change-position" class="change-position"></div>
+                    <div id="change-position" class="change-position" role="status" aria-live="polite" aria-atomic="true"></div>
                     <button id="copy-right-to-left" class="change-button change-button-primary icon-button" type="button" title="Copy current change from right to left (Cmd/Ctrl+Alt+Left)" aria-label="Copy current change from right to left">
                         <svg viewBox="0 0 24 24" aria-hidden="true">
                             <path d="M19 12H9"></path>
@@ -69,6 +72,19 @@
                         </svg>
                     </button>
                     </div>
+                    <button id="toggle-word-wrap" class="change-button icon-button" type="button" title="Enable line wrapping (Alt+Z)" aria-label="Enable line wrapping" aria-pressed="false" hidden>
+                        <svg viewBox="0 0 24 24" aria-hidden="true">
+                            <path d="M4 6h13a3 3 0 0 1 0 6H9"></path>
+                            <path d="M12 9l-3 3 3 3"></path>
+                            <path d="M4 18h8"></path>
+                        </svg>
+                    </button>
+                    <button id="refresh-session" class="change-button refresh-session-button icon-button" type="button" title="Refresh Session (Cmd/Ctrl+R)" aria-label="Refresh Session" disabled>
+                        <svg viewBox="0 0 24 24" aria-hidden="true">
+                            <path d="M20 11a8 8 0 1 0-2.3 5.7"></path>
+                            <path d="M20 5v6h-6"></path>
+                        </svg>
+                    </button>
                 </div>
                 <div class="change-hint">Cmd/Ctrl+Alt+Up/Down to jump.</div>
             </div>
@@ -84,7 +100,7 @@
                             <path d="M10 18l-6-6 6-6" opacity="0.7"></path>
                         </svg>
                     </button>
-                    <div id="history-position" class="history-position"></div>
+                    <div id="history-position" class="history-position" role="status" aria-live="polite" aria-atomic="true"></div>
                     <button id="history-forward" class="history-button icon-button" type="button" title="Newer commit" aria-label="Newer commit">
                         <svg viewBox="0 0 24 24" aria-hidden="true">
                             <path d="M9 18l6-6-6-6"></path>
@@ -131,14 +147,15 @@
         </div>
         <div id="diff-workspace">
             <aside id="history-rail" class="history-rail hidden" hidden></aside>
+            <button id="show-navigation-sidebar" class="navigation-sidebar-show" type="button" title="Show navigation sidebar" aria-label="Show navigation sidebar" hidden>›</button>
             <div id="diff-container">
                 <div id="two-way-diff" class="diff-view">
                     <div class="file-panel">
-                        <div id="file1-header" class="file-header">File 1</div>
+                        <button id="file1-header" class="file-header" type="button" title="Select left pane" aria-pressed="false">File 1</button>
                         <div id="file1-content" class="file-content"></div>
                     </div>
                     <div class="file-panel">
-                        <div id="file2-header" class="file-header">File 2</div>
+                        <button id="file2-header" class="file-header" type="button" title="Select right pane" aria-pressed="false">File 2</button>
                         <div id="file2-content" class="file-content"></div>
                     </div>
                 </div>