Elvish 0.14.0 版本更新详解:弃用机制、语言新特性与编辑器增强
Elvish 0.14.0 版本更新详解:弃用机制、语言新特性与编辑器增强
导读
本文围绕 Elvish 0.14.0(2020-07-05 发布,距 0.13 时隔 6 个月)的发布说明展开,系统梳理该版本引入的破坏性变更、全新弃用机制、语言与标准库新增能力,以及交互式编辑器的多项改进。读者读完本文后,将掌握 0.14.0 中 all/one/order/read-upto/read-line 等命令的正确用法、通配符 type:dir/type:regular 限定技巧、异常字段内省与 $edit:small-word-abbr 等编辑器配置方案,并能结合仓库源码理解其底层实现原理。
版本概览
Elvish 0.14.0 于 2020-07-05 发布,是 0.13 之后 6 个月的累积版本,带来了大量新特性与缺陷修复。与以往发布一样,官方为大多数常见平台提供了预编译二进制包。该版本最大的结构性变化,是引入了官方的弃用(deprecation)机制,为后续破坏性变更提供提前告警;同时,语言层面新增了异常内省、相对 use、CRLF 换行支持、注释放宽等能力,标准库中新增 order、platform:、unix:、math: 等命令与模块。
破坏性变更(Breaking changes)
0.14.0 移除或调整了以下行为,升级脚本前需要留意:
src返回值不再包含type字段:src命令输出的 map 中移除了type字段,读取该字段的旧脚本会失效。all命令不再原样保留字节输入:旧版all对字节流是透传的;0.14.0 起,它会把字节输入按行转换为值(每行一个值),并接受一个可选列表参数,与其他取值命令保持一致。从源码看,all通过inputs回调逐值转发到 ValueOutput(见 pkg/eval/builtin_fn_stream.go),因此它本质上是对输入流做"全量收集"的统一入口。- 输出捕获会去除每行行尾的回车符:
\r\n现在被当作行分隔符接受(对应 issue #970)。这意味着管道输出即使来自 CRLF 风格的 Windows 程序,也能被正确按行解析。 dir-history与re:find返回的 map 值不可再被assoc:这两类 map 从此成为不可变值,尝试用assoc修改会产生异常。
弃用机制与受影响特性
全新的弃用告警机制
Elvish 在 0.14.0 中引入了系统性的弃用机制:被标记弃用的特性会触发警告,并计划在下一个版本移除。从源码结构看,该机制由编译期的弃用注册表支撑:deprecationRegistry 以 (srcName, location, message) 为键去重登记(见 pkg/eval/deprecation.go),编译器在解析到弃用内建函数时通过 cp.deprecate 生成带上下文(源码名、代码与位置)的 diag.Error 并写入 warn 流(见 pkg/eval/compiler.go)。因此同一调用点不会重复刷屏,且弃用信息携带精确的源码位置,便于定位。
解析/编译期即触发警告的弃用项
以下特性在代码被解析或编译时就会触发警告,即使代码并未真正执行:
explode命令:弃用,改用all。joins、replaces、splits命令:弃用,分别改用str:join、str:replace、str:split。^命令(幂运算):弃用,改用math:pow。注意^字符本身在语言层面另有新用途(行续行符,见下文),两者含义不同。-time命令:已升格为正式的time,-time仅作为time的弃用别名保留。- 用
\进行行续行:弃用,改用^。
求值期触发警告的弃用项
edit:complex-candidate的&display-suffix选项:弃用,改用&display选项指定完整显示文本。
无警告的弃用项(迁移需自查)
src返回值的path字段:弃用,改用name字段。该弃用项目前不会触发任何警告,升级脚本时应主动全局搜索src的path字段用法并替换。
语言层新增特性
异常可内省(#208)
异常现在可以通过访问其字段进行内省,例如检查异常的类型、原因等信息,为 try 块中的错误分类与处理提供了数据基础。配合标准库新增的 show 命令,可以将异常的堆栈轨迹打印到终端,便于调试。
通配符限定:type:dir 与 type:regular
新增两个通配符修饰符,可分别将通配模式限定为只匹配目录或只匹配普通文件。例如:
# 只匹配所有目录
put **[type:dir]
# 只匹配以 m 开头的普通文件
put **[type:regular]m
# 限定符可出现在模式尾部
put **f*[type:regular]
仓库测试用例对组合与非法组合均有覆盖:两个限定符同时出现在一个 * 后会被判定为非法(见 pkg/eval/glob_test.elvts),glob 解析器也会对此类非法组合给出错误提示(见 pkg/eval/glob.go)。
浮点数打印更自然(#811)
浮点数的打印格式被调整,输出更符合直觉(例如避免过长的冗余尾数),使脚本与 REPL 的数值输出更易读。
相对 use 导入模块
脚本现在可以使用相对路径的 use 导入 ~/.elvish/lib 之外的模块,例如 use ./my-lib,便于在项目目录内组织本地模块,无需再拷贝到全局 lib 目录。
动态字符串作为命令(#764)
只要字符串包含斜杠,动态字符串就可以直接作为命令名使用,例如 $path/to/cmd args 形式的动态路径调用,无需再借助 external 等间接手段。
CRLF 行尾支持(#918)
Elvish 源码文件现在支持 CRLF(\r\n)行尾,结合上述输出捕获对 \r\n 的处理,Elvish 脚本与输出在 Windows 生态下的兼容性得到整体提升。
注释位置放宽(#924)
注释现在可以出现在任何以换行为分隔符的位置,包括列表和 map 字面量内部。例如:
var xs = [
# 列表内注释
a
b
]
var m = [
# map 内注释
&k = v
]
^ 作为行续行符
^ 字符现在可用于行续行。由于 ^ 同时曾经是幂运算符(现已弃用并迁移到 math:pow),新旧脚本混用需注意区分语境:
# 0.14.0 起推荐使用 ^ 续行
var long = foo ^
bar ^
baz
标准库新增命令与模块
order:排序值(#651)
新增 order 命令用于对值排序,可配合管道使用:
put 3 1 2 | order
新模块:platform:、unix:、math:
0.14.0 引入了三个全新模块。从模块注册表看,math、platform 无条件注册,而 unix 模块仅在 ExposeUnixNs 为真(即 Unix 平台)时暴露(见 pkg/mods/mods.go)。典型用法:
use math
use platform
use unix
math:pow 2 10
platform:arch
unix:umask
fail 接受任意类型参数(#941)
fail 命令现在接受任意类型的参数;尤其当参数本身是异常时,会**重新抛出(rethrow)**该异常,使得"捕获后重新抛出"可以直接写作 fail $e。
show:打印异常堆栈
新增 show 命令,当前用于把异常的堆栈轨迹打印到终端,配合异常内省可用于快速诊断:
try {
fail oops
} catch e {
show $e
}
make-map:由配对序列构造 map(#943)
新增 make-map 命令,从一系列键值对构造 map。底层实现注册于容器类内建函数(见 pkg/eval/builtin_fn_container.go),适合把成对数据直接组装成关联结构。
read-line 与 read-upto:字节输入读取(#975/#831)
新增两个读取命令:
read-line:从字节输入读取一行。read-upto:读取字节输入直到遇到指定分隔符。
两者都注册于 IO 类内建函数(见 pkg/eval/builtin_fn_io.go),用于处理流式文本输入:
read-line
read-upto &
time 命令与 &on-end 回调(#295)
-time 被正式升格为 time,并新增 &on-end 选项指定如何保存执行耗时。&on-end 接收一个回调,回调参数为包含耗时指标的 map;从 eval 的 &on-end 实现可看到该模式的通用形态:回调被调用时传入新帧与结果(见 pkg/eval/builtin_fn_misc.go),time 的用法与之类似:
# 将某段代码的执行耗时保存到变量
time &on-end={|metrics| set saved = $metrics[min] } { expensive-cmd }
one:要求恰好一个输入
新增 one 命令,用于断言输入流中恰好只有一个值;若输入多于一个则报错。其实现会对输入计数,仅在 n == 1 时输出该值,否则抛出 ArityMismatch(见 pkg/eval/builtin_fn_stream.go):
put a | one # 输出 a
put a b | one # 报错:期望恰好 1 个值
交互式编辑器增强
$edit:exceptions:保存回调异常(#945)
当交互式编辑器的回调抛出异常时,异常会被保存到 $edit:exceptions 变量中供进一步检查,不再只是静默吞掉。
小型词缩写:$edit:small-word-abbr
新增"small word abbreviation"(小型词缩写)替代机制,通过 $edit:small-word-abbr 配置。与普通缩写($edit:abbr、$edit:command-abbr)相比,小型词缩写针对更短的输入片段做替换,适合高频短命令。变量通过 insert_api 注册为编辑器变量(见 pkg/edit/insert_api.go),示例(取自 pkg/edit/insert_api.d.elv):
set edit:small-word-abbr['gcm'] = 'git checkout master'
set edit:small-word-abbr['>dn'] = ' 2>/dev/null'
set edit:small-word-abbr['gcp'] = 'git cherry-pick -x'
set edit:small-word-abbr['ll'] = 'ls -ltr'
导航模式列宽比例:$edit:navigation:width-ratio(#464)
导航模式的列宽比例现在可配置:
set edit:navigation:width-ratio = [1 2 1]
$edit:add-cmd-filters:控制历史记录写入
新增 $edit:add-cmd-filters 变量,用于控制某条命令是否被加入历史记录。默认值会过滤掉以空格开头的命令——这意味着在交互提示符中刻意用前导空格输入的命令不会污染历史。
edit:complex-candidate 的 &display 选项
edit:complex-candidate 新增 &display 选项,用于指定完整的显示文本(替代已弃用的 &display-suffix):
edit:complex-candidate $candidate &display=$full-display-text
其他改进
- 运行时文件优先使用
$XDG_RUNTIME_DIR:Elvish 现在在可能的情况下使用$XDG_RUNTIME_DIR存放运行时文件,符合 freedesktop 规范,便于清理临时文件。 - 维护
$SHLVL环境变量(#834):Elvish 现在会递增$SHLVL,与主流 shell 保持一致,便于在多层嵌套 shell 中判断层级。
值得关注的缺陷修复
- 无效选项名或值现在会正确抛异常(#958):传递给内建函数的非法选项名/值不再被静默忽略。
- 重定向到高文件描述符不再崩溃(#788)。
- 索引访问不存在的变量现在产生编译期错误(#889)。
- REPL 不再把复杂命令高亮为红色(#881)。
~username之后的 glob 模式可正确求值(#793)。- Windows 上目录 Tab 补全不再添加多余的引号反斜杠(#897)。
edit:move-dot-left-small-word修复为真正按"小型词"移动:此前实际按整词移动。- 修复大量竞态条件(#73、#754 等)。
升级建议与迁移清单
若从 0.13.x 升级到 0.14.0,建议按以下清单迁移:
- 全局搜索并替换已弃用命令:
explode→all;joins/replaces/splits→str:join/str:replace/str:split;^(幂运算)→math:pow;-time→time。 - 将脚本中的行续行符从
\改为^。 - 检查
src返回值的使用:不再有type字段,path字段改用name。 - 若脚本依赖
all对字节流的透传,需改为显式按行转换。 - 检查
dir-history、re:find结果是否被assoc修改,如有则改为重建新 map。 - 利用编译期弃用警告与
$edit:exceptions辅助定位问题,迭代迁移。
小结
Elvish 0.14.0 通过引入系统化弃用机制、异常内省、相对导入与 CRLF 支持等能力,为 0.15 及后续版本的破坏性变更铺平了道路;标准库的 order、one、read-upto、make-map 以及 platform:、unix:、math: 模块则显著丰富了脚本能力,而 $edit:small-word-abbr、$edit:add-cmd-filters 等编辑器新变量让交互体验更加可控。升级时建议参照上文迁移清单逐项核对,充分利用编译期警告降低迁移成本。