@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
@@ -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));
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 mytools contributors
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,41 @@
1
+ # 轻量命令插件
2
+
3
+ 官方包 `@mytools/commands` 将项目注册的系统命令生成标准工作流动作,动作标识为 `@mytools/commands:注册ID`。修改中文标题或脚本不会改变注册 ID。默认导出的插件没有动作,由 Fishtools 根据项目的 `commandPresets` 装配。
4
+
5
+ ## 注册格式
6
+
7
+ ```json
8
+ {
9
+ "greet": {
10
+ "title": "中文问候",
11
+ "script": "printf '%s\\n' \"$FST_INPUT_name\"",
12
+ "shell": "sh",
13
+ "timeout": 30000,
14
+ "parameters": {
15
+ "name": {"type": "string", "title": "姓名", "default": "朋友", "required": true}
16
+ }
17
+ }
18
+ }
19
+ ```
20
+
21
+ `title` 与 `script` 必须填写;`shell` 省略或设为 `auto` 时,Windows 使用 PowerShell,Linux 使用 sh。也可显式选择 `powershell`、`pwsh`、`sh`、`bash`;目标机器须自行提供相应解释器和外部程序。脚本保留原始多行、引号、管道与重定向,并通过唯一临时文件交给解释器,避免长脚本超过系统命令行长度限制。PowerShell 文件使用 UTF-8 BOM 并固定 UTF-8 输出,最后命令失败时返回非零退出码。
22
+
23
+ `timeout` 为可选的整数毫秒,范围为 0 到 2147483647,默认沿用受管进程的 30000 毫秒;`0` 表示不限时。第一版用于非交互命令。
24
+
25
+ 注册 ID 最多 80 字符,只能使用 ASCII 字母、数字、下划线、短横线,且以字母或数字开头。`parameters` 为字段对象;字段类型只接受 `string`、`number`、`boolean`,可选中文 `title`、同类型 `default` 和布尔 `required`。参数名以 ASCII 字母或下划线开头,后续可含字母、数字、下划线,最多 80 字符;不能仅以大小写区分,也不能使用原型保留名称。未知字段和不符合类型的默认值会被拒绝。
26
+
27
+ ## 参数与权限
28
+
29
+ 参数通过 `FST_INPUT_字段名` 环境变量传入;字符串原样保留,数值和布尔值转换为文本。Linux 脚本使用 `"$FST_INPUT_name"`,PowerShell 使用 `$env:FST_INPUT_name`,例如 `Write-Output $env:FST_INPUT_name`。请按所选 Shell 的规则引用环境变量。字段值不会拼接到脚本源码。
30
+
31
+ 无参数动作输入为 `{}`。默认以普通用户权限执行。`requireRoot: true` 声明该动作在 Linux 需要 root,宿主执行前预检并显示原因与处理建议;Windows 使用普通用户声明。
32
+
33
+ ## 输出与接口
34
+
35
+ 动作复用宿主的代理规则、取消信号、受管进程与完整日志。返回固定字段 `exitCode`、`stdout`、`stderr`、`outputBytes`、`outputTruncated`。`stdout` 和 `stderr` 各保留最多 65536 字节的尾部,`outputBytes` 分别记录两条流的完整字节数,`outputTruncated` 表示尾部摘要是否截断。完整输出可在运行日志中查看。
36
+
37
+ 临时脚本优先写入本次运行的 `outputDir`;未提供时使用系统临时目录。完成、失败、超时和取消后删除本次文件,保留同目录中的其他文件。PowerShell 文件执行使用本次进程的 `ExecutionPolicy Bypass`,沿用原先命令文本可执行的行为。
38
+
39
+ 非零退出抛出 `EXECUTION_FAILED`,错误包含退出码和输出摘要;超时、取消及解释器缺失沿用宿主错误语义。
40
+
41
+ 包公开导出 `COMMANDS_PLUGIN_ID`、自身目录 `commandsPluginRoot`、`validateCommandPresets(presets)` 和 `createCommandsPlugin(presets = {})`。校验函数返回独立副本;工厂生成标准插件定义,输入校验与默认值由宿主统一处理。
@@ -0,0 +1,94 @@
1
+ import path from 'node:path';
2
+ import {fileURLToPath} from 'node:url';
3
+ import {createHash} from 'node:crypto';
4
+ import {definePlugin,FlowError} from '@mytools/sdk';
5
+ import {runShell} from '@mytools/fst-platform/shell';
6
+
7
+ export const COMMANDS_PLUGIN_ID='@mytools/commands';
8
+ export const commandsPluginRoot=path.dirname(fileURLToPath(import.meta.url));
9
+
10
+ const reserved=new Set(['__proto__','constructor','prototype']);
11
+ const validObject=value=>value!==null&&typeof value==='object'&&!Array.isArray(value)&&[Object.prototype,null].includes(Object.getPrototypeOf(value));
12
+ const validText=value=>typeof value==='string'&&Boolean(value.trim())&&!value.includes('\u0000');
13
+ const invalid=(location,message)=>{throw new FlowError(`${location}:${message}`,{code:'VALIDATION',details:{path:location}});};
14
+ function fields(value,allowed,location){
15
+ if(!validObject(value))invalid(location,'必须为字段对象');
16
+ for(const key of Reflect.ownKeys(value))if(typeof key!=='string'||!allowed.includes(key))invalid(`${location}.${String(key)}`,'包含未知字段');
17
+ }
18
+
19
+ export function validateCommandPresets(presets){
20
+ if(!validObject(presets))invalid('commandPresets','必须为命令注册对象');
21
+ for(const id of Reflect.ownKeys(presets)){
22
+ const location=`commandPresets.${String(id)}`;
23
+ if(typeof id!=='string'||!/^[a-zA-Z0-9][a-zA-Z0-9_-]{0,79}$/.test(id)||reserved.has(id))invalid(location,'ID 只能使用 ASCII 字母、数字、下划线和短横线,最多 80 字符,且不能为原型保留名称');
24
+ const preset=presets[id];
25
+ fields(preset,['title','script','shell','timeout','parameters','requireRoot'],location);
26
+ if(!validText(preset.title))invalid(`${location}.title`,'标题必须为非空字符串');
27
+ if(!validText(preset.script))invalid(`${location}.script`,'命令文本必须为非空字符串,且不能包含 NUL 字符');
28
+ if(preset.shell!==undefined&&!['auto','powershell','pwsh','sh','bash'].includes(preset.shell))invalid(`${location}.shell`,'Shell 必须为 auto、powershell、pwsh、sh 或 bash');
29
+ if(preset.timeout!==undefined&&(!Number.isSafeInteger(preset.timeout)||preset.timeout<0||preset.timeout>2147483647))invalid(`${location}.timeout`,'超时必须为 0 到 2147483647 的整数毫秒,0 表示不限时');
30
+ if(preset.requireRoot!==undefined&&typeof preset.requireRoot!=='boolean')invalid(`${location}.requireRoot`,'root 需求必须为布尔值');
31
+ if(preset.parameters===undefined)continue;
32
+ if(!validObject(preset.parameters))invalid(`${location}.parameters`,'参数必须为字段对象');
33
+ const names=new Set();
34
+ for(const name of Reflect.ownKeys(preset.parameters)){
35
+ const at=`${location}.parameters.${String(name)}`;
36
+ if(typeof name!=='string'||!/^[a-zA-Z_][a-zA-Z0-9_]{0,79}$/.test(name)||reserved.has(name)||Object.hasOwn(Object.prototype,name))invalid(at,'参数名只能使用 ASCII 字母、数字和下划线,不能以数字开头或使用原型保留名称');
37
+ const portable=name.toLowerCase();
38
+ if(names.has(portable))invalid(at,'参数名不能仅以大小写区分,以免 Windows 环境变量冲突');
39
+ names.add(portable);
40
+ const field=preset.parameters[name];
41
+ fields(field,['type','title','default','required'],at);
42
+ if(!['string','number','boolean'].includes(field.type))invalid(`${at}.type`,'参数类型必须为 string、number 或 boolean');
43
+ if(field.title!==undefined&&!validText(field.title))invalid(`${at}.title`,'参数标题必须为非空字符串');
44
+ if(field.required!==undefined&&typeof field.required!=='boolean')invalid(`${at}.required`,'必填声明必须为布尔值');
45
+ if(Object.hasOwn(field,'default')&&(typeof field.default!==field.type||field.type==='number'&&!Number.isFinite(field.default)||field.type==='string'&&field.default.includes('\u0000')))invalid(`${at}.default`,'默认值必须符合参数类型且可作为环境变量传递');
46
+ }
47
+ }
48
+ try{return structuredClone(presets);}
49
+ catch(cause){throw new FlowError('命令注册项必须可复制和保存',{code:'VALIDATION',cause});}
50
+ }
51
+
52
+ function inputSchema(parameters){
53
+ const properties=Object.fromEntries(Object.entries(parameters).map(([name,{type,title,default:value}])=>[name,{
54
+ type,title:title??name,...(type==='string'?{pattern:'^[^\\u0000]*$'}:{}),
55
+ ...(Object.hasOwn(parameters[name],'default')?{default:value}:{}),
56
+ }]));
57
+ return {type:'object',properties,required:Object.entries(parameters).filter(([,field])=>field.required).map(([name])=>name),additionalProperties:false};
58
+ }
59
+
60
+ const outputSchema={type:'object',properties:{
61
+ exitCode:{type:'integer',title:'退出码'},stdout:{type:'string',title:'标准输出摘要'},stderr:{type:'string',title:'标准错误摘要'},
62
+ outputBytes:{type:'object',title:'完整输出字节数',properties:{stdout:{type:'integer',minimum:0},stderr:{type:'integer',minimum:0}},required:['stdout','stderr'],additionalProperties:false},
63
+ outputTruncated:{type:'boolean',title:'摘要已截断'},
64
+ },required:['exitCode','stdout','stderr','outputBytes','outputTruncated'],additionalProperties:false};
65
+
66
+ export function createCommandsPlugin(presets={}){
67
+ const checked=validateCommandPresets(presets);
68
+ const actions=Object.fromEntries(Object.entries(checked).map(([id,preset])=>{
69
+ const parameters=preset.parameters??{};
70
+ return [id,{
71
+ title:preset.title,description:'执行已注册的非交互 Shell 命令,完整输出保存到运行日志。',
72
+ input:inputSchema(parameters),output:structuredClone(outputSchema),
73
+ ...(preset.requireRoot?{requirements:{privilege:{linux:{level:'root',reason:`命令“${preset.title}”声明需要 Linux root 权限`,remediation:'请使用具备 root 权限的会话运行 Fishtools,或修改命令以使用普通用户权限。'}}}}:{}),
74
+ async run(input,ctx){
75
+ // 仅传递字段值;参数中的引号、换行和命令替换都不会进入脚本源码。
76
+ const env=Object.fromEntries(Object.keys(parameters).map(name=>[`FST_INPUT_${name}`,Object.hasOwn(input,name)?String(input[name]):'']));
77
+ const {exitCode,stdout,stderr,outputBytes,outputTruncated}=await runShell(preset.script,{
78
+ shell:preset.shell??'auto',runProcess:ctx.runProcess,temporaryDir:ctx.outputDir,
79
+ signal:ctx.signal,cwd:ctx.projectDir,env,outputMode:'stream',summaryBytes:65536,
80
+ ...(preset.timeout!==undefined?{timeout:preset.timeout}:{}),
81
+ });
82
+ const output={exitCode,stdout,stderr,outputBytes,outputTruncated};
83
+ if(exitCode!==0)throw new FlowError(`命令“${preset.title}”执行失败(退出码 ${exitCode}):${(stderr||stdout||'没有输出').slice(-2000)}`,{code:'EXECUTION_FAILED',details:output});
84
+ return output;
85
+ },
86
+ }];
87
+ }));
88
+ // run 的函数文本不包含闭包中的脚本;摘要使定向更新能识别脚本、Shell 和超时变化。
89
+ const commandPresetDigest=createHash('sha256').update(JSON.stringify(checked)).digest('hex');
90
+ return definePlugin({id:COMMANDS_PLUGIN_ID,version:'0.1.0',commandPresetDigest,title:'轻量命令',description:'将项目中注册的系统命令作为稳定的工作流动作执行。',platforms:['win32','linux'],
91
+ requirements:{privilege:{linux:{level:'user'},win32:{level:'user'}}},actions});
92
+ }
93
+
94
+ export default createCommandsPlugin();
@@ -0,0 +1,17 @@
1
+ {
2
+ "name": "@mytools/commands",
3
+ "version": "0.1.0",
4
+ "type": "module",
5
+ "main": "index.js",
6
+ "exports": {
7
+ ".": "./index.js",
8
+ "./package.json": "./package.json"
9
+ },
10
+ "files": ["index.js", "README.md", "LICENSE"],
11
+ "license": "MIT",
12
+ "engines": {"node": ">=24.15.0"},
13
+ "dependencies": {
14
+ "@mytools/sdk": "0.1.0",
15
+ "@mytools/fst-platform": "0.1.0"
16
+ }
17
+ }
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 mytools contributors
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,41 @@
1
+ # 轻量命令插件
2
+
3
+ 官方包 `@mytools/commands` 将项目注册的系统命令生成标准工作流动作,动作标识为 `@mytools/commands:注册ID`。修改中文标题或脚本不会改变注册 ID。默认导出的插件没有动作,由 Fishtools 根据项目的 `commandPresets` 装配。
4
+
5
+ ## 注册格式
6
+
7
+ ```json
8
+ {
9
+ "greet": {
10
+ "title": "中文问候",
11
+ "script": "printf '%s\\n' \"$FST_INPUT_name\"",
12
+ "shell": "sh",
13
+ "timeout": 30000,
14
+ "parameters": {
15
+ "name": {"type": "string", "title": "姓名", "default": "朋友", "required": true}
16
+ }
17
+ }
18
+ }
19
+ ```
20
+
21
+ `title` 与 `script` 必须填写;`shell` 省略或设为 `auto` 时,Windows 使用 PowerShell,Linux 使用 sh。也可显式选择 `powershell`、`pwsh`、`sh`、`bash`;目标机器须自行提供相应解释器和外部程序。脚本保留原始多行、引号、管道与重定向,并通过唯一临时文件交给解释器,避免长脚本超过系统命令行长度限制。PowerShell 文件使用 UTF-8 BOM 并固定 UTF-8 输出,最后命令失败时返回非零退出码。
22
+
23
+ `timeout` 为可选的整数毫秒,范围为 0 到 2147483647,默认沿用受管进程的 30000 毫秒;`0` 表示不限时。第一版用于非交互命令。
24
+
25
+ 注册 ID 最多 80 字符,只能使用 ASCII 字母、数字、下划线、短横线,且以字母或数字开头。`parameters` 为字段对象;字段类型只接受 `string`、`number`、`boolean`,可选中文 `title`、同类型 `default` 和布尔 `required`。参数名以 ASCII 字母或下划线开头,后续可含字母、数字、下划线,最多 80 字符;不能仅以大小写区分,也不能使用原型保留名称。未知字段和不符合类型的默认值会被拒绝。
26
+
27
+ ## 参数与权限
28
+
29
+ 参数通过 `FST_INPUT_字段名` 环境变量传入;字符串原样保留,数值和布尔值转换为文本。Linux 脚本使用 `"$FST_INPUT_name"`,PowerShell 使用 `$env:FST_INPUT_name`,例如 `Write-Output $env:FST_INPUT_name`。请按所选 Shell 的规则引用环境变量。字段值不会拼接到脚本源码。
30
+
31
+ 无参数动作输入为 `{}`。默认以普通用户权限执行。`requireRoot: true` 声明该动作在 Linux 需要 root,宿主执行前预检并显示原因与处理建议;Windows 使用普通用户声明。
32
+
33
+ ## 输出与接口
34
+
35
+ 动作复用宿主的代理规则、取消信号、受管进程与完整日志。返回固定字段 `exitCode`、`stdout`、`stderr`、`outputBytes`、`outputTruncated`。`stdout` 和 `stderr` 各保留最多 65536 字节的尾部,`outputBytes` 分别记录两条流的完整字节数,`outputTruncated` 表示尾部摘要是否截断。完整输出可在运行日志中查看。
36
+
37
+ 临时脚本优先写入本次运行的 `outputDir`;未提供时使用系统临时目录。完成、失败、超时和取消后删除本次文件,保留同目录中的其他文件。PowerShell 文件执行使用本次进程的 `ExecutionPolicy Bypass`,沿用原先命令文本可执行的行为。
38
+
39
+ 非零退出抛出 `EXECUTION_FAILED`,错误包含退出码和输出摘要;超时、取消及解释器缺失沿用宿主错误语义。
40
+
41
+ 包公开导出 `COMMANDS_PLUGIN_ID`、自身目录 `commandsPluginRoot`、`validateCommandPresets(presets)` 和 `createCommandsPlugin(presets = {})`。校验函数返回独立副本;工厂生成标准插件定义,输入校验与默认值由宿主统一处理。