终极指南：如何创建和管理Sourcebot搜索上下文提升代码搜索效率

终极指南：如何创建和管理Sourcebot搜索上下文提升代码搜索效率

【免费下载链接】sourcebotSourcebot is a self-hosted tool that helps humans and agents understand your codebase.项目地址: https://gitcode.com/gh_mirrors/sou/sourcebot

Sourcebot是一款自托管工具，帮助开发者和智能体理解代码库。其中搜索上下文功能允许用户定义代码库的特定分组，显著提升代码搜索效率。本文将详细介绍如何创建和管理Sourcebot搜索上下文，让你轻松掌控代码搜索范围。

什么是Sourcebot搜索上下文？

搜索上下文是用户定义的仓库分组，可帮助你将搜索聚焦于代码库的特定区域，如前端、后端或基础设施代码。通过使用搜索上下文，你可以快速缩小搜索范围，找到相关代码。

以下是一些使用搜索上下文的查询示例：

• context:data_engineering userId- 在所有与数据工程相关的仓库中搜索userId
• context:k8s ingress- 在Kubernetes配置中搜索与入口相关的内容
• ( context:project1 or context:project2 ) logger\.debug- 在project1和project2中搜索调试日志调用

如何创建搜索上下文？

搜索上下文在声明式配置的context对象中定义。你可以通过在include数组或exclude数组中指定仓库URL来包含或排除仓库。支持通配符模式。

实际示例

假设我们有一个托管在https://gitlab.example.com的GitLab实例，包含三个顶级组：web、backend和shared：

web/ ├─ admin_panel/ ├─ customer_portal/ ├─ pipelines/ backend/ ├─ billing_server/ ├─ auth_server/ ├─ db_migrations/ shared/ ├─ protobufs/ ├─ react/

我们可以在config.json中创建三个搜索上下文：

• web：所有前端相关代码
• backend：后端服务和共享API
• pipelines：所有CI/CD配置

{ "$schema": "https://raw.githubusercontent.com/sourcebot-dev/sourcebot/main/schemas/v3/index.json", "contexts": { "web": { "include": [ "gitlab.example.com/web/admin_panel/core", "gitlab.example.com/web/customer_portal/**", "gitlab.example.com/shared/react/**", "gitlab.example.com/shared/protobufs/**" ], "exclude": [ "gitlab.example.com/web/customer_portal/pipelines", "gitlab.example.com/shared/react/hooks/**", ], "description": "Web related repos." }, "backend": { /* ... 指定后端相关仓库 ... */}, "pipelines": { /* ... 指定流水线相关仓库 ... */ } }, "connections": { /* ... 连接定义 ... */ } }

仓库URL详情：仓库URL应不带前导http(s)://前缀。例如：github.com/sourcebot-dev/sourcebot、gitlab.com/gitlab-org/gitlab。

如何使用搜索上下文？

配置完成后，你可以在搜索栏中使用这些上下文，方法是在查询前加上上下文名称。

Sourcebot搜索上下文示例展示了如何在搜索栏中使用上下文前缀

例如：

• context:web login form- 在前端仓库中搜索登录表单代码
• context:backend auth- 在后端服务中搜索身份验证代码
• context:pipelines deploy- 搜索部署配置

与其他前缀一样，可以使用-否定上下文或使用or组合上下文：

• -context:web- 从结果中排除前端仓库
• ( context:web or context:backend )- 在前端和后端代码中搜索

更多搜索查询语法细节，请参见搜索语法参考文档。

按主题过滤仓库

如果你的仓库在GitHub或GitLab上标记了主题，你可以使用includeTopics和excludeTopics按主题过滤仓库，而不是（或除了）指定单个仓库URL。支持通配符模式。

{ "$schema": "https://raw.githubusercontent.com/sourcebot-dev/sourcebot/main/schemas/v3/index.json", "contexts": { "backend": { "includeTopics": ["backend", "core-*"], "excludeTopics": ["deprecated", "archived-*"], "description": "Active backend services." } }, "connections": { /* ... 连接定义 ... */ } }

includeTopics和excludeTopics遵循与include和exclude相同的附加语义：

• includeTopics- 将所有标记有匹配主题的仓库添加到上下文中
• excludeTopics- 从上下文中移除标记有匹配主题的仓库
• 两者都可以与include、includeConnections、exclude和excludeConnections自由组合

注意：主题在连接同步时填充。如果在最后一次同步后向仓库添加了主题，请触发重新同步以使新主题生效。

搜索上下文 schema 参考

完整的搜索上下文 schema 定义可以在schemas/v3/searchContext.json中找到。通过合理配置搜索上下文，你可以大幅提高代码搜索效率，更快地找到所需代码。

希望本指南能帮助你充分利用Sourcebot的搜索上下文功能，提升你的开发效率！

【免费下载链接】sourcebotSourcebot is a self-hosted tool that helps humans and agents understand your codebase.项目地址: https://gitcode.com/gh_mirrors/sou/sourcebot