Files
Netcatty/infrastructure/scripts/nctMonacoCompletion.ts
T
陈大猫andCursor 6b9b71ac8a feat(scripts): terminal script automation, recording, and side panel (#1763)
* feat(scripts): add terminal script automation, recording, and side panel

Introduce nct script runtime in the main process with terminal-side recording,
execution overlay, Monaco editor, connect-script queues, and scripts side panel
integration. Fix recording to wire scriptRecorderRef into xterm, use waitForPrompt
for root/user shells, and save recorded scripts through the global editor dialog.

Co-authored-by: Cursor <cursoragent@cursor.com>

* fix(scripts): address Bugbot review findings for recording and side panel

Refresh script run state in side panel memo, guard toolbar recording against
multi-session conflicts, reset connect scripts on reconnect, resolve focused
session via getActiveTerminalSessionId, and avoid wiping host edit form when
snippets list updates.

Co-authored-by: Cursor <cursoragent@cursor.com>

* fix(scripts): prevent pending script re-run and improve workspace run feedback

Track one-shot pendingScript execution separately from onConnect queue so
reconnects do not replay Run-now scripts. Fall back to focused session when
running on all tabs outside a workspace, and toast when every tab is still
connecting.

Co-authored-by: Cursor <cursoragent@cursor.com>

* fix(scripts): consume connect-script window once and filter serial hosts

Mark the onConnect script evaluation as consumed even when the queue is
empty so later snippet/host edits do not rerun automation mid-session.
Restore serial-host filtering in SelectHostPanel confirm handler.

Co-authored-by: Cursor <cursoragent@cursor.com>

* fix(scripts): grace period before giving up on connect-script queue

Only mark onConnect automation as consumed after scripts run or a short
post-connect grace window expires, so late-loading snippets still trigger
while mid-session Vault edits do not.

Co-authored-by: Cursor <cursoragent@cursor.com>

* fix(scripts): gate connect-script consumption on vault hydration

Replace the grace timer with vault-init and unresolved host script binding
checks so late-loading snippets still run onConnect automation while
mid-session edits stay suppressed. Clear pending script run state on
disconnect so reconnect retries workspace pending scripts.

Co-authored-by: Cursor <cursoragent@cursor.com>

* fix(scripts): honor run targets and retry failed connect automation

Route QuickScriptEditorDialog Run through onRunSnippet for multi-host
workspaces. Defer connect/pending script completion markers until each
script succeeds and retry the queue after failures.

Co-authored-by: Cursor <cursoragent@cursor.com>

* fix(scripts): stabilize pending runs and global connect queue sync

Keep pending script run state across reconnects, run onConnect scripts
before one-shot workspace pending scripts, and strip per-host queue entries
when an onConnect script targets all hosts.

Co-authored-by: Cursor <cursoragent@cursor.com>

* fix(scripts): defer host queue snippet sync and guard connect runs

Persist snippet target links only when the host panel is saved, block
duplicate connect-script scheduling while a batch is running, and require
runnable hosts before showing Run in the snippets editor footer.

Co-authored-by: Cursor <cursoragent@cursor.com>

* fix(scripts): retry connect failures and surface output-trigger errors

Use a retry tick in connect-script effect deps, toast automation failures
from output triggers, and require runnable hosts before QuickScript Run.

Co-authored-by: Cursor <cursoragent@cursor.com>

* fix(scripts): track id-less pending runs and re-arm output triggers

Remember anonymous pendingScript objects after first run and allow
onOutput triggers to fire again when new terminal output arrives.

Co-authored-by: Cursor <cursoragent@cursor.com>

* fix(scripts): unblock paused connect runs and pass session meta

Resolve waitForScriptRun on pause, run workspace scripts per session
with hostname context, defer output-trigger arming until runs start, and
add noRunnableHosts i18n for QuickScript Run.

Co-authored-by: Cursor <cursoragent@cursor.com>

* fix(scripts): serialize output triggers and defer empty connect finalize

Fire at most one onOutput trigger per scan while a run is active, and
only finalize an empty connect queue after vault snippets are loaded.

Co-authored-by: Cursor <cursoragent@cursor.com>

* fix(scripts): guard output launch race and script run waits

Block overlapping onOutput launches, timeout stuck waitForScriptRun
promises, and disable vault Run when no connectable targets exist.

Co-authored-by: Cursor <cursoragent@cursor.com>

* fix(scripts): match output triggers on new chunks only

Scan onOutput patterns against recent terminal output instead of buffer
length dedupe, and restore overflow-visible on SelectHostPanel new-host flow.

Co-authored-by: Cursor <cursoragent@cursor.com>

* fix(scripts): await sequential workspace runs and output launch

Wait for each tab script to finish in sequential workspace mode, and hold
output-trigger launch guard until the session run becomes active.

Co-authored-by: Cursor <cursoragent@cursor.com>

* fix(scripts): wait through pause and hold output trigger until done

Keep connect and sequential workspace queues blocked until scripts
complete or fail, and retain output-trigger guard until the launched run
finishes.

Co-authored-by: Cursor <cursoragent@cursor.com>

* fix(scripts): harden output trigger wait helpers

Add explicit timeouts to output-trigger wait helpers and stop rescanning
the buffer after script completion to avoid sticky-match rerun loops.

Co-authored-by: Cursor <cursoragent@cursor.com>

* fix(scripts): allow empty connect queue and match output in new chunks

Treat an empty connectScriptIds array as an explicit cleared queue instead
of re-migrating from snippet targets, and only fire onOutput triggers when
the latest terminal output contains the pattern.

Co-authored-by: Cursor <cursoragent@cursor.com>

* fix(scripts): require fresh output overlap for onOutput triggers

Only fire output-matched scripts when the regex match extends into the
latest terminal chunk, preventing reruns from stale buffer text.

Co-authored-by: Cursor <cursoragent@cursor.com>

* fix(scripts): promote manual scripts added to host connect queue

Diff connect queue changes from raw connectScriptIds so saving a host
updates manual scripts to onConnect when they are newly queued.

Co-authored-by: Cursor <cursoragent@cursor.com>

* fix(scripts): dedupe output triggers by match position

Track the buffer end offset of each output trigger match and ignore
stale re-scans, with a longer wait for run registration before retry.

Co-authored-by: Cursor <cursoragent@cursor.com>

* fix(scripts): record output trigger matches only after run starts

Propagate automation launch failures to output triggers and commit match
dedupe only once the session run is registered as active.

Co-authored-by: Cursor <cursoragent@cursor.com>

* fix(scripts): address Codex review on wait cursor and sensitive codegen

Track scan offset so waitFor/waitForAny only match output after the previous wait, and emit sendLine after sensitive prompt in recorded scripts.

Co-authored-by: Cursor <cursoragent@cursor.com>

* fix(scripts): harden onOutput triggers against PTY echo and local input

Filter server output before pattern matching so onOutput fires only after
Enter on real stdout, not on keystroke/paste echo, OSC/SGR sequences, or
alternate-screen apps. Add dev diagnostics and scope triggers to the active
session when no explicit host targets are configured.

Co-authored-by: Cursor <cursoragent@cursor.com>

* chore(scripts): remove onOutput trigger debug logging

Drop temporary diagnostics module and console traces now that PTY echo
filtering is verified; keep the production trigger pipeline unchanged.

Co-authored-by: Cursor <cursoragent@cursor.com>

---------

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-06-28 23:48:12 +08:00

181 lines
5.8 KiB
TypeScript

import type { Monaco } from '@monaco-editor/react';
type CompletionDisposable = { dispose: () => void };
const NCT_API_COMPLETIONS = [
{
label: 'nct.screen.waitForPrompt',
insertText: 'await nct.screen.waitForPrompt(${1:30000});',
detail: 'Wait for shell prompt',
documentation: 'Wait until an interactive shell prompt appears (# for root, $ for regular user).',
},
{
label: 'nct.screen.waitFor',
insertText: "await nct.screen.waitFor('${1:pattern}', ${2:30000});",
detail: 'Wait for terminal output',
documentation: 'Wait until the session output matches a literal string or /regex/flags pattern.',
},
{
label: 'nct.screen.waitForAny',
insertText: "await nct.screen.waitForAny(['# ', '$ ', '~# ', '~$ '], ${1:30000});",
detail: 'Wait for any pattern',
documentation: 'Wait until any of the given patterns appears in session output.',
},
{
label: 'nct.screen.sendLine',
insertText: "await nct.screen.sendLine('${1:command}');",
detail: 'Send line + Enter',
documentation: 'Send text to the terminal followed by carriage return.',
},
{
label: 'nct.screen.send',
insertText: "await nct.screen.send('${1:text}');",
detail: 'Send text',
documentation: 'Send text to the terminal without pressing Enter.',
},
{
label: 'nct.screen.getText',
insertText: 'const output = await nct.screen.getText();',
detail: 'Read terminal text',
documentation: 'Read visible terminal buffer text or a row range.',
},
{
label: 'nct.screen.clear',
insertText: 'await nct.screen.clear();',
detail: 'Clear terminal screen',
documentation: 'Send a clear-screen sequence to the terminal.',
},
{
label: 'nct.session.sleep',
insertText: 'await nct.session.sleep(${1:1000});',
detail: 'Pause script',
documentation: 'Pause script execution for the given milliseconds.',
},
{
label: 'nct.sleep',
insertText: 'await nct.sleep(${1:1000});',
detail: 'Pause script',
documentation: 'Alias for nct.session.sleep.',
},
{
label: 'nct.session.startLog',
insertText: "await nct.session.startLog('${1:./script.log}');",
detail: 'Start session log',
documentation: 'Start writing session output to a local log file.',
},
{
label: 'nct.session.stopLog',
insertText: 'await nct.session.stopLog();',
detail: 'Stop session log',
documentation: 'Stop the active script log stream.',
},
{
label: 'nct.session.disconnect',
insertText: 'await nct.session.disconnect();',
detail: 'Disconnect session',
documentation: 'Close the current terminal session.',
},
{
label: 'nct.dialog.confirm',
insertText: "const ok = await nct.dialog.confirm('${1:Continue?}');",
detail: 'Confirm dialog',
documentation: 'Show a confirm dialog and return true when accepted.',
},
{
label: 'nct.dialog.prompt',
insertText: "const value = await nct.dialog.prompt('${1:Input}', '${2:}');",
detail: 'Prompt dialog',
documentation: 'Show an input dialog and return the entered string.',
},
{
label: 'nct.dialog.alert',
insertText: "await nct.dialog.alert('${1:Message}');",
detail: 'Alert dialog',
documentation: 'Show an informational alert dialog.',
},
{
label: 'nct.log',
insertText: "nct.log('${1:message}');",
detail: 'Script log',
documentation: 'Append a line to the script run log panel.',
},
{
label: 'nct.progress.start',
insertText: "nct.progress.start('${1:Phase name}', ${2:total});",
detail: 'Start determinate progress',
documentation: 'Opt in to a labeled X/Y progress bar for known-length loops.',
},
{
label: 'nct.progress.step',
insertText: "nct.progress.step('${1:detail}');",
detail: 'Advance progress',
documentation: 'Increment determinate progress by one step.',
},
{
label: 'nct.progress.set',
insertText: "nct.progress.set(${1:current}, '${2:detail}');",
detail: 'Set progress position',
documentation: 'Set determinate progress to a specific index.',
},
{
label: 'nct.progress.done',
insertText: 'nct.progress.done();',
detail: 'Finish progress phase',
documentation: 'Complete the current determinate progress phase.',
},
];
let registered = false;
let disposable: CompletionDisposable | null = null;
export function registerNctMonacoCompletionProvider(monaco: Monaco): CompletionDisposable {
if (registered && disposable) {
return disposable;
}
disposable = monaco.languages.registerCompletionItemProvider('javascript', {
triggerCharacters: ['.', '('],
provideCompletionItems: (model, position) => {
const word = model.getWordUntilPosition(position);
const range = {
startLineNumber: position.lineNumber,
endLineNumber: position.lineNumber,
startColumn: word.startColumn,
endColumn: word.endColumn,
};
const prefix = model.getValueInRange({
startLineNumber: position.lineNumber,
startColumn: 1,
endLineNumber: position.lineNumber,
endColumn: position.column,
});
const suggestions = NCT_API_COMPLETIONS
.filter((item) => {
if (prefix.trim().length === 0) return true;
return item.label.startsWith('nct') && prefix.includes('nct');
})
.map((item) => ({
label: item.label,
kind: monaco.languages.CompletionItemKind.Method,
insertText: item.insertText,
insertTextRules: monaco.languages.CompletionItemInsertTextRule.InsertAsSnippet,
detail: item.detail,
documentation: item.documentation,
range,
}));
return { suggestions };
},
});
registered = true;
return disposable;
}
export function disposeNctMonacoCompletionProvider() {
disposable?.dispose();
disposable = null;
registered = false;
}