vtcode-core 0.104.1

Core library for VT Code - a Rust-based terminal coding agent
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
use super::FileOpsTool;
use super::path_policy::PathSuggestionKind;
use crate::config::constants::tools;
use crate::tools::builder::ToolResponseBuilder;
use crate::tools::traits::FileTool;
use crate::tools::types::ListInput;
use anyhow::{Context, Result, anyhow};
use glob::Pattern;
use serde_json::{Value, json};
use std::future::Future;
use std::path::Path;
use tracing::{info, warn};

mod metrics;
mod search;
mod tree;

pub(super) fn compile_list_glob(input: &ListInput) -> Result<Option<Pattern>> {
    let Some(pattern) = input
        .glob_pattern
        .as_deref()
        .map(str::trim)
        .filter(|pattern| !pattern.is_empty())
    else {
        return Ok(None);
    };

    Pattern::new(pattern)
        .with_context(|| format!("invalid list glob pattern '{}'", pattern))
        .map(Some)
}

pub(super) fn list_entry_matches(
    input: &ListInput,
    relative_path: &str,
    name: &str,
    glob_pattern: Option<&Pattern>,
) -> bool {
    if let Some(pattern) = glob_pattern {
        return pattern.matches_path(Path::new(relative_path))
            || pattern.matches(relative_path)
            || pattern.matches(name);
    }

    let pattern = input.name_pattern.as_deref().unwrap_or("*");
    if pattern == "*" {
        return true;
    }

    if input.case_sensitive.unwrap_or(true) {
        name.contains(pattern)
    } else {
        name.to_lowercase().contains(&pattern.to_lowercase())
    }
}

impl FileOpsTool {
    pub(super) async fn execute_basic_list(&self, input: &ListInput) -> Result<Value> {
        use crate::tools::cache::FILE_CACHE;

        let base = self.workspace_root.join(&input.path);
        let list_glob = compile_list_glob(input)?;

        if self.should_exclude(&base).await {
            return Err(anyhow!(
                "Path '{}' is excluded by .vtcodegitignore",
                input.path
            ));
        }

        // Try to get result from cache first for directories
        let cache_key = format!(
            "dir_list:{}:hidden={}:glob={}",
            input.path,
            input.include_hidden,
            input.glob_pattern.as_deref().unwrap_or("")
        );
        if base.is_dir()
            && let Some(cached_result) = FILE_CACHE.get_directory(&cache_key).await
        {
            return Ok(cached_result);
        }

        // Pre-allocate with reasonable estimate for directory entries
        let mut all_items = Vec::with_capacity(32);
        if base.is_file() {
            let file_name = base
                .file_name()
                .ok_or_else(|| anyhow!("Invalid file name for path: {}", input.path))?;
            let file_name = file_name.to_string_lossy().into_owned();
            let relative_path = self.relative_path_json(&base);
            if !list_entry_matches(input, &relative_path, &file_name, list_glob.as_ref()) {
                return Ok(json!({
                    "success": true,
                    "items": [],
                    "count": 0,
                    "total": 0,
                    "page": input.page.unwrap_or(1).max(1),
                    "per_page": input.per_page.unwrap_or(20).max(1),
                    "has_more": false,
                    "mode": "list",
                    "response_format": input.response_format.as_deref().unwrap_or("concise"),
                    "pattern": input.glob_pattern.as_deref().unwrap_or("")
                }));
            }
            all_items.push(json!({
                "name": file_name,
                "path": relative_path,
                "type": "file"
            }));
        } else if base.is_dir() {
            let mut entries = tokio::fs::read_dir(&base).await.with_context(|| {
                format!(
                    "Failed to read directory: {}. Workspace root: {}",
                    input.path,
                    self.workspace_root.display()
                )
            })?;

            // Copy the ignore state up front so no async lock is held during directory IO.
            let gitignore = crate::utils::vtcodegitignore::snapshot_global_vtcode_gitignore().await;

            while let Some(entry) = entries
                .next_entry()
                .await
                .with_context(|| format!("Failed to read directory entry in: {}", input.path))?
            {
                let path = entry.path();
                let name = entry.file_name().to_string_lossy().into_owned();

                if !input.include_hidden && name.starts_with('.') {
                    continue;
                }

                // Batch check using shared guard instead of repeated lock acquisition
                if gitignore.should_exclude(&path) {
                    continue;
                }

                let is_dir = entry
                    .file_type()
                    .await
                    .with_context(|| format!("Failed to read file type for: {}", path.display()))?
                    .is_dir();

                let relative_path = self.relative_path_json(&path);
                if !list_entry_matches(input, &relative_path, &name, list_glob.as_ref()) {
                    continue;
                }

                all_items.push(json!({
                    "name": name,
                    "path": relative_path,
                    "type": if is_dir { "directory" } else { "file" }
                }));
            }
        } else {
            warn!(
                path = %input.path,
                exists = base.exists(),
                is_file = base.is_file(),
                is_dir = base.is_dir(),
                "Path does not exist or is neither file nor directory"
            );
            return Err(anyhow!(
                "Path '{}' does not exist{}",
                input.path,
                self.missing_path_suggestion_suffix(&input.path, PathSuggestionKind::Any),
            ));
        }

        // Apply max_items cap first for token efficiency - AGENTS.md requires max 5 items
        let capped_total = all_items.len().min(input.max_items);
        let (page, per_page) = (
            input.page.unwrap_or(1).max(1),
            input.per_page.unwrap_or(20).max(1), // Keep bounded but avoid overly sparse default pages
        );
        let start = (page - 1).saturating_mul(per_page);
        let end = (start + per_page).min(capped_total);
        let has_more = end < capped_total;
        let has_overflow = all_items.len() > input.max_items;

        let mut page_items = if start < end {
            all_items[start..end].to_vec()
        } else {
            vec![]
        };

        // Respect response_format
        let concise = input
            .response_format
            .as_deref()
            .map(|s| s.eq_ignore_ascii_case("concise"))
            .unwrap_or(true);
        if concise {
            for obj in page_items.iter_mut() {
                if let Some(map) = obj.as_object_mut() {
                    map.remove("modified");
                }
            }
        }

        // Implement AGENTS.md pattern for context optimization: show summary with sample
        let guidance = if has_overflow {
            // Show overflow indication when we have more items than max_items
            Some(format!(
                "[+{} more items]",
                all_items.len() - input.max_items
            ))
        } else if all_items.len() > 50 && page == 1 {
            // For large directories on first page, show summary pattern
            let file_count = page_items
                .iter()
                .filter(|item| {
                    item.as_object()
                        .and_then(|obj| obj.get("type"))
                        .and_then(|t| t.as_str())
                        == Some("file")
                })
                .count();
            let dir_count = page_items
                .iter()
                .filter(|item| {
                    item.as_object()
                        .and_then(|obj| obj.get("type"))
                        .and_then(|t| t.as_str())
                        == Some("directory")
                })
                .count();

            let mut sample_names = page_items
                .iter()
                .take(5)
                .filter_map(|item| {
                    item.as_object()
                        .and_then(|obj| obj.get("name"))
                        .and_then(|n| n.as_str())
                })
                .collect::<Vec<_>>();

            if sample_names.len() > 3 {
                sample_names.truncate(3);
                sample_names.push("...");
            }

            let summary = if file_count > 0 && dir_count > 0 {
                format!(
                    "{} files and {} directories (showing first {}: {})",
                    file_count,
                    dir_count,
                    sample_names.len(),
                    sample_names.join(", ")
                )
            } else if file_count > 0 {
                format!(
                    "{} files (showing first {}: {})",
                    file_count,
                    sample_names.len(),
                    sample_names.join(", ")
                )
            } else if dir_count > 0 {
                format!(
                    "{} directories (showing first {}: {})",
                    dir_count,
                    sample_names.len(),
                    sample_names.join(", ")
                )
            } else {
                "Empty directory".to_string()
            };

            Some(format!(
                "{} [+{} more items]",
                summary,
                all_items.len() - sample_names.len()
            ))
        } else if has_more || capped_total < all_items.len() || all_items.len() > 20 {
            Some(format!(
                "Showing {} of {} items (page {}, per_page {}). Use 'page' and 'per_page' to page through results.",
                page_items.len(),
                capped_total,
                page,
                per_page
            ))
        } else {
            None
        };

        let mut builder = ToolResponseBuilder::new(tools::LIST_FILES)
            .success()
            .field("items", json!(page_items))
            .field("count", json!(page_items.len()))
            .field("total", json!(capped_total))
            .field("page", json!(page))
            .field("per_page", json!(per_page))
            .field("has_more", json!(has_more))
            .field("mode", json!("list"))
            .field(
                "response_format",
                json!(if concise { "concise" } else { "detailed" }),
            );

        if let Some(msg) = guidance {
            builder = builder.message(msg);
        }
        if let Some(pattern) = input
            .glob_pattern
            .as_deref()
            .map(str::trim)
            .filter(|pattern| !pattern.is_empty())
        {
            builder = builder.field("pattern", json!(pattern));
        }

        let out = builder.build_json();

        // Cache the result for directories (TTL is 5 minutes in FILE_CACHE)
        if base.is_dir() {
            FILE_CACHE.put_directory(cache_key, out.clone()).await;
        }

        Ok(out)
    }

    /// Execute tree view of directory structure
    pub(super) fn execute_tree_view<'a>(
        &'a self,
        input: &'a ListInput,
    ) -> impl Future<Output = Result<Value>> + 'a {
        tree::execute_tree_view(self, input)
    }

    pub(super) fn paginate_and_format(
        &self,
        items: Vec<Value>,
        total_count: usize,
        input: &ListInput,
        mode: &str,
        pattern: Option<&str>,
    ) -> Value {
        let (page, per_page) = (
            input.page.unwrap_or(1).max(1),
            input.per_page.unwrap_or(50).max(1),
        );
        let total_capped = total_count.min(input.max_items);
        let start = (page - 1).saturating_mul(per_page);
        let end = (start + per_page).min(total_capped);
        let has_more = end < total_capped;

        // Log pagination operation details
        info!(
            mode = %mode,
            pattern = ?pattern,
            total_items = total_count,
            capped_total = total_capped,
            page = page,
            per_page = per_page,
            start_index = start,
            end_index = end,
            has_more = has_more,
            "Executing paginated search results"
        );

        // Validate pagination parameters
        if page > 1 && start >= total_capped {
            warn!(
                mode = %mode,
                page = page,
                per_page = per_page,
                total_items = total_capped,
                "Requested page exceeds available search results"
            );
        }

        let mut page_items = if start < end {
            items[start..end].to_vec()
        } else {
            warn!(
                mode = %mode,
                page = page,
                per_page = per_page,
                start_index = start,
                end_index = end,
                "Empty page result - no search results in requested range"
            );
            vec![]
        };

        let concise = input
            .response_format
            .as_deref()
            .map(|s| s.eq_ignore_ascii_case("concise"))
            .unwrap_or(true);
        if concise {
            for obj in page_items.iter_mut() {
                if let Some(map) = obj.as_object_mut() {
                    map.remove("modified");
                }
            }
        }

        let mut out = json!({
            "success": true,
            "items": page_items,
            "count": page_items.len(),
            "total": total_capped,
            "page": page,
            "per_page": per_page,
            "has_more": has_more,
            "mode": mode,
            "response_format": if concise { "concise" } else { "detailed" }
        });
        if let Some(p) = pattern {
            out["pattern"] = json!(p);
        }
        if has_more || total_capped > 20 {
            out["message"] = json!(format!(
                "Showing {} of {} results. Use 'page' to continue.",
                out["count"].as_u64().unwrap_or(0),
                total_capped
            ));
        }
        out
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::tools::grep_file::GrepSearchManager;
    use crate::tools::types::ListInput;
    use std::fs;
    use tempfile::TempDir;

    #[tokio::test]
    async fn missing_list_path_suggests_similar_workspace_path() {
        let temp_dir = TempDir::new().expect("workspace tempdir");
        fs::create_dir_all(temp_dir.path().join("src/agent")).expect("create agent dir");
        let grep_manager =
            std::sync::Arc::new(GrepSearchManager::new(temp_dir.path().to_path_buf()));
        let file_ops = FileOpsTool::new(temp_dir.path().to_path_buf(), grep_manager);

        let err = file_ops
            .execute_basic_list(&ListInput {
                path: "src/agnt".to_string(),
                max_items: 20,
                page: None,
                per_page: None,
                response_format: None,
                include_hidden: false,
                glob_pattern: None,
                mode: None,
                name_pattern: None,
                content_pattern: None,
                file_extensions: None,
                case_sensitive: None,
            })
            .await
            .expect_err("missing path should fail")
            .to_string();

        assert!(err.contains("Did you mean"));
        assert!(err.contains("src/agent"));
    }
}