@davmash/bygone 0.9.8 → 0.10.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.
Files changed (68) hide show
  1. package/CHANGELOG.md +21 -1
  2. package/README.md +74 -1
  3. package/cli/commandSpec.js +2 -0
  4. package/cli/completions.js +3 -3
  5. package/cli/present.js +28 -10
  6. package/cli/tour.js +22 -1
  7. package/cli/tourExport.js +147 -0
  8. package/cli/tourFile.js +109 -4
  9. package/cli/tourHistory.js +31 -1
  10. package/completions/_bygone +1 -1
  11. package/completions/bygone +1 -1
  12. package/completions/bygone.fish +1 -1
  13. package/docs/change-tour-format.md +85 -68
  14. package/docs/explore.md +14 -3
  15. package/docs/generating-change-tours.md +84 -46
  16. package/docs/present.md +103 -14
  17. package/docs/product-surface.md +19 -8
  18. package/docs/sharing-tours.md +95 -0
  19. package/docs/visual-walkthrough/README.md +89 -0
  20. package/docs/visual-walkthrough/build-tour.mjs +54 -0
  21. package/docs/visual-walkthrough/capture-desktop.cjs +42 -0
  22. package/docs/visual-walkthrough/capture-desktop.mjs +21 -0
  23. package/docs/visual-walkthrough/captures.md +49 -0
  24. package/docs/visual-walkthrough/create-demo.mjs +57 -0
  25. package/docs/visual-walkthrough/deconstructed-demo.bygone +100 -0
  26. package/docs/visual-walkthrough/images/01-two-files.png +0 -0
  27. package/docs/visual-walkthrough/images/02-many-panels.png +0 -0
  28. package/docs/visual-walkthrough/images/03-directories.png +0 -0
  29. package/docs/visual-walkthrough/images/04-search.png +0 -0
  30. package/docs/visual-walkthrough/images/05-repository-history.png +0 -0
  31. package/docs/visual-walkthrough/images/06-file-history.png +0 -0
  32. package/docs/visual-walkthrough/images/07-branch-review.png +0 -0
  33. package/docs/visual-walkthrough/images/08-tour-reader.png +0 -0
  34. package/docs/visual-walkthrough/images/09-focused-step.png +0 -0
  35. package/docs/visual-walkthrough/images/10-deconstructed.png +0 -0
  36. package/docs/visual-walkthrough/images/11-exploration.png +0 -0
  37. package/docs/visual-walkthrough/images/12-authoring.png +0 -0
  38. package/docs/visual-walkthrough/images/13-export.png +0 -0
  39. package/docs/visual-walkthrough/images/14-vscode.png +0 -0
  40. package/docs/visual-walkthrough/images/15-cli.png +0 -0
  41. package/docs/visual-walkthrough/narrative.md +134 -0
  42. package/docs/visual-walkthrough/outline.md +52 -0
  43. package/docs/visual-walkthrough/walkthrough.bygone +340 -0
  44. package/docs/walkthrough.md +6 -101
  45. package/examples/bygone-history.bygone +11 -44
  46. package/examples/marker-focus.bygone +116 -0
  47. package/examples/navigation-lab.bygone.yaml +401 -336
  48. package/examples/tour-orientation.bygone +349 -0
  49. package/media/diff.worker.js +13 -3
  50. package/media/webview.css +1 -1
  51. package/media/webview.js +394 -319
  52. package/out/changeTour.js +865 -397
  53. package/out/deepLink.js +167 -0
  54. package/out/historyDirectory.js +66 -0
  55. package/out/standalone-main.js +20514 -16821
  56. package/out/tourCoverage.js +850 -386
  57. package/out/tourDocument.js +97 -0
  58. package/package.json +1 -1
  59. package/schemas/change-tour-source.schema.json +91 -64
  60. package/skills/pr-tour-guide/SKILL.md +144 -128
  61. package/skills/pr-tour-guide/references/expectations-and-feedback.md +57 -0
  62. package/standalone/index.html +10 -25
  63. package/web/export-bootstrap.js +62 -0
  64. package/web/export-licenses.txt +78 -0
  65. package/web/export-runtime.json +12 -0
  66. package/web/index.html +54 -47
  67. package/web/presenter.css +332 -178
  68. package/web/web-host.js +239 -137
@@ -0,0 +1,78 @@
1
+ LICENSE.txt
2
+ MIT License
3
+
4
+ Copyright (c) 2026 David Mashburn
5
+
6
+ Permission is hereby granted, free of charge, to any person obtaining a copy
7
+ of this software and associated documentation files (the "Software"), to deal
8
+ in the Software without restriction, including without limitation the rights
9
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10
+ copies of the Software, and to permit persons to whom the Software is
11
+ furnished to do so, subject to the following conditions:
12
+
13
+ The above copyright notice and this permission notice shall be included in all
14
+ copies or substantial portions of the Software.
15
+
16
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22
+ SOFTWARE.
23
+
24
+
25
+ node_modules/monaco-editor/LICENSE
26
+ The MIT License (MIT)
27
+
28
+ Copyright (c) 2016 - present Microsoft Corporation
29
+
30
+ Permission is hereby granted, free of charge, to any person obtaining a copy
31
+ of this software and associated documentation files (the "Software"), to deal
32
+ in the Software without restriction, including without limitation the rights
33
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
34
+ copies of the Software, and to permit persons to whom the Software is
35
+ furnished to do so, subject to the following conditions:
36
+
37
+ The above copyright notice and this permission notice shall be included in all
38
+ copies or substantial portions of the Software.
39
+
40
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
41
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
42
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
43
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
44
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
45
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
46
+ SOFTWARE.
47
+
48
+
49
+ node_modules/diff/LICENSE
50
+ BSD 3-Clause License
51
+
52
+ Copyright (c) 2009-2015, Kevin Decker <kpdecker@gmail.com>
53
+ All rights reserved.
54
+
55
+ Redistribution and use in source and binary forms, with or without
56
+ modification, are permitted provided that the following conditions are met:
57
+
58
+ 1. Redistributions of source code must retain the above copyright notice, this
59
+ list of conditions and the following disclaimer.
60
+
61
+ 2. Redistributions in binary form must reproduce the above copyright notice,
62
+ this list of conditions and the following disclaimer in the documentation
63
+ and/or other materials provided with the distribution.
64
+
65
+ 3. Neither the name of the copyright holder nor the names of its
66
+ contributors may be used to endorse or promote products derived from
67
+ this software without specific prior written permission.
68
+
69
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
70
+ AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
71
+ IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
72
+ DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
73
+ FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
74
+ DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
75
+ SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
76
+ CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
77
+ OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
78
+ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
@@ -0,0 +1,12 @@
1
+ {
2
+ "schema": 1,
3
+ "version": "0.10.0",
4
+ "assets": {
5
+ "web/presenter.css": "sha256-zQdYI+Wl5V3zHjwpgjytYyFguJkHrGh6usOY8wBFfVU=",
6
+ "media/webview.css": "sha256-M190TAd1/y9PQVR++dd3O9MG2EbmvmEOT8CKm3L/gh0=",
7
+ "web/web-host.js": "sha256-aADV181nqkkok1/Osu1g5VuJ3ht19o7Uoebex1vPNgU=",
8
+ "media/webview.js": "sha256-a/Jm2q/dCO7O5vDPa+8CN4RKP/UXjdNjkzKPhaSFNn4=",
9
+ "media/editor.worker.js": "sha256-qWbRV7U57PL25iH34w5bTeMJ0D1QDMulvRzYEPBRKnI=",
10
+ "media/diff.worker.js": "sha256-A+PzHkIfw4Egmw5ciI7CZVu3725hEZ45ZLHgxtZy4t8="
11
+ }
12
+ }
package/web/index.html CHANGED
@@ -25,8 +25,8 @@
25
25
  <div id="tour-stats" class="tour-stats"></div>
26
26
  </div>
27
27
  <div id="tour-authoring-coverage" class="tour-authoring-coverage" aria-label="Tour authoring coverage" hidden></div>
28
+ <section id="tour-audience" aria-label="Tour audience"></section>
28
29
  </details>
29
- <button id="tour-review-toggle" class="tour-review-toggle" type="button" title="Read authored review notes and open their evidence" aria-controls="tour-review" aria-expanded="false" hidden>Review notes</button>
30
30
  </header>
31
31
  <nav id="tour-navigator-tabs" class="tour-navigator-tabs" aria-label="Tour navigator">
32
32
  <button type="button" data-tour-navigator="tour" aria-controls="tour-navigator-tour" aria-selected="true" title="Browse tour scenes">Tour <span id="tour-scene-count" class="tour-rail-count"></span></button>
@@ -60,28 +60,49 @@
60
60
  <span>Files</span>
61
61
  <button id="tour-return-focus" class="tour-return-focus" type="button" title="Return to the file focused by the current tour step" hidden>Return to tour</button>
62
62
  </header>
63
+ <label id="tour-file-filter" class="file-tree-filter"><input id="tour-show-all-files" type="checkbox"><span id="tour-file-filter-label">Show all files</span><span id="tour-visible-file-count"></span></label>
63
64
  <nav id="tour-files" class="tour-files" aria-label="Changed files"></nav>
64
65
  </section>
65
66
  <section id="tour-navigator-commits" class="tour-navigator-panel" data-tour-navigator-panel="commits" hidden>
66
67
  <div id="tour-history-controls" class="tour-evidence-controls" hidden>
67
- <div class="tour-evidence-actions">
68
- <button id="tour-history-compare" type="button" title="Compare the selected revisions" disabled>Compare selected (0)</button>
69
- <button id="tour-history-clear" type="button" title="Uncheck all draft revisions without changing panels">Clear selection</button>
70
- <button id="tour-history-reset" type="button" title="Select the revisions currently loaded in panels">Reset selection</button>
71
- <button id="tour-history-parent" type="button" title="Compare this revision with its parent">Parent</button>
72
- <button id="tour-history-base" type="button" title="Compare this revision with the review base">Review base</button>
73
- <button id="tour-history-final" type="button" title="Compare the review base with its head across all changed files">Final diff</button>
68
+ <div class="tour-selection-toolbar">
69
+ <div class="tour-selection-summary" role="status" aria-live="polite">
70
+ <span id="tour-history-count" class="tour-selection-count">0 selected</span>
71
+ <span id="tour-history-hint" class="tour-selection-hint">Select 2+ revisions</span>
72
+ </div>
73
+ <button id="tour-history-compare" class="tour-selection-apply" type="button" title="Compare the selected revisions" disabled>Compare</button>
74
+ <details class="tour-selection-more">
75
+ <summary aria-label="Selection actions" title="Selection actions"><svg viewBox="0 0 24 24" aria-hidden="true"><circle cx="5" cy="12" r="1.5"/><circle cx="12" cy="12" r="1.5"/><circle cx="19" cy="12" r="1.5"/></svg></summary>
76
+ <div class="tour-selection-menu">
77
+ <button id="tour-history-clear" type="button" title="Uncheck all revisions without changing the comparison">Clear selection</button>
78
+ <button id="tour-history-reset" type="button" title="Select the revisions currently shown">Select displayed revisions</button>
79
+ <hr>
80
+ <button id="tour-history-final" type="button" title="Compare the review base with its head across all changed files">Final diff <span>Base → head · all files</span></button>
81
+ <button id="tour-history-parent" type="button" title="Compare this revision with its parent">Compare with parent</button>
82
+ <button id="tour-history-base" type="button" title="Compare this revision with the review base">Compare with review base</button>
83
+ </div>
84
+ </details>
74
85
  </div>
75
86
  </div>
76
87
  <div id="tour-compare-controls" class="tour-evidence-controls" hidden>
77
- <div id="tour-compare-scope"></div>
78
- <div class="tour-evidence-actions">
79
- <button id="tour-compare-apply" type="button" title="Update the comparison with the selected revisions" disabled>Update comparison (0)</button>
80
- <button id="tour-compare-clear" type="button" title="Uncheck all draft revisions without changing panels">Clear selection</button>
81
- <button id="tour-compare-reset" type="button" title="Select the revisions currently loaded in panels">Reset selection</button>
82
- <button id="tour-compare-final" type="button" title="Compare the review base with its head across all changed files">Final diff</button>
83
- <button id="tour-compare-all" type="button" title="Compare these revisions across all changed files" hidden>All files</button>
88
+ <div class="tour-selection-toolbar">
89
+ <div class="tour-selection-summary" role="status" aria-live="polite">
90
+ <span id="tour-compare-count" class="tour-selection-count">0 selected</span>
91
+ <span id="tour-compare-hint" class="tour-selection-hint">Select 2+ revisions</span>
92
+ </div>
93
+ <button id="tour-compare-apply" class="tour-selection-apply" type="button" title="Apply the selected revisions" disabled>Apply</button>
94
+ <details class="tour-selection-more">
95
+ <summary aria-label="Selection actions" title="Selection actions"><svg viewBox="0 0 24 24" aria-hidden="true"><circle cx="5" cy="12" r="1.5"/><circle cx="12" cy="12" r="1.5"/><circle cx="19" cy="12" r="1.5"/></svg></summary>
96
+ <div class="tour-selection-menu">
97
+ <button id="tour-compare-clear" type="button" title="Uncheck all revisions without changing the comparison">Clear selection</button>
98
+ <button id="tour-compare-reset" type="button" title="Select the revisions currently shown">Select displayed revisions</button>
99
+ <hr>
100
+ <button id="tour-compare-final" type="button" title="Compare the review base with its head across all changed files">Final diff <span>Base → head · all files</span></button>
101
+ <button id="tour-compare-all" type="button" title="Compare these revisions across all changed files" hidden>Show all changed files</button>
102
+ </div>
103
+ </details>
84
104
  </div>
105
+ <div id="tour-compare-scope" class="tour-comparison-scope"></div>
85
106
  </div>
86
107
  <div id="tour-commits-host" class="tour-commits-host"></div>
87
108
  <p class="tour-commit-legend"><span>● Changed this file</span><span># Loaded panel</span><span><span class="tour-range-swatch" aria-hidden="true"></span>Tour range</span></p>
@@ -89,18 +110,18 @@
89
110
  </div>
90
111
  <div id="tour-sidebar-resizer" class="tour-sidebar-resizer" role="separator" aria-label="Resize tour sidebar" title="Resize tour sidebar (Left/Right; Home/End)" aria-orientation="vertical" aria-valuemin="240" aria-valuemax="600" tabindex="0"></div>
91
112
  </aside>
92
- <section id="tour-review" class="tour-review" aria-labelledby="tour-review-title" hidden>
93
- <header class="tour-review-heading">
94
- <h2 id="tour-review-title">Review notes</h2>
95
- <button id="tour-review-close" type="button" title="Close review notes (Escape)" aria-label="Close review notes">Close</button>
96
- </header>
97
- <div id="tour-review-content" class="tour-review-content"></div>
98
- <p id="tour-review-status" role="status" aria-live="polite"></p>
99
- </section>
100
113
  <button id="tour-sidebar-show" class="tour-sidebar-show" type="button" title="Show tour sidebar" aria-label="Show tour sidebar" hidden>›</button>
101
114
  <section id="tour-narrative" class="tour-narrative" hidden>
102
115
  <div class="tour-narrative-toolbar" role="group" aria-label="Tour reading view">
116
+ <div class="tour-navigation" role="group" aria-label="Tour navigation">
117
+ <button id="tour-back" type="button" title="Previous tour passage" disabled>‹ Back</button>
118
+ <button id="tour-next" type="button" title="Next tour passage" disabled>Next ›</button>
119
+ </div>
103
120
  <span id="tour-breadcrumb" class="tour-breadcrumb"></span>
121
+ <div class="tour-feedback-actions" role="group" aria-label="Discuss this passage">
122
+ <button id="tour-feedback-explain" type="button" title="Ask for help understanding this passage">Explain this</button>
123
+ <button id="tour-feedback-question" type="button" title="Raise a concern about the change shown here">Question this change</button>
124
+ </div>
104
125
  <div class="tour-narration-dock">
105
126
  <div id="tour-audio-settings" class="tour-audio-settings" hidden>
106
127
  <div id="tour-narration-controls" class="tour-narration-controls" role="group" aria-label="Tour narration">
@@ -127,6 +148,7 @@
127
148
  <option value="1">1×</option>
128
149
  <option value="1.25">1.25×</option>
129
150
  <option value="1.5">1.5×</option>
151
+ <option value="2">2×</option>
130
152
  </select>
131
153
  </div>
132
154
  <span id="tour-narration-status" class="tour-narration-status" role="status" aria-live="polite" aria-atomic="true">Device voice ready</span>
@@ -161,20 +183,15 @@
161
183
  <div id="file-info" class="header-align-diff">Choose a compare command to render a diff.</div>
162
184
  <div id="status-banner" class="status-banner header-align-diff" role="status" aria-live="polite" aria-atomic="true" hidden></div>
163
185
  <div id="directory-return-toolbar" class="directory-return-toolbar header-align-diff" hidden>
164
- <button id="back-to-directory" class="directory-return-button" type="button" title="Back to directory view (Cmd/Ctrl+[)">
186
+ <button id="back-to-directory" class="directory-return-button" type="button" title="Show directory comparison (Cmd/Ctrl+[)" aria-label="Show directory comparison">
165
187
  <svg viewBox="0 0 24 24" aria-hidden="true">
166
- <path d="M15 18l-6-6 6-6"></path>
167
- <path d="M9 12h10"></path>
188
+ <path d="M4 3v14h4M4 7h4"></path>
189
+ <rect x="8" y="4" width="12" height="6" rx="1"></rect>
190
+ <rect x="8" y="14" width="12" height="6" rx="1"></rect>
168
191
  </svg>
169
- <span>Back</span>
170
- </button>
171
- <button id="toggle-directory-sidebar" class="directory-return-button" type="button" title="Hide directory files" aria-label="Hide directory files" aria-pressed="true">
172
- <span>Files</span>
192
+ <span>Directory</span>
173
193
  </button>
174
194
  </div>
175
- <div id="edit-mode-toolbar" class="edit-mode-toolbar header-align-diff" hidden>
176
- <button id="toggle-readonly" class="edit-mode-button" type="button" title="Toggle read-only mode">Editing On</button>
177
- </div>
178
195
  <div id="change-toolbar" class="change-toolbar header-align-diff" hidden>
179
196
  <div class="change-toolbar-main">
180
197
  <div class="change-toolbar-nav">
@@ -198,21 +215,7 @@
198
215
  <path d="M6 11l6-6 6 6"></path>
199
216
  </svg>
200
217
  </button>
201
- <button id="copy-left-to-right" class="change-button change-button-primary icon-button" type="button" title="Copy current change from left to right (Cmd/Ctrl+Alt+Right)" aria-label="Copy current change from left to right">
202
- <svg viewBox="0 0 24 24" aria-hidden="true">
203
- <path d="M5 12h10"></path>
204
- <path d="M11 8l4 4-4 4"></path>
205
- <path d="M19 5v14"></path>
206
- </svg>
207
- </button>
208
218
  <div id="change-position" class="change-position" role="status" aria-live="polite" aria-atomic="true"></div>
209
- <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">
210
- <svg viewBox="0 0 24 24" aria-hidden="true">
211
- <path d="M19 12H9"></path>
212
- <path d="M13 8l-4 4 4 4"></path>
213
- <path d="M5 5v14"></path>
214
- </svg>
215
- </button>
216
219
  <button id="next-change" class="change-button change-button-primary icon-button" type="button" title="Next difference (F7 or Cmd/Ctrl+Shift+Down)" aria-label="Next difference">
217
220
  <svg viewBox="0 0 24 24" aria-hidden="true">
218
221
  <path d="M12 5v14"></path>
@@ -221,6 +224,10 @@
221
224
  </button>
222
225
  </div>
223
226
  <div class="change-toolbar-actions">
227
+ <div id="edit-mode-toolbar" class="edit-mode-toolbar" hidden>
228
+ <button id="toggle-readonly" class="edit-mode-button" type="button" title="Toggle read-only mode">Editing On</button>
229
+ </div>
230
+ <button id="toggle-pair-focus" class="change-button" type="button" title="Show only changes from the selected pair" aria-label="Focus selected pair" aria-pressed="false" hidden>Focus selected pair: Off</button>
224
231
  <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>
225
232
  <svg class="word-wrap-icon-off" viewBox="0 0 24 24" aria-hidden="true">
226
233
  <path d="M4 6h13a3 3 0 0 1 0 6H9"></path>