3.7 KiB
3.7 KiB
Configuration
这是 clice.toml 的文档。
Server
Rule
[[rules]] 表示一个对象数组，其中每个对象都拥有下面这些属性
| 名称 | 类型 |
|---|---|
[rules].pattern |
array of string |
用于匹配文件路径的 glob patterns，遵循 LSP 的 标准。
*: 匹配路径段中的一个或多个字符。?: 匹配路径段中的单个字符。**: 匹配任意数量的路径段，包括零个。{}: 用于分组条件 (例如，**/*.{ts,js}匹配所有 TypeScript 和 JavaScript 文件)。[]: 声明要匹配的路径段中的字符范围 (例如，example.[0-9]匹配example.0,example.1等)。[!...]: 排除要匹配的路径段中的字符范围 (例如，example.[!0-9]匹配example.a,example.b，但不匹配example.0)。
| 名称 | 类型 | 默认值 |
|---|---|---|
[rules].append |
array of string |
[] |
追加到原始命令列表中的命令。例如，append = ["-std=c++17"]。
| 名称 | 类型 | 默认值 |
|---|---|---|
[rules].remove |
array of string |
[] |
从原始命令列表中移除的命令。例如，remove = ["-std=c++11"]。
| 名称 | 类型 | 默认值 |
|---|---|---|
[rules].readonly |
string |
"auto" |
控制文件是否被视为只读。值可以是 "auto"、"always" 和 "never" 中的一个。
"auto": 在你编辑文件之前，文件被视为只读。"always": 始终将文件视为只读。"never": 始终将文件视为非只读。
只读意味着文件不可编辑，并且像代码操作 (code actions) 或补全 (completions) 这样的 LSP 请求不会在其上触发。这避免了动态计算，并允许直接加载预先索引的结果，从而提高性能。
| 名称 | 类型 | 默认值 |
|---|---|---|
[rules].header |
string |
"auto" |
控制如何处理头文件。值可以是 "auto"、"always" 和 "never" 中的一个。
"auto": 首先尝试推断头文件上下文。如果未找到头文件上下文，文件将被视为普通的源文件。"always": 始终将文件视为头文件。如果未找到头文件上下文，将会报告错误。"never": 始终将文件视为源文件。
头文件上下文指的是与该头文件相关联的源文件或其他元数据。
| 名称 | 类型 | 默认值 |
|---|---|---|
[rules].contexts |
array of string |
[] |
为文件指定额外的头文件上下文 (文件路径)。
通常，一旦文件被索引，头文件上下文会自动推断。但是，如果你需要在索引完成前获得即时上下文，可以使用此字段手动提供。
Cache
| 名称 | 类型 | 默认值 |
|---|---|---|
cache.dir |
string |
"${workspace}/.clice/cache" |
用于储存 PCH 和 PCM 缓存的文件夹。
Index
| 名称 | 类型 | 默认值 |
|---|---|---|
index.dir |
string |
"${workspace}/.clice/index" |
用于储存索引文件的文件夹。