SuperAPI AI 工具集

file-links

编程与开发

查看项目

更新于 10-16 02:49

技能介绍

用途

file-links 是一个用于统一文件引用格式的技能。当在输出中引用文件时,它要求将文件引用格式化为 Markdown 链接,并使用 GitHub 风格的 #L 片段来标注行号。该技能属于 xenodium/emacs-skills 技能集,旨在让文件引用在文档、代码审查、错误报告等场景中保持一致、可点击、可定位。

主要能力

该技能定义了文件引用的标准格式,涵盖以下情况:

  • 带行号的引用:链接文本使用冒号表示行号,例如 [filename.el:42](relative/path/to/filename.el#L42)。
  • 带行号范围的引用:链接文本使用连字符表示范围,例如 [filename.el:42-50](relative/path/to/filename.el#L42-L50)。
  • 不带行号的引用:例如 [filename.el](relative/path/to/filename.el)。

技能明确要求:链接文本使用 : 表示行号(如 filename.el:42),URL 使用 #L 表示行号(如 filename.el#L42);对于范围,链接文本使用 -(如 filename.el:42-50),URL 使用 -L(如 filename.el#L42-L50);范围必须同时出现在链接文本和 URL 中。技能还给出了错误示例,例如 [filename.el#L42-L50](filename.el#L42) 是不允许的。

使用方式

该技能以规则形式约束输出行为,使用时遵循以下规则:

  • 使用相对于项目根目录的路径。
  • 在行号相关时包含行号,例如错误位置、函数定义、修改行等。
  • 引用一段代码块时使用行号范围。
  • 链接文本应为文件名(或在需要澄清时使用相对路径),后跟行号。

该技能不提供安装命令或代码接口,其使用方式是在生成文件引用时套用上述格式规则。

适用场景

该技能适用于需要在文本输出中引用代码文件的场景,例如:代码审查意见、错误报告与定位、文档编写、变更说明等。通过统一的 Markdown 链接与 #L 行号语法,读者可以直接点击跳转到对应文件与行。

限制

资料未提供该技能的具体实现方式、安装步骤、依赖环境、支持的平台或工具集成信息。该技能仅规定文件引用的输出格式,不涉及文件内容的读取、修改或其他功能。