stash.yml

Stash是一个全文检索工具,用于在代码仓库中快速搜索代码片段，以下是Stash配置文件的主要内容和配置方法：

配置文件位置

Stash的配置文件通常位于用户的主目录下,文件名为stash.yml，以下是常见的路径：

• Linux/ macOS：~/.stash/stash.yml
• Windows：%USERPROFILE%\.stash\stash.yml

配置文件结构

配置文件包含多个部分,主要有以下几个关键部分：

(1) 搜索设置

search:
  # 搜索路径，可分多个目录，建议放在项目根目录
  paths: ["/path/to/your/project", "/another/path"]
  # 最大返回条目数
  max_matches: 100
  # 是否开启智能搜索（默认true）
  smart_search: true
  # 搜索选项，可以选择`--exact`（精确匹配）、`--case-sensitive`（敏感搜索）等
  search_options: ['--exact']

(2) 索引设置

index:
  # 索引目录，默认是当前项目根目录
  index_dir: ./index
  # 索引文件扩展名，默认包括`.java`, `.kotlin`, `.scala`, `.txt`等
  index_extensions: [".java", ".kotlin", ".scala", ".txt"]
  # 是否包含隐藏文件，默认false
  include_hidden: false

(3) 代码片段高亮

highlight:
  # 高亮的语言支持，需安装对应的语法解析器
  languages:
    - java
    - kotlin
    - scala
    - txt

(4) 搜索结果显示

result:
  # 最多显示条目数
  max_result: 100
  # 是否显示路径和内容摘要
  show_path: true
  show_excerpt: true

(5) 过滤器

filters:
  # 根据文件扩展名过滤
  file_extensions: [".java", ".kotlin", ".scala"]
  # 根据路径过滤
  path_regex: "你的项目路径"

(6) 集成到IDE

如果你使用IntelliJ,可以安装Stash插件，配置如下：

• 打开IntelliJ设置,找到Plugins，搜索Stash安装。
• 安装后,配置stash的路径和索引目录。

使用命令

• 搜索文件：在终端运行stash search，然后输入搜索关键词。
• 更新索引：运行stash index，确保索引及时更新。
• 清理索引：使用stash clean清理旧的索引文件。

高级配置

• Snorkel 模型：在stash.yml中添加snorkel: true，提升搜索准确性。
• 定期更新：配置定时任务，定期更新索引。

示例配置文件

search:
  paths: ["./src", "./test"]
  max_matches: 100
  smart_search: true
  search_options: ['--exact']
index:
  index_dir: ./index
  index_extensions: [".java", ".kotlin", ".scala", ".txt"]
  include_hidden: false
result:
  max_result: 100
  show_path: true
  show_excerpt: true
filters:
  file_extensions: [".java", ".kotlin", ".scala"]
  path_regex: ""
highlight:
  languages: [java, kotlin, scala, txt]
# 集成到IntelliJ
intelli-j: true

通过以上配置,你可以根据自己的需求调整Stash的搜索范围、索引设置、结果显示和过滤器，提升开发效率。