rig-review 1.0.0 → 1.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/docs/WORKFLOWS.md CHANGED
@@ -25,6 +25,8 @@ bun run review -- /absolute/path/to/package/review.json --checkpoint silhouette
25
25
 
26
26
  The server prints the exact link, for example `http://127.0.0.1:4317/?checkpoint=silhouette#cap=…`. The `#cap=` fragment is this server's write capability (see [Managed front and write capability](#managed-front-and-write-capability)). `--port 0` selects a free port. It binds only `127.0.0.1` and never opens a browser automatically. A folder containing `review.json` uses that explicit manifest.
27
27
 
28
+ Add `lang=en` or `lang=ko` to a review link's query to open it in that language, ahead of the fragment: `…/?checkpoint=silhouette&lang=en#cap=…`. It outranks the browser and the saved choice and stores nothing, so a shared link cannot change a reader's setting. Picking a language in the settings menu takes over for the rest of the page.
29
+
28
30
  ## Compare two outputs
29
31
 
30
32
  Open two compiled packages against one explicitly selected local reference video:
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "rig-review",
3
- "version": "1.0.0",
3
+ "version": "1.1.0",
4
4
  "type": "module",
5
5
  "description": "Local human rig inspection and structured feedback export",
6
6
  "license": "MIT",
package/src/cli.ts CHANGED
@@ -2,6 +2,7 @@
2
2
  import {requireFeedbackFrames} from './stage-comment.ts';
3
3
  import {commentCropPaths} from './comment-crops.ts';
4
4
  import {randomBytes} from 'node:crypto';
5
+ import {readFile} from 'node:fs/promises';
5
6
  import {parseControlCommand} from './control.ts';
6
7
  import { loadReview } from './manifest.ts';
7
8
  import { formatFeedbackIssues,feedbackWithCommentGroups } from './feedback-export.ts';
@@ -19,7 +20,7 @@ import { readCompareSession } from './compare-session.ts';
19
20
  import { exportReviewStrip, exportCompareStrip, stripJson, writeStripOutput, validateStripOutput } from './strip-export.ts';
20
21
  import type { StripInterval, StripRequest } from './strip.ts';
21
22
  const handoffUsage='[--config <path> [--parts <dir>] [--source <png> --full <dir> [--head <dir>]] [--keypoints <file>]]';
22
- const usage='Usage: rig-review open <dir> [--reference <video>] [--compare <dir>] [--animation <name>] [--control] [--direct] '+handoffUsage+'\n --config declares the producer handoff (wins over the review.json "producer" block and discovery of config.json, rig/config.json, ../config.json beside an opened out/); feedback and control take the same flags.\n open is managed by default: one loopback front at 127.0.0.1:4318 (RIG_REVIEW_FRONT_PORT overrides) serves /instances/<key>/; --direct serves the worker on its own port.\n rig-review control <dir> [--reference <video>] [--compare <dir>] [--animation <name>] '+handoffUsage+' [--page <id> --expected-revision <n> --command <JSON> --wait-ms <n>]\n rig-review feedback <dir> [--reference <video>] [--compare <dir>] [--animation <name>] '+handoffUsage+' [--format json|issue]\n Usage: bun run review -- <review.json|output-directory> [--port 4317] [--checkpoint ID]\n bun run check -- <review.json|output-directory>\n bun run feedback -- <review.json|output-directory>\n bun run review -- compare <a> <b> --reference <video> --animation <name> [--port 4317]\n bun run check -- compare <a> <b> --reference <video> --animation <name>\n bun run feedback -- compare <a> <b> --reference <video> --animation <name>';
23
+ const usage='Usage: rig-review open <dir> [--reference <video>] [--compare <dir>] [--animation <name>] [--control] [--direct] '+handoffUsage+'\n --config declares the producer handoff (wins over the review.json "producer" block and discovery of config.json, rig/config.json, ../config.json beside an opened out/); feedback and control take the same flags.\n open is managed by default: one loopback front at 127.0.0.1:4318 (RIG_REVIEW_FRONT_PORT overrides) serves /instances/<key>/; --direct serves the worker on its own port.\n rig-review control <dir> [--reference <video>] [--compare <dir>] [--animation <name>] '+handoffUsage+' [--page <id> --expected-revision <n> --command <JSON> --wait-ms <n>]\n rig-review feedback <dir> [--reference <video>] [--compare <dir>] [--animation <name>] '+handoffUsage+' [--format json|issue]\n Usage: bun run review -- <review.json|output-directory> [--port 4317] [--checkpoint ID]\n bun run check -- <review.json|output-directory>\n bun run feedback -- <review.json|output-directory>\n bun run review -- compare <a> <b> --reference <video> --animation <name> [--port 4317]\n bun run check -- compare <a> <b> --reference <video> --animation <name>\n bun run feedback -- compare <a> <b> --reference <video> --animation <name>\n rig-review --version';
23
24
  async function stripCommand(args:string[],options:{stateDir?:string}){
24
25
  const compare=args[0]==='compare';if(compare)args.shift();const a=args.shift(),b=compare?args.shift():undefined;if(!a||compare&&!b)throw new Error('strip: expected package input(s)');
25
26
  let reference:string|undefined,referenceVideo:string|undefined,animation:string|undefined,basis:'a'|'b'|undefined,range:string|undefined,output:string|undefined,jsonOnly=false,all=false;
@@ -94,6 +95,7 @@ function commandHelpRequested(args:readonly string[],command:'open'|'review'|'ch
94
95
  }
95
96
  export async function main(args:string[],options:{stateDir?:string}={}){
96
97
  options={stateDir:options.stateDir??defaultStateDir()};if(args[0]==='--')args.shift();
98
+ if(args[0]==='--version'||args[0]==='-v'){console.log((JSON.parse(await readFile(new URL('../package.json',import.meta.url),'utf8')) as {version:string}).version);return;}
97
99
  if(args[0]==='control')return controlCommand(args.slice(1),options.stateDir);
98
100
  if(args[0]==='open'){const openArgs=args.slice(1);if(commandHelpRequested(openArgs,'open')){console.log(usage);return;}const inputs=parseOpenInputs(openArgs);const result=await openReview(inputs,options);// Launcher contract (README): stdout is the URL line alone; stderr is diagnostic, control notice, retrieval, in that order.
99
101
  console.log(result.url);if(result.build)console.error(buildOpenDiagnostic(result.build));if(result.selection)console.error(animationDiagnostic(result.selection));if(inputs.control)console.error('Inspection control enabled; query the current connected page with rig-review control and the same inputs.');console.error(`Review ${result.reused?'reused':'started'}; feedback: rig-review feedback ${[result.inputs.input,...(result.inputs.compare?['--compare',result.inputs.compare]:[]),...(result.inputs.reference?['--reference',result.inputs.reference]:[]),...(result.inputs.animation?['--animation',result.inputs.animation]:[]),...handoffWords(result.inputs)].map(shellWord).join(' ')}`);return;}
package/web/i18n.ts CHANGED
@@ -107,8 +107,15 @@ export function resolveLanguage(
107
107
  return tag === 'ko' || tag.startsWith('ko-') || tag.startsWith('ko_') ? 'ko' : 'en';
108
108
  }
109
109
 
110
+ /** A link's `?lang=`: en and ko force the page, anything else is no opinion. */
111
+ export function languageFromSearch(search: string): ResolvedLanguage | null {
112
+ const value = new URLSearchParams(search).get('lang');
113
+ return value === 'en' || value === 'ko' ? value : null;
114
+ }
115
+
116
+ let linkLanguage: ResolvedLanguage | null = typeof location !== 'undefined' ? languageFromSearch(location.search) : null;
110
117
  let currentPreference: WorkspaceLanguage = 'system';
111
- let currentLanguage: ResolvedLanguage = resolveLanguage('system');
118
+ let currentLanguage: ResolvedLanguage = resolveLanguage(linkLanguage ?? 'system');
112
119
  const listeners = new Set<(lang: ResolvedLanguage) => void>();
113
120
 
114
121
  export function getLanguage(): ResolvedLanguage {
@@ -119,6 +126,16 @@ export function getLanguagePreference(): WorkspaceLanguage {
119
126
  return currentPreference;
120
127
  }
121
128
 
129
+ /** The language a link forces, never stored, so a shared link cannot change a reader's saved choice. */
130
+ export function getLinkLanguage(): ResolvedLanguage | null {
131
+ return linkLanguage;
132
+ }
133
+
134
+ /** A pick in the settings menu outranks the link for the rest of the page. */
135
+ export function setLinkLanguage(language: ResolvedLanguage | null): void {
136
+ linkLanguage = language;
137
+ }
138
+
122
139
  export function syncDocumentLanguage(doc?: Document | null): void {
123
140
  const target = doc === undefined ? (typeof document !== 'undefined' ? document : null) : doc;
124
141
  if (target?.documentElement) {
@@ -131,7 +148,7 @@ export function setLanguagePreference(
131
148
  nav?: NavigatorLanguageLike | null
132
149
  ): ResolvedLanguage {
133
150
  currentPreference = preference;
134
- const resolved = resolveLanguage(preference, nav);
151
+ const resolved = resolveLanguage(linkLanguage ?? preference, nav);
135
152
  currentLanguage = resolved;
136
153
  syncDocumentLanguage();
137
154
  if (boundRoot) {
@@ -1,7 +1,7 @@
1
1
  /** Browser workspace presentation. Source selection, player clocks and review decisions stay with the page. */
2
2
  import {WorkspacePreferenceStore,panelBounds,type WorkspaceLanguage,type WorkspacePanels,type WorkspacePreferences,type WorkspaceTheme} from './workspace-preferences.ts';
3
3
  import {allocateWorkspaceLayout,bindWorkspaceSeparator,bindWorkspaceDrawer,defaultWorkspaceColumns,InspectorScrollMemory,inspectorTabs,workspaceMinimums,type InspectorTab,type WorkspaceColumns,type WorkspacePanel,type SeparatorRange} from './workspace-layout.ts';
4
- import {bindDomI18n,setLanguagePreference,tr} from './i18n.ts';
4
+ import {bindDomI18n,getLinkLanguage,setLanguagePreference,setLinkLanguage,tr} from './i18n.ts';
5
5
 
6
6
  /** Reachable effective bounds, accounting for the other panel's saved desired size. */
7
7
  export function workspaceResizeRange(available:{width:number;height:number},desired:WorkspacePanels,panel:WorkspacePanel,columns:WorkspaceColumns=defaultWorkspaceColumns):SeparatorRange {
@@ -91,8 +91,8 @@ export function bindWorkspaceUI(options:{changed:()=>void;defaultTheme:(theme:Wo
91
91
  layout.dataset.stageMinimum=String(effective.stageMinimumSatisfied);for(const binding of bindings)binding.refresh();options.changed();restore();
92
92
  }finally{applying=false;}
93
93
  }
94
- const renderSettings=()=>{const value=store.get();setLanguagePreference(value.language);settingsToggle.setAttribute('aria-expanded',String(!value.settingsCollapsed));settingsBody.hidden=value.settingsCollapsed;settings.dataset.collapsed=String(value.settingsCollapsed);theme.value=options.currentTheme?.()??value.theme;language.value=value.language;sync.checked=value.defaultCameraSync;idle.checked=value.defaultIdleRepeat;status.textContent=tr(store.status().detail);};
95
- theme.onchange=()=>{store.update({theme:theme.value as WorkspaceTheme});options.defaultTheme(store.get().theme);};language.onchange=()=>{store.update({language:language.value as WorkspaceLanguage});setLanguagePreference(store.get().language);};sync.onchange=()=>{store.update({defaultCameraSync:sync.checked});};idle.onchange=()=>{store.update({defaultIdleRepeat:idle.checked});};require<HTMLButtonElement>('settings-reset').onclick=()=>store.resetLayout();settingsToggle.onclick=()=>{store.update({settingsCollapsed:!store.get().settingsCollapsed});};
94
+ const renderSettings=()=>{const value=store.get();setLanguagePreference(value.language);settingsToggle.setAttribute('aria-expanded',String(!value.settingsCollapsed));settingsBody.hidden=value.settingsCollapsed;settings.dataset.collapsed=String(value.settingsCollapsed);theme.value=options.currentTheme?.()??value.theme;language.value=getLinkLanguage()??value.language;sync.checked=value.defaultCameraSync;idle.checked=value.defaultIdleRepeat;status.textContent=tr(store.status().detail);};
95
+ theme.onchange=()=>{store.update({theme:theme.value as WorkspaceTheme});options.defaultTheme(store.get().theme);};language.onchange=()=>{setLinkLanguage(null);store.update({language:language.value as WorkspaceLanguage});setLanguagePreference(store.get().language);};sync.onchange=()=>{store.update({defaultCameraSync:sync.checked});};idle.onchange=()=>{store.update({defaultIdleRepeat:idle.checked});};require<HTMLButtonElement>('settings-reset').onclick=()=>store.resetLayout();settingsToggle.onclick=()=>{store.update({settingsCollapsed:!store.get().settingsCollapsed});};
96
96
  bindDomI18n(document);const unsubscribe=store.subscribe(value=>{desired={...value.panels};renderSettings();schedule();});renderSettings();
97
97
  for(const tab of tabs){
98
98
  const panel=panelFor(tab);let timer:ReturnType<typeof setTimeout>|undefined;