如何使用Composer list –raw命令方便脚本解析输出结果?

12次阅读

composer list –raw 输出为纯文本TSV格式,每行一个命令,字段顺序为command和description,用单个制表符分隔,无表头、颜色、空行或缩进,专为脚本解析设计。

如何使用Composer list –raw命令方便脚本解析输出结果?

什么是 composer list --raw 的输出格式

composer list --raw 会以纯文本、制表符分隔(TSV)格式输出所有可用命令,每行一个命令,字段顺序为:command(全名)、description(描述),中间用单个 t 分隔。没有表头、没有颜色、没有缩进或空行——这正是脚本解析需要的干净结构。

例如:

about  Shows the short information about Composer. archive Creates an archive of this composer package.

为什么不能直接用 composer list 做解析

默认的 composer list 输出是美化过的表格格式,含对齐空格、ANSI 颜色码、列宽自动调整,甚至可能因终端宽度不同而换行。这些都会让 awkcutpythonsplit() 失效。

常见错误现象包括:

  • cut -f1 提取命令名时,遇到带空格的描述(如 cache clear)导致字段错位
  • 脚本在 CI 环境中因无 TTY 导致颜色控制符残留,干扰匹配
  • 描述里含制表符时,--raw 仍能保证仅用「第一个制表符」分割,而默认输出无法保证分隔一致性

如何在 Shell 脚本中安全提取命令列表

推荐用 while IFS=$'t' read -r cmd desc 循环处理,避免字段内空格或换行破坏结构。

示例:只列出所有顶层命令(不含冒号):

composer list --raw | while IFS=$'t' read -r cmd desc; do     if [[ "$cmd" != *:* ]]; then         echo "$cmd"     fi done

注意点:

  • 不要用 for line in $(composer list --raw) —— 会因 word splitting 破坏制表符分隔
  • 如果需在循环外使用变量,改用进程替换:while IFS=$'t' read -r cmd desc; do ...; done
  • desc 可能为空(如某些插件命令),应允许空值

Python 中解析 --raw 输出的注意事项

Python 用 subprocess.run(..., capture_output=True, text=True) 获取输出后,按行切分再用 line.split('t', 1) 最安全——第二个参数 1 表示最多切一次,确保描述里的制表符不被误拆。

示例片段:

import subprocess out = subprocess.run(['composer', 'list', '--raw'], capture_output=True, text=True) for line in out.stdout.strip().split('n'):     parts = line.split('t', 1)     if len(parts) == 2:         cmd, desc = parts[0].strip(), parts[1].strip()         # 处理 cmd 和 desc

容易忽略的一点:composer list --raw 在无网络或缓存异常时可能报错并输出到 stderr,但退出码仍是 0;务必检查 out.stderr 是否非空,否则可能把错误信息当命令解析。

text=ZqhQzanResources