@yanglaofish/fishtools 0.5.0 → 0.5.2

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 (84) hide show
  1. package/README.md +4 -2
  2. package/manual/README.md +4 -2
  3. package/manual/docs/deployment.md +2 -2
  4. package/manual/docs/modules.md +2 -0
  5. package/manual/docs/plugin-development.md +3 -1
  6. package/manual/docs/releases.md +44 -6
  7. package/manual/docs/superpowers/plans/2026-10-13-command-shortcuts.md +107 -0
  8. package/manual/docs/superpowers/reviews/2026-10-13-0.5.0-followup-review.md +70 -0
  9. package/manual/docs/superpowers/reviews/2026-10-13-command-shortcuts-review.md +63 -0
  10. package/manual/docs/superpowers/specs/2026-10-12-workflow-variation-design.md +1 -1
  11. package/manual/docs/superpowers/specs/2026-10-13-command-shortcuts-design.md +56 -0
  12. package/manual/docs/superpowers/specs/2026-10-13-issue-4-workflow-menu.md +28 -0
  13. package/manual/docs/terminal-commands.md +64 -0
  14. package/manual/docs/verification.md +39 -1
  15. package/manual/packages/core/README.md +3 -1
  16. package/manual/packages/core/package.json +1 -0
  17. package/manual/packages/core/src/application.js +126 -20
  18. package/manual/packages/core/src/export-snapshot.js +20 -1
  19. package/manual/packages/core/src/version.js +1 -1
  20. package/manual/packages/fst-cli/README.md +8 -1
  21. package/manual/packages/fst-cli/package.json +1 -0
  22. package/manual/packages/fst-cli/src/terminal/command-menu.js +186 -0
  23. package/manual/packages/fst-cli/src/terminal/navigation.js +4 -3
  24. package/manual/packages/fst-cli/src/terminal/run-feed.js +24 -9
  25. package/manual/packages/fst-cli/src/terminal/session.js +35 -4
  26. package/manual/packages/fst-cli/src/terminal/view.js +43 -8
  27. package/manual/packages/fst-cli/src/terminal/workflow-menu.js +1 -6
  28. package/manual/packages/fst-devtools/src/documentation.js +2 -1
  29. package/manual/packages/fst-logs/README.md +11 -0
  30. package/manual/packages/fst-logs/package.json +2 -0
  31. package/manual/packages/fst-logs/src/run-logs.js +8 -23
  32. package/manual/packages/fst-logs/src/run-preview.js +18 -0
  33. package/manual/packages/fst-logs/src/step-summaries.js +28 -0
  34. package/manual/packages/fst-platform/README.md +17 -0
  35. package/manual/packages/fst-platform/package.json +1 -0
  36. package/manual/packages/fst-platform/src/process.js +12 -8
  37. package/manual/packages/fst-platform/src/shell.js +58 -0
  38. package/manual/packages/fst-plugin/src/contracts.js +6 -2
  39. package/manual/packages/fst-plugin/src/host.js +7 -4
  40. package/manual/packages/fst-plugin/src/runtime.js +8 -5
  41. package/manual/packages/fst-workspace/README.md +3 -0
  42. package/manual/packages/fst-workspace/package.json +1 -0
  43. package/manual/packages/fst-workspace/src/shortcuts.js +119 -0
  44. package/manual/packages/pack/index.js +1 -1
  45. package/manual/plugins/commands/LICENSE +21 -0
  46. package/manual/plugins/commands/README.md +41 -0
  47. package/manual/plugins/commands/index.js +94 -0
  48. package/manual/plugins/commands/package.json +17 -0
  49. package/node_modules/@mytools/commands/LICENSE +21 -0
  50. package/node_modules/@mytools/commands/README.md +41 -0
  51. package/node_modules/@mytools/commands/index.js +94 -0
  52. package/node_modules/@mytools/commands/package.json +17 -0
  53. package/node_modules/@mytools/core/README.md +3 -1
  54. package/node_modules/@mytools/core/package.json +1 -0
  55. package/node_modules/@mytools/core/src/application.js +126 -20
  56. package/node_modules/@mytools/core/src/export-snapshot.js +20 -1
  57. package/node_modules/@mytools/core/src/version.js +1 -1
  58. package/node_modules/@mytools/fst-cli/README.md +8 -1
  59. package/node_modules/@mytools/fst-cli/package.json +1 -0
  60. package/node_modules/@mytools/fst-cli/src/terminal/command-menu.js +186 -0
  61. package/node_modules/@mytools/fst-cli/src/terminal/navigation.js +4 -3
  62. package/node_modules/@mytools/fst-cli/src/terminal/run-feed.js +24 -9
  63. package/node_modules/@mytools/fst-cli/src/terminal/session.js +35 -4
  64. package/node_modules/@mytools/fst-cli/src/terminal/view.js +43 -8
  65. package/node_modules/@mytools/fst-cli/src/terminal/workflow-menu.js +1 -6
  66. package/node_modules/@mytools/fst-devtools/src/documentation.js +2 -1
  67. package/node_modules/@mytools/fst-logs/README.md +11 -0
  68. package/node_modules/@mytools/fst-logs/package.json +2 -0
  69. package/node_modules/@mytools/fst-logs/src/run-logs.js +8 -23
  70. package/node_modules/@mytools/fst-logs/src/run-preview.js +18 -0
  71. package/node_modules/@mytools/fst-logs/src/step-summaries.js +28 -0
  72. package/node_modules/@mytools/fst-platform/README.md +17 -0
  73. package/node_modules/@mytools/fst-platform/package.json +1 -0
  74. package/node_modules/@mytools/fst-platform/src/process.js +12 -8
  75. package/node_modules/@mytools/fst-platform/src/shell.js +58 -0
  76. package/node_modules/@mytools/fst-plugin/src/contracts.js +6 -2
  77. package/node_modules/@mytools/fst-plugin/src/host.js +7 -4
  78. package/node_modules/@mytools/fst-plugin/src/runtime.js +8 -5
  79. package/node_modules/@mytools/fst-workspace/README.md +3 -0
  80. package/node_modules/@mytools/fst-workspace/package.json +1 -0
  81. package/node_modules/@mytools/fst-workspace/src/shortcuts.js +119 -0
  82. package/node_modules/@mytools/pack/index.js +1 -1
  83. package/node_modules/@mytools/web/public/THIRD_PARTY_NOTICES.txt +1212 -1187
  84. package/package.json +3 -1
@@ -2,7 +2,9 @@ import path from 'node:path';
2
2
  import {readdir,readFile,lstat,unlink,rmdir,mkdir,writeFile,appendFile,open} from 'node:fs/promises';
3
3
  import {FlowError} from '@mytools/sdk';
4
4
  import {markdownHeader,markdownEvent,markdownResult} from './markdown-log.js';
5
- import {logPolicy,jsonSize,preview,eventPreview} from './log-bounds.js';
5
+ import {logPolicy,jsonSize,eventPreview} from './log-bounds.js';
6
+ import {createStepSummaries} from './step-summaries.js';
7
+ import {previewRun} from './run-preview.js';
6
8
 
7
9
  const validId=id=>typeof id==='string'&&/^[a-f0-9-]{36}$/.test(id);
8
10
  const logFiles=['run.md','events.jsonl','result.json','run.meta.json'];
@@ -68,15 +70,15 @@ export function createRunLogs(directory,{projectDir,allowLegacy=false,...options
68
70
  return {
69
71
  list,read,owner,policy:Object.freeze({...policy}),
70
72
  async start(initial,{onEvent=()=>{}}={}){
71
- const directory=location(initial.id),events=[],sizes=[],steps=new Map();
73
+ const directory=location(initial.id),events=[],sizes=[],steps=createStepSummaries(policy);
72
74
  await mkdir(root,{recursive:true});
73
75
  const rootStat=await lstat(root);if(!rootStat.isDirectory()||rootStat.isSymbolicLink())throw new FlowError('日志根目录无效');
74
76
  await mkdir(directory,{recursive:true});
75
77
  await safeDirectory(initial.id);
76
78
  for(const name of logFiles){try{await lstat(path.join(directory,name));throw new FlowError('运行日志已存在,拒绝覆盖');}catch(error){if(error.code!=='ENOENT')throw error;}}
77
79
  const markdownFile=path.join(directory,'run.md');
78
- let writes=Promise.resolve(),failure=null,pendingBytes=0,diskBytes=0,resultBytes=0,eventCount=0,eventBytes=2,eventsTruncated=false,stepSummaryBytes=2,stepsTruncated=false,finished=false;
79
- const snapshot=state=>structuredClone({...initial,...state,logOwner:owner,events,eventCount,eventBytes,eventsTruncated,stepSummaries:[...steps.values()].map(entry=>entry.event),stepSummaryBytes,stepsTruncated});
80
+ let writes=Promise.resolve(),failure=null,pendingBytes=0,diskBytes=0,resultBytes=0,eventCount=0,eventBytes=2,eventsTruncated=false,finished=false;
81
+ const snapshot=state=>structuredClone({...initial,...state,logOwner:owner,events,eventCount,eventBytes,eventsTruncated,...steps.snapshot()});
80
82
  const reject=error=>{failure??=error;const promise=Promise.reject(failure);promise.catch(()=>{});return promise;};
81
83
  function diskCheck(extra){if(policy.maxDiskBytes!==null&&diskBytes+extra>policy.maxDiskBytes)throw new FlowError('日志磁盘预算已满',{code:'LOG_DISK_LIMIT',details:{maxDiskBytes:policy.maxDiskBytes}});}
82
84
  const queue=(bytes,operation)=>{
@@ -95,28 +97,11 @@ export function createRunLogs(directory,{projectDir,allowLegacy=false,...options
95
97
  while(events.length>policy.maxEvents||eventBytes>policy.maxMemoryBytes){
96
98
  const removed=sizes.shift();events.shift();eventBytes-=removed+(events.length?1:0);eventsTruncated=true;
97
99
  }
98
- if(typeof full.type==='string'&&full.type.startsWith('step.')&&(full.callPath!==undefined||full.stepId!==undefined)){
99
- const lightweight={};
100
- for(const key of ['type','callPath','stepId','action','time','seq','durationMs','reason','error'])if(full[key]!==undefined)lightweight[key]=full[key];
101
- const summary=eventPreview(lightweight,policy.maxEventBytes),key=summary.callPath??summary.stepId;
102
- if(key!==undefined&&summary.callPath===full.callPath&&summary.stepId===full.stepId){
103
- const previous=steps.get(key);
104
- if(previous){steps.delete(key);stepSummaryBytes-=previous.bytes+(steps.size?1:0);}
105
- const bytes=Buffer.byteLength(JSON.stringify(summary));steps.set(key,{event:summary,bytes});stepSummaryBytes+=bytes+(steps.size>1?1:0);
106
- while(steps.size>policy.maxEvents||stepSummaryBytes>policy.maxMemoryBytes){
107
- const oldest=steps.keys().next().value,removed=steps.get(oldest);steps.delete(oldest);stepSummaryBytes-=removed.bytes+(steps.size?1:0);stepsTruncated=true;
108
- }
109
- }else stepsTruncated=true;
110
- }
100
+ steps.append(full);
111
101
  onEvent(structuredClone(event));
112
102
  }
113
103
  function metadata(state){
114
- const run={...initial,...state,logOwner:owner,events,eventCount,eventBytes,eventsTruncated,stepSummaries:[...steps.values()].map(entry=>entry.event),stepSummaryBytes,stepsTruncated};
115
- for(const key of Object.keys(run)){
116
- if(['events','stepSummaries','id','workflowId','logOwner','status','startedAt','finishedAt'].includes(key))continue;
117
- if(run[key]===undefined)continue;
118
- const bounded=preview(run[key],policy.maxEventBytes);run[key]=bounded.value;if(bounded.truncated)run[`${key}Truncated`]=true;
119
- }
104
+ const run=previewRun({...initial,...state,logOwner:owner,events,eventCount,eventBytes,eventsTruncated,...steps.snapshot()},{maxValueBytes:policy.maxEventBytes});
120
105
  const text=JSON.stringify(run);
121
106
  if(Buffer.byteLength(text)>metadataLimit)throw new FlowError('运行记录元数据超过写入预算',{code:'LOG_METADATA_LIMIT'});
122
107
  return text;
@@ -0,0 +1,18 @@
1
+ import {FlowError} from '@mytools/sdk';
2
+ import {defaults,preview,jsonSize} from './log-bounds.js';
3
+
4
+ const retainedFields=new Set(['events','stepSummaries','id','workflowId','logOwner','status','startedAt','finishedAt']);
5
+
6
+ // 路由信息与已有独立预算的缓存保留;业务正文和诊断字段只投影有界预览。
7
+ export function previewRun(record,{maxValueBytes=defaults.maxEventBytes}={}){
8
+ if(!Number.isSafeInteger(maxValueBytes)||maxValueBytes<2)throw new FlowError('结果预览 maxValueBytes 必须为至少 2 的整数字节数');
9
+ const run={...record};
10
+ for(const key of Object.keys(run)){
11
+ if(retainedFields.has(key)||run[key]===undefined)continue;
12
+ const bounded=preview(run[key],maxValueBytes);
13
+ if(jsonSize(bounded.value,maxValueBytes)>maxValueBytes)delete run[key];
14
+ else run[key]=bounded.value;
15
+ if(bounded.truncated)run[`${key}Truncated`]=true;
16
+ }
17
+ return run;
18
+ }
@@ -0,0 +1,28 @@
1
+ import {logPolicy,eventPreview} from './log-bounds.js';
2
+
3
+ // 日志写入器与展示端共用轻量摘要,避免各端重新缓存业务 input/output。
4
+ export function createStepSummaries(options={}){
5
+ const policy=logPolicy(options),steps=new Map();
6
+ let bytes=2,truncated=false;
7
+ return {
8
+ append(full){
9
+ if(typeof full.type!=='string'||!full.type.startsWith('step.')||(full.callPath===undefined&&full.stepId===undefined))return;
10
+ const lightweight={};
11
+ for(const key of ['type','callPath','stepId','action','time','seq','durationMs','reason','error'])if(full[key]!==undefined)lightweight[key]=full[key];
12
+ const summary=eventPreview(lightweight,policy.maxEventBytes),key=summary.callPath??summary.stepId;
13
+ if(key===undefined||summary.callPath!==full.callPath||summary.stepId!==full.stepId){truncated=true;return;}
14
+ const previous=steps.get(key);
15
+ if(previous){steps.delete(key);bytes-=previous.bytes+(steps.size?1:0);}
16
+ const size=Buffer.byteLength(JSON.stringify(summary));
17
+ steps.set(key,{event:summary,bytes:size});bytes+=size+(steps.size>1?1:0);
18
+ while(steps.size>policy.maxEvents||bytes>policy.maxMemoryBytes){
19
+ const oldest=steps.keys().next().value,removed=steps.get(oldest);
20
+ steps.delete(oldest);bytes-=removed.bytes+(steps.size?1:0);truncated=true;
21
+ }
22
+ },
23
+ get size(){return steps.size;},
24
+ get(key){return structuredClone(steps.get(key)?.event);},
25
+ values(){return [...steps.values()].map(entry=>structuredClone(entry.event));},
26
+ snapshot(){return {stepSummaries:this.values(),stepSummaryBytes:bytes,stepsTruncated:truncated};},
27
+ };
28
+ }
@@ -16,7 +16,9 @@
16
16
  | `@mytools/fst-platform/bundle` | `./src/bundle.js` |
17
17
  | `@mytools/fst-platform/json` | `./src/json.js` |
18
18
  | `@mytools/fst-platform/npm` | `./src/npm.js` |
19
+ | `@mytools/fst-platform/network` | `./src/network.js` |
19
20
  | `@mytools/fst-platform/fs` | `./src/file-probe.js` |
21
+ | `@mytools/fst-platform/shell` | `./src/shell.js` |
20
22
  | `@mytools/fst-platform/package.json` | `./package.json` |
21
23
 
22
24
  仅依赖 exports 声明的入口,禁止消费者跨包读取 src/bin 私有文件。入口路径由本模块维护,修改协议时同步消费方回归。
@@ -31,6 +33,21 @@
31
33
  node --test tests/modules.test.js tests/process.test.js tests/environments.test.js
32
34
  ```
33
35
 
36
+ 进程停止专项:`node --test tests/process.test.js tests/process-stream.test.js tests/process-tree-stop.test.js`。
37
+
38
+ ## 子进程环境
39
+
40
+ `/shell` 的 `runShell(script,{shell='auto',runProcess,temporaryDir,...processOptions})` 使用唯一临时脚本文件,避免长脚本超过系统命令行长度上限,运行结束后删除本次文件。默认 Windows PowerShell / Linux sh,可选 powershell、pwsh、sh、bash;PowerShell 使用 UTF-8 BOM,其他 Shell 使用无 BOM UTF-8。插件传入 `ctx.runProcess` 与 `temporaryDir:ctx.outputDir`,保留当前代理、取消与日志规则,并兼容只读包目录。`shellInvocation` 保留构造简短命令参数的兼容接口。
41
+
42
+ `runProcess(file,args,{env,extendEnv=true})` 默认把 `env` 覆盖到宿主环境上。
43
+ 当调用方已按动作代理规则构造完整环境时,传 `extendEnv:false`,防止已移除的代理变量被重新继承。
44
+
45
+ 缓冲模式由平台按每条输出流的原始字节计算 `maxBuffer`,默认每条流 4 MiB;超限返回 `OUTPUT_LIMIT`。
46
+ `maxBuffer` 必须为非负数,`0` 仅允许空输出,`Infinity` 表示调用方显式取消缓冲上限;对象、`NaN` 和负数会在启动前被拒绝。
47
+ 流式模式通过 `onOutput` 消费输出,仅保留 `summaryBytes` 指定的尾部摘要。
48
+ 超限、取消、超时或输出回调失败时,平台终止整棵进程树,等待回收结束后返回错误。
49
+ 停止过程中继续排空并丢弃管道输出,避免提前关闭管道使父进程因 `EPIPE` 退出,导致 Windows `taskkill /T` 无法找到后代进程。
50
+
34
51
  ## 隔离文件探测
35
52
 
36
53
  `createFileProbe({timeout=2000,maxConcurrent=2,maxPending=16,allowRemote=false})` 创建只读探测器。
@@ -6,6 +6,7 @@
6
6
  "main": "src/process.js",
7
7
  "exports": {
8
8
  ".": "./src/process.js",
9
+ "./shell": "./src/shell.js",
9
10
  "./environments": "./src/environments.js",
10
11
  "./bundle": "./src/bundle.js",
11
12
  "./json": "./src/json.js",
@@ -4,11 +4,11 @@ import which from 'which';
4
4
  import { FlowError } from '@mytools/sdk';
5
5
  import path from 'node:path';
6
6
 
7
- const outputText=bytes=>bytes??new Uint8Array();
8
7
  const stripFinalNewline=text=>text.endsWith('\r\n')?text.slice(0,-2):text.endsWith('\n')?text.slice(0,-1):text;
9
8
 
10
- export async function runProcess(file,args=[],{cwd,env,signal,timeout=30000,maxBuffer=4*1024*1024,encoding='utf8',onOutput,outputMode='buffer',summaryBytes=65536}={}) {
9
+ export async function runProcess(file,args=[],{cwd,env,extendEnv=true,signal,timeout=30000,maxBuffer=4*1024*1024,encoding='utf8',onOutput,outputMode='buffer',summaryBytes=65536}={}) {
11
10
  if(!['buffer','stream'].includes(outputMode))throw new TypeError('outputMode 必须为 buffer 或 stream');
11
+ if(typeof maxBuffer!=='number'||Number.isNaN(maxBuffer)||maxBuffer<0)throw new TypeError('maxBuffer 必须为非负数,可用 Infinity 表示不限制缓冲');
12
12
  const streaming=outputMode==='stream';
13
13
  if(streaming&&typeof onOutput!=='function')throw new TypeError('stream 模式必须提供 onOutput 消费输出');
14
14
  if(!Number.isSafeInteger(summaryBytes)||summaryBytes<0||summaryBytes>1024*1024)throw new TypeError('summaryBytes 必须为 0 到 1048576 的整数');
@@ -33,11 +33,12 @@ export async function runProcess(file,args=[],{cwd,env,signal,timeout=30000,maxB
33
33
  if(!executable)throw Object.assign(new Error(`not found: ${file}`),{code:'ENOENT'});
34
34
  }
35
35
  catch(cause){throw new FlowError(`未找到程序:${file}`,{code:'ENOENT',details:{executable:file},cause});}
36
- // Execa 收集原始字节;文本只在这里按同一编码解码,避免返回值被默认 UTF-8 解码。
37
- const child=execa(executable,args,{cwd,env,reject:false,windowsHide:true,maxBuffer,buffer:!streaming,timeout:0,shell:false,encoding:'buffer',stripFinalNewline:false});
36
+ // 平台统一收集原始字节和执行上限;Execa 的超限收集器会提前关闭管道,
37
+ // 导致持续输出的父进程因 EPIPE 退出,taskkill 尚未遍历就失去父 PID。
38
+ const child=execa(executable,args,{cwd,env,extendEnv,reject:false,windowsHide:true,maxBuffer,buffer:false,timeout:0,shell:false,encoding:'buffer',stripFinalNewline:false});
38
39
  let reason,killing,outputError,outputFailed=false,outputWrites=Promise.resolve();
39
40
  let markStopped;const stopped=new Promise(resolve=>{markStopped=resolve;});
40
- const outputBytes={stdout:0,stderr:0},tails={stdout:'',stderr:''};let outputTruncated=false;
41
+ const outputBytes={stdout:0,stderr:0},tails={stdout:'',stderr:''},buffers={stdout:[],stderr:[]};let outputTruncated=false;
41
42
  const remember=(name,message)=>{
42
43
  const bytes=Buffer.from(tails[name]+message);let start=Math.max(0,bytes.length-summaryBytes);
43
44
  if(start){outputTruncated=true;while(start<bytes.length&&(bytes[start]&0xc0)===0x80)start++;}
@@ -67,7 +68,8 @@ export async function runProcess(file,args=[],{cwd,env,signal,timeout=30000,maxB
67
68
  const decoder=new TextDecoder(decoderEncoding);
68
69
  try{
69
70
  for await(const chunk of stream){
70
- if(reason)break;outputBytes[name]+=chunk.byteLength;
71
+ // 停止后继续排空并丢弃输出,避免迭代器 break 提前关闭管道触发 EPIPE。
72
+ if(reason)continue;outputBytes[name]+=chunk.byteLength;
71
73
  const message=decoder.decode(chunk,{stream:true});remember(name,message);
72
74
  await Promise.race([emit(name,message),stopped]);
73
75
  }
@@ -81,9 +83,11 @@ export async function runProcess(file,args=[],{cwd,env,signal,timeout=30000,maxB
81
83
  const finish=()=>{if(!ended){ended=true;emit(name,decoder.decode());}};
82
84
  flush.push(finish);stream?.once('end',finish);
83
85
  stream?.on('data',chunk=>{
86
+ if(reason)return;
84
87
  bytes+=Buffer.byteLength(chunk);
85
88
  // 流量超限时立即回收整棵进程树,不继续扩张待落盘的日志队列。
86
89
  if(bytes>maxBuffer){stop('output-limit');return;}
90
+ buffers[name].push(chunk);
87
91
  if(onOutput)emit(name,decoder.decode(chunk,{stream:true}));
88
92
  });
89
93
  }
@@ -104,7 +108,7 @@ export async function runProcess(file,args=[],{cwd,env,signal,timeout=30000,maxB
104
108
  if(reason)throw new FlowError(reason==='cancelled'?'操作已取消':'程序运行超时',{code:reason==='cancelled'?'CANCELLED':'TIMEOUT'});
105
109
  if(result.isMaxBuffer)throw new FlowError('程序输出超过上限',{code:'OUTPUT_LIMIT'});
106
110
  if(result.exitCode===undefined&&result.failed)throw new FlowError(`无法启动程序 ${file}:${result.shortMessage??result.message}`,{code:result.code??'SPAWN_FAILED'});
107
- const decode=bytes=>stripFinalNewline(new TextDecoder(decoderEncoding).decode(outputText(bytes)));
111
+ const decode=chunks=>stripFinalNewline(new TextDecoder(decoderEncoding).decode(Buffer.concat(chunks)));
108
112
  if(streaming)return {exitCode:result.exitCode,stdout:stripFinalNewline(tails.stdout),stderr:stripFinalNewline(tails.stderr),outputMode,outputTruncated,outputBytes};
109
- return {exitCode:result.exitCode,stdout:decode(result.stdout),stderr:decode(result.stderr)};
113
+ return {exitCode:result.exitCode,stdout:decode(buffers.stdout),stderr:decode(buffers.stderr)};
110
114
  }
@@ -0,0 +1,58 @@
1
+ import {FlowError} from '@mytools/sdk';
2
+ import {randomUUID} from 'node:crypto';
3
+ import {mkdir,open,rm} from 'node:fs/promises';
4
+ import {tmpdir} from 'node:os';
5
+ import path from 'node:path';
6
+ import {runProcess as executeProcess} from './process.js';
7
+
8
+ const shells=new Set(['auto','powershell','pwsh','sh','bash']);
9
+ const powerShellArgs=['-NoLogo','-NoProfile','-NonInteractive','-OutputFormat','Text'];
10
+
11
+ function selectShell(script,shell,platform){
12
+ if(typeof script!=='string'||!script.trim()||script.includes('\u0000'))throw new FlowError('命令文本必须是非空字符串,且不能包含 NUL 字符',{code:'VALIDATION'});
13
+ if(!shells.has(shell))throw new FlowError(`不支持的 Shell:${String(shell)}`,{code:'VALIDATION'});
14
+ return shell==='auto'?(platform==='win32'?'powershell':'sh'):shell;
15
+ }
16
+
17
+ function powerShellSource(script){
18
+ // $? 在脚本最后一条命令后立即读取,避免沿用更早的外部命令退出码。
19
+ return `[Console]::OutputEncoding = New-Object System.Text.UTF8Encoding($false)
20
+ $OutputEncoding = [Console]::OutputEncoding
21
+ & {
22
+ ${script}
23
+ if (-not $?) {
24
+ if ($LASTEXITCODE) { exit $LASTEXITCODE }
25
+ exit 1
26
+ }
27
+ exit 0
28
+ }`;
29
+ }
30
+
31
+ export function shellInvocation(script,{shell='auto',platform=process.platform}={}){
32
+ const file=selectShell(script,shell,platform);
33
+ if(file==='sh'||file==='bash')return {file,args:['-c',script]};
34
+ // 编码只改变传输形式;保留用户的引号、管道、换行及尾部注释。
35
+ const source=powerShellSource(script);
36
+ const encoded=Buffer.from(source,'utf16le').toString('base64');
37
+ // 普通 -Command 避免 Windows PowerShell 在 -EncodedCommand 下把 stderr 序列化为 CLIXML。
38
+ const command=`& ([ScriptBlock]::Create([Text.Encoding]::Unicode.GetString([Convert]::FromBase64String('${encoded}'))))`;
39
+ return {file,args:[...powerShellArgs,'-Command',command]};
40
+ }
41
+
42
+ export async function runShell(script,{shell='auto',runProcess:execute=executeProcess,temporaryDir=tmpdir(),...processOptions}={}){
43
+ const file=selectShell(script,shell,process.platform),powershell=file==='powershell'||file==='pwsh';
44
+ if(processOptions.signal?.aborted)throw new FlowError('操作已取消',{code:'CANCELLED'});
45
+ const directory=path.resolve(temporaryDir);
46
+ await mkdir(directory,{recursive:true});
47
+ const scriptFile=path.join(directory,`fst-shell-${randomUUID()}.${powershell?'ps1':'sh'}`);
48
+ // 独占创建后才承担清理责任;不覆盖已有文件,也不清空调用者的输出目录。
49
+ const handle=await open(scriptFile,'wx',0o600);
50
+ try{
51
+ try{
52
+ // Windows PowerShell 5.1 读取 UTF-8 文件需要 BOM;POSIX Shell 使用无 BOM 原文。
53
+ await handle.writeFile(powershell?'\uFEFF'+powerShellSource(script):script,'utf8');
54
+ }finally{await handle.close();}
55
+ const args=powershell?[...powerShellArgs,'-ExecutionPolicy','Bypass','-File',scriptFile]:[scriptFile];
56
+ return await execute(file,args,processOptions);
57
+ }finally{await rm(scriptFile,{force:true});}
58
+ }
@@ -7,7 +7,7 @@ import path from 'node:path';
7
7
  export const builtinCommands=[
8
8
  ['workflows','选择已有工作流'],['new','新建工作流'],['add','添加插件能力或子工作流'],
9
9
  ['steps','设置步骤参数、排序或删除'],['outputs','设置最终输出'],['save','保存工作流'],
10
- ['run','运行工作流,可附带 @参数.json'],['runs','运行记录:选择任意一次执行,查看进度、结果和日志'],['logs','查看运行日志'],['plugin','管理插件'],['plugins','管理插件(兼容旧入口)'],['config','配置 Fishtools'],['tools','Web 与离线文档'],
10
+ ['run','运行工作流,可附带 @参数.json'],['runs','运行记录:选择任意一次执行,查看进度、结果和日志'],['logs','查看运行日志'],['plugin','管理插件'],['plugins','管理插件(兼容旧入口)'],['commands','管理常用命令'],['shortcuts','管理自定义快捷名称'],['config','配置 Fishtools'],['tools','Web 与离线文档'],
11
11
  ['pack','选择工作流打包'],['web','启动 Web 工作台'],['docs','阅读离线开发与使用文档'],['help','查看操作说明'],['exit','退出终端工作台'],
12
12
  ].map(([name,description])=>({name,description}));
13
13
 
@@ -76,9 +76,13 @@ export function validateDeclarations(plugin){
76
76
  }
77
77
  }
78
78
 
79
+ export function isCommandName(name){
80
+ return typeof name==='string'&&name===name.normalize('NFC')&&/^\p{L}[\p{L}\p{N}_.-]*$/u.test(name);
81
+ }
82
+
79
83
  export function validateCommands(plugin,registered){
80
84
  for(const [name,c] of Object.entries(plugin.commands??{})){
81
- if(!/^[a-zA-Z][\w.-]*$/.test(name)||builtinCommands.some(x=>x.name===name)||registered.has(name))throw new FlowError(`命令名称无效或冲突:/${name}`);
85
+ if(!isCommandName(name)||builtinCommands.some(x=>x.name===name)||registered.has(name))throw new FlowError(`命令名称无效或冲突:/${name}`);
82
86
  if(!c||Boolean(c.action)===Boolean(c.run)||c.run&&typeof c.run!=='function')throw new FlowError(`命令 /${name} 必须声明 action 或 run`);
83
87
  if(c.action&&!plugin.actions?.[c.action])throw new FlowError(`命令 /${name} 指向不存在的动作:${c.action}`);
84
88
  registered.add(name);
@@ -57,7 +57,8 @@ export async function createHost({ plugins = [], config = {}, services = {}, pro
57
57
  const http=createHttpClient(resolved,{signal:context.signal});
58
58
  if(typeof bound.runProcess==='function'){
59
59
  const execute=bound.runProcess;
60
- bound.runProcess=(file,args,options={})=>execute(file,args,{...options,env:buildProcessEnv(resolved,{overrides:options.env})});
60
+ // 已构造完整环境;禁止进程层再次合并宿主代理,恢复被策略移除的变量。
61
+ bound.runProcess=(file,args,options={})=>execute(file,args,{...options,env:buildProcessEnv(resolved,{overrides:options.env}),extendEnv:false});
61
62
  }
62
63
  bound.http={fetch:(input,options)=>http.fetch(input,options)};
63
64
  return {capabilities:{...bound,projectDir,stateDir,environments},close:()=>http.close()};
@@ -100,7 +101,7 @@ export async function createHost({ plugins = [], config = {}, services = {}, pro
100
101
  const runtime=createRuntime(ctx,definitions,{enabled:runtimeEnabled});
101
102
  let unusable=false;
102
103
  const assertReadable=()=>{
103
- if(unusable)throw new FlowError('插件更新和恢复均失败,请重启应用',{code:'PLUGIN_RUNTIME_UNUSABLE'});
104
+ if(unusable)throw new FlowError('插件运行状态无法确认,请重启应用',{code:'PLUGIN_RUNTIME_UNUSABLE'});
104
105
  };
105
106
  const assertHealthy=()=>{runtime.assertOpen();assertReadable();};
106
107
  function registerPlugin(plugin,settings){
@@ -151,7 +152,8 @@ export async function createHost({ plugins = [], config = {}, services = {}, pro
151
152
  const oldDefinitions=new Map([...definitions].filter(([id])=>selected.has(id)));
152
153
  const oldSettings=new Map([...settingsById].filter(([id])=>selected.has(id)));
153
154
  const switchDefinitions=async(targets,settings)=>{
154
- await runtime.remove(selected);
155
+ try{await runtime.remove(selected);}
156
+ catch(error){unusable=true;throw error;}
155
157
  for(const id of selected){definitions.delete(id);settingsById.delete(id);}
156
158
  for(const [id,plugin] of targets)if(selected.has(id)){
157
159
  definitions.set(id,plugin);
@@ -165,8 +167,9 @@ export async function createHost({ plugins = [], config = {}, services = {}, pro
165
167
  for(const [id,plugin] of next)if(selected.has(id))nextSettings.set(id,validate(plugin.config,nextConfig[id]??{},`${id} 配置`));
166
168
  try{await switchDefinitions(next,nextSettings);}
167
169
  catch(error){
170
+ if(unusable)throw error;
168
171
  try{
169
- runtime.clearErrors();
172
+ runtime.clearActivationErrors();
170
173
  await switchDefinitions(oldDefinitions,oldSettings);
171
174
  }catch(recovery){unusable=true;throw new AggregateError([error,recovery],`插件更新失败且恢复失败:${error.message};${recovery.message}`);}
172
175
  throw error;
@@ -36,11 +36,11 @@ export function createRuntime(ctx,definitions,{enabled=true}={}){
36
36
  const reservedContext=new ctx.constructor();
37
37
  let graph=validateRuntimes(definitions,reservedContext);
38
38
  const forks=new Map(),scopes=new Map(),errors=[],pending=new Set();let closing;
39
- const record=(id,error)=>errors.push({plugin:id,message:error?.message??String(error)});
39
+ const record=(id,error,phase='activation')=>errors.push({plugin:id,phase,message:error?.message??String(error)});
40
40
  const track=(id,callback)=>{
41
41
  // 同步撤销注册,只有异步尾部进入等待集合,避免服务重激活时旧清理删掉新注册。
42
- let result;try{result=callback();}catch(error){record(id,error);return;}
43
- const task=Promise.resolve(result).catch(e=>record(id,e)).finally(()=>pending.delete(task));
42
+ let result;try{result=callback();}catch(error){record(id,error,'dispose');return;}
43
+ const task=Promise.resolve(result).catch(e=>record(id,e,'dispose')).finally(()=>pending.delete(task));
44
44
  pending.add(task);return task;
45
45
  };
46
46
  // 3.18.1 的 reset 会调用 dispose,但不等待 Promise;此适配只补齐等待和错误传播。
@@ -72,7 +72,7 @@ export function createRuntime(ctx,definitions,{enabled=true}={}){
72
72
  // 初始化可能仍在取得资源;先等其结束,再执行本次激活登记的清理。
73
73
  while(activation.tasks.size)await Promise.allSettled([...activation.tasks]);
74
74
  for(const dispose of activation.disposers.splice(0)){
75
- try{await dispose();}catch(error){record(plugin.id,error);}
75
+ try{await dispose();}catch(error){record(plugin.id,error,'dispose');}
76
76
  }
77
77
  })();
78
78
  });
@@ -100,7 +100,10 @@ export function createRuntime(ctx,definitions,{enabled=true}={}){
100
100
  await ctx.start();await runtime.ready();
101
101
  },
102
102
  reindex(){graph=validateRuntimes(definitions,reservedContext);},
103
- clearErrors(){errors.length=0;},
103
+ clearActivationErrors(){
104
+ // 启动失败可以在清理成功后恢复;清理失败必须保留,不能假定资源已释放。
105
+ for(let index=errors.length-1;index>=0;index--)if(errors[index].phase!=='dispose')errors.splice(index,1);
106
+ },
104
107
  async remove(ids){
105
108
  // 先撤销消费者再撤销提供者;旧作用域清理结束后才能注册新作用域。
106
109
  const selected=new Set(ids);
@@ -17,12 +17,15 @@
17
17
  | `@mytools/fst-workspace/plugins` | `./src/plugins.js` |
18
18
  | `@mytools/fst-workspace/installations` | `./src/plugin-installations.js` |
19
19
  | `@mytools/fst-workspace/bundles` | `./src/bundle-workspace.js` |
20
+ | `@mytools/fst-workspace/shortcuts` | `./src/shortcuts.js` |
20
21
  | `@mytools/fst-workspace/package.json` | `./package.json` |
21
22
 
22
23
  仅依赖 exports 声明的入口,禁止消费者跨包读取 src/bin 私有文件。入口路径由本模块维护,修改协议时同步消费方回归。
23
24
 
24
25
  ## 维护与验证
25
26
 
27
+ `/shortcuts` 提供 `validateShortcuts` 校验、`bindShortcutCommands` 在用户配置时补齐命令提供者身份,以及 `describeShortcuts` 生成可用或失效状态。绑定函数可传入 previous 保留旧项:未绑定命令修改参数或重命名仍保持失效,需重新选择目标。命令项使用 command 与 plugin 同时匹配,动作项使用稳定 action ID;不执行其他插件的同名能力。实际保存、备份与宿主装配由 core 协调。
28
+
26
29
  本模块负责上述职责的实现、文档与回归;跨模块接口调整需要同时检查生产者与消费者。具体维护人员尚未指定。
27
30
 
28
31
  在仓库根目录执行:
@@ -8,6 +8,7 @@
8
8
  ".": "./src/index.js",
9
9
  "./workflows": "./src/workflows.js",
10
10
  "./project": "./src/project.js",
11
+ "./shortcuts": "./src/shortcuts.js",
11
12
  "./plugins": "./src/plugins.js",
12
13
  "./installations": "./src/plugin-installations.js",
13
14
  "./bundles": "./src/bundle-workspace.js",
@@ -0,0 +1,119 @@
1
+ import {FlowError} from '@mytools/sdk';
2
+ import {builtinCommands,isCommandName} from '@mytools/fst-plugin/contracts';
3
+ import {isBuiltin} from 'node:module';
4
+
5
+ const dangerousFields=new Set(['__proto__','constructor','prototype']);
6
+ const shortcutFields=new Set(['action','command','plugin','input']);
7
+
8
+ function validPluginId(value){
9
+ if(typeof value!=='string'||!value.length||value.length>214||value!==value.toLowerCase()||isBuiltin(value)||['node_modules','favicon.ico'].includes(value))return false;
10
+ const parts=/^(?:@([^/]+)\/)?([^/]+)$/.exec(value);
11
+ if(!parts||/^[._-]/.test(value)||parts[2].startsWith('.'))return false;
12
+ return (!parts[1]||/^[a-z0-9_.~'!()*-]+$/.test(parts[1]))&&/^[a-z0-9_.-]+$/.test(parts[2]);
13
+ }
14
+
15
+ function invalid(location,message){
16
+ throw new FlowError(message,{code:'VALIDATION',details:{path:location}});
17
+ }
18
+
19
+ function plainObject(value){
20
+ return value!==null&&typeof value==='object'&&!Array.isArray(value)&&[Object.prototype,null].includes(Object.getPrototypeOf(value));
21
+ }
22
+
23
+ function entries(value,location){
24
+ if(!plainObject(value))invalid(location,`${location} 必须为普通 JSON 对象`);
25
+ return Reflect.ownKeys(value).map(key=>{
26
+ if(typeof key!=='string'||dangerousFields.has(key))invalid(location,`${location} 包含危险或非 JSON 字段`);
27
+ const field=Object.getOwnPropertyDescriptor(value,key);
28
+ if(!field.enumerable||!Object.hasOwn(field,'value'))invalid(`${location}.${key}`,`${location}.${key} 必须为普通 JSON 字段`);
29
+ return [key,field.value];
30
+ });
31
+ }
32
+
33
+ function cloneJson(value,location,ancestors=new Set()){
34
+ if(value===null||typeof value==='string'||typeof value==='boolean')return value;
35
+ if(typeof value==='number'&&Number.isFinite(value))return value;
36
+ if(typeof value!=='object')invalid(location,`${location} 必须为可序列化的 JSON 值`);
37
+ if(ancestors.has(value))invalid(location,`${location} 不能包含循环引用`);
38
+ ancestors.add(value);
39
+ try{
40
+ if(Array.isArray(value)){
41
+ if(Object.getPrototypeOf(value)!==Array.prototype||Reflect.ownKeys(value).length!==value.length+1)invalid(location,`${location} 必须为普通且完整的 JSON 数组`);
42
+ const copy=[];
43
+ for(let index=0;index<value.length;index++){
44
+ const field=Object.getOwnPropertyDescriptor(value,String(index));
45
+ if(!field?.enumerable||!Object.hasOwn(field,'value'))invalid(`${location}[${index}]`,`${location} 必须为普通且完整的 JSON 数组`);
46
+ copy.push(cloneJson(field.value,`${location}[${index}]`,ancestors));
47
+ }
48
+ return copy;
49
+ }
50
+ return Object.fromEntries(entries(value,location).map(([key,nested])=>[key,cloneJson(nested,`${location}.${key}`,ancestors)]));
51
+ }finally{ancestors.delete(value);}
52
+ }
53
+
54
+ export function validateShortcuts(shortcuts,{reservedNames=[]}={}){
55
+ if(!Array.isArray(reservedNames)||reservedNames.some(name=>typeof name!=='string'))invalid('reservedNames','保留名称必须为字符串数组');
56
+ const reserved=new Set([...builtinCommands.map(command=>command.name),...reservedNames].map(name=>name.normalize('NFC')));
57
+ const copy={};
58
+ for(const [name,shortcut] of entries(shortcuts,'shortcuts')){
59
+ const location=`shortcuts.${name}`;
60
+ // 明确拒绝未规范化名称,避免两个视觉相同的入口指向不同能力。
61
+ if(name!==name.normalize('NFC'))invalid(location,`快捷名称必须使用 NFC 规范形式:${name}`);
62
+ if(!isCommandName(name))invalid(location,`快捷名称无效:/${name}`);
63
+ if(reserved.has(name))invalid(location,`快捷名称与现有命令冲突:/${name}`);
64
+ reserved.add(name);
65
+ const fields=entries(shortcut,location);
66
+ if(fields.some(([key])=>!shortcutFields.has(key)))invalid(location,`快捷项 ${name} 包含未声明字段`);
67
+ const hasAction=Object.hasOwn(shortcut,'action'),hasCommand=Object.hasOwn(shortcut,'command');
68
+ if(hasAction===hasCommand)invalid(location,`快捷项 ${name} 必须声明 action 或 command 之一`);
69
+ const field=hasAction?'action':'command',target=shortcut[field];
70
+ if(hasAction){
71
+ const separator=typeof target==='string'?target.lastIndexOf(':'):-1;
72
+ if(separator<=0||separator===target.length-1||/[\s\p{C}]/u.test(target))invalid(`${location}.action`,`快捷项 ${name} 的 action 必须为稳定动作 ID`);
73
+ }else if(!isCommandName(target))invalid(`${location}.command`,`快捷项 ${name} 的 command 名称无效`);
74
+ copy[name]={[field]:target};
75
+ if(Object.hasOwn(shortcut,'plugin')){
76
+ if(hasAction)invalid(`${location}.plugin`,`动作快捷项 ${name} 不能声明 plugin`);
77
+ if(!validPluginId(shortcut.plugin))invalid(`${location}.plugin`,`快捷项 ${name} 的 plugin 必须为合法插件包 ID`);
78
+ copy[name].plugin=shortcut.plugin;
79
+ }
80
+ if(Object.hasOwn(shortcut,'input')){
81
+ if(!plainObject(shortcut.input))invalid(`${location}.input`,`快捷项 ${name} 的 input 必须为普通 JSON 对象`);
82
+ copy[name].input=cloneJson(shortcut.input,`${location}.input`);
83
+ }
84
+ }
85
+ return copy;
86
+ }
87
+
88
+ export function bindShortcutCommands(shortcuts,{commands=[],previous={}}={}){
89
+ const copy=validateShortcuts(shortcuts);
90
+ const old=validateShortcuts(previous),unbound=new Set(Object.values(old).filter(shortcut=>shortcut.command&&shortcut.plugin===undefined).map(shortcut=>shortcut.command));
91
+ for(const [name,shortcut] of Object.entries(copy)){
92
+ // 已有未绑定项即使改参数或重命名也需明确选择目标,不能被整组保存顺带启用。
93
+ if(!Object.hasOwn(shortcut,'command')||Object.hasOwn(shortcut,'plugin'))continue;
94
+ if(old[name]?.command===shortcut.command||unbound.has(shortcut.command))continue;
95
+ const command=commands.find(command=>command.name===shortcut.command);
96
+ if(command?.plugin!==undefined)shortcut.plugin=command.plugin;
97
+ }
98
+ return validateShortcuts(copy);
99
+ }
100
+
101
+ export function describeShortcuts(shortcuts,{actions=[],commands=[]}={}){
102
+ const actionIndex=new Map(actions.map(action=>[action.id,action]));
103
+ return Object.entries(validateShortcuts(shortcuts)).map(([name,shortcut])=>{
104
+ const field=Object.hasOwn(shortcut,'action')?'action':'command';
105
+ const id=shortcut[field];
106
+ let definition;
107
+ if(field==='action')definition=actionIndex.get(id);
108
+ else if(shortcut.plugin!==undefined)definition=commands.find(command=>command.name===id&&command.plugin===shortcut.plugin);
109
+ const descriptions=field==='action'?[definition?.title,definition?.description]:[definition?.description];
110
+ const target={[field]:id};
111
+ if(shortcut.plugin!==undefined)target.plugin=shortcut.plugin;
112
+ const entry={name,target,input:shortcut.input??{},available:Boolean(definition),description:descriptions.find(value=>typeof value==='string'&&value.trim())??id};
113
+ if(!definition){
114
+ if(field==='command'&&shortcut.plugin===undefined)entry.reason='尚未绑定目标插件,请重新选择目标';
115
+ else entry.reason=`${field==='action'?'动作':'命令'}不可用或尚未安装:${shortcut.plugin?`${shortcut.plugin} → `:''}${id}`;
116
+ }
117
+ return entry;
118
+ });
119
+ }
@@ -78,7 +78,7 @@ export async function packApplication(app,{entries,target,outDir='dist',includeW
78
78
  for(const w of closure.workflows)await writeFile(path.join(workflowDir,`${w.id}.yaml`),YAML.stringify(w));
79
79
  const config={};
80
80
  for(const p of plugins)if(p.defaultConfig)config[p.id]=p.defaultConfig;
81
- await writeFile(path.join(directory,'flow.project.json'),JSON.stringify({readOnly,plugins:plugins.map(p=>`./app/node_modules/${p.id}`),config,entries,environments:overrides,network:snapshot.project.network,logs:snapshot.project.logs},null,2));
81
+ await writeFile(path.join(directory,'flow.project.json'),JSON.stringify({readOnly,plugins:plugins.map(p=>`./app/node_modules/${p.id}`),config,entries,environments:overrides,network:snapshot.project.network,logs:snapshot.project.logs,commandPresets:snapshot.project.commandPresets,shortcuts:snapshot.project.shortcuts},null,2));
82
82
  const bundleId=randomUUID();
83
83
  await writeFile(path.join(directory,'bundle.json'),JSON.stringify({format:2,id:bundleId,editable:!readOnly}));
84
84
  await writeFile(path.join(directory,'package.json'),JSON.stringify({private:true,type:'module'},null,2));