tokmd 1.13.0

Tokei-backed repo inventory receipts (Markdown/TSV/JSONL/CSV) for PRs, CI, and LLM workflows.
Documentation
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
use std::path::PathBuf;

use crate::cli;
use anyhow::{Context, Result};
use tokmd_model as model;
use tokmd_scan as scan;

#[derive(Debug, Clone)]
pub(crate) struct ExportMetaLite {
    pub(crate) schema_version: Option<u32>,
    pub(crate) generated_at_ms: Option<u128>,
    pub(crate) module_roots: Vec<String>,
    pub(crate) module_depth: usize,
    pub(crate) children: tokmd_types::ChildIncludeMode,
}

impl Default for ExportMetaLite {
    fn default() -> Self {
        Self {
            schema_version: None,
            generated_at_ms: None,
            // Expanded defaults to cover standard project structures for ad-hoc scans
            module_roots: vec!["crates".into(), "packages".into(), "src".into()],
            module_depth: 2,
            children: tokmd_types::ChildIncludeMode::Separate,
        }
    }
}

#[derive(Debug, Clone)]
pub(crate) struct ExportBundle {
    pub(crate) export: tokmd_types::ExportData,
    pub(crate) meta: ExportMetaLite,
    /// The path to the actual data file (e.g., export.jsonl)
    pub(crate) export_path: Option<PathBuf>,
    /// The user-provided entry point (e.g., receipt.json or the run directory)
    pub(crate) entry_point: Option<PathBuf>,
    pub(crate) root: PathBuf,
}

pub(crate) fn load_export_from_inputs(
    inputs: &[PathBuf],
    global: &cli::GlobalArgs,
) -> Result<ExportBundle> {
    if inputs.len() > 1 {
        return scan_export_from_paths(inputs, global);
    }

    let input = inputs
        .first()
        .cloned()
        .unwrap_or_else(|| PathBuf::from("."));

    // Case 1: Input is a directory (Run Directory)
    if input.is_dir() {
        let run_receipt = input.join("receipt.json");
        let export_jsonl = input.join("export.jsonl");
        let export_json = input.join("export.json");

        // Priority 1: receipt.json (The manifest)
        if run_receipt.exists() {
            return load_export_from_receipt(&run_receipt, Some(input.clone()), global);
        }
        // Priority 2: export.jsonl (The raw data)
        if export_jsonl.exists() {
            return load_export_from_file(&export_jsonl, Some(input), global);
        }
        // Priority 3: export.json
        if export_json.exists() {
            return load_export_from_file(&export_json, Some(input), global);
        }
    }

    // Case 2: Input is a file (Receipt or Data)
    if input.is_file() {
        return load_export_from_file(&input, None, global);
    }

    // Case 3: Input is paths to scan (or "." default)
    scan_export_from_paths(inputs, global)
}

fn scan_export_from_paths(paths: &[PathBuf], global: &cli::GlobalArgs) -> Result<ExportBundle> {
    let scan_opts = tokmd_settings::ScanOptions::from(global);
    let languages = scan::scan(paths, &scan_opts)?;
    let meta = ExportMetaLite::default();
    let export = model::create_export_data(
        &languages,
        &meta.module_roots,
        meta.module_depth,
        meta.children,
        None,
        0,
        0,
    );
    Ok(ExportBundle {
        export,
        meta,
        export_path: None,
        entry_point: None,
        root: std::env::current_dir().unwrap_or_else(|_| PathBuf::from(".")),
    })
}

fn load_export_from_receipt(
    path: &PathBuf,
    run_dir: Option<PathBuf>,
    global: &cli::GlobalArgs,
) -> Result<ExportBundle> {
    let content = std::fs::read_to_string(path)
        .with_context(|| format!("Failed to read {}", path.display()))?;
    let receipt: tokmd_types::RunReceipt =
        serde_json::from_str(&content).context("Failed to parse run receipt")?;

    let base = run_dir.unwrap_or_else(|| path.parent().unwrap_or(path).to_path_buf());
    let export_path = base.join(&receipt.export_file);

    // Recurse to load the data file referenced by the receipt
    let mut bundle = load_export_from_file(&export_path, Some(base), global)?;

    // Fix the entry point to point to the receipt we loaded
    bundle.entry_point = Some(path.clone());
    Ok(bundle)
}

fn load_export_from_file(
    path: &PathBuf,
    run_dir: Option<PathBuf>,
    global: &cli::GlobalArgs,
) -> Result<ExportBundle> {
    let ext = path
        .extension()
        .and_then(|e| e.to_str())
        .unwrap_or("")
        .to_lowercase();

    // Fast path: Scan if not JSON-like (e.g. tokmd analyze my_script.py)
    if ext != "json" && ext != "jsonl" {
        return scan_export_from_paths(std::slice::from_ref(path), global);
    }

    let content = std::fs::read_to_string(path)
        .with_context(|| format!("Failed to read {}", path.display()))?;

    // Strategy 1: Try parsing as RunReceipt (receipt.json)
    // This handles the case where user runs `tokmd analyze receipt.json` directly
    if ext == "json"
        && let Ok(receipt) = serde_json::from_str::<tokmd_types::RunReceipt>(&content)
    {
        let base = run_dir
            .clone()
            .unwrap_or_else(|| path.parent().unwrap_or(path).to_path_buf());
        let export_file_path = base.join(&receipt.export_file);

        let mut bundle = load_export_from_file(&export_file_path, Some(base), global)?;
        bundle.entry_point = Some(path.clone());
        return Ok(bundle);
    }

    // Strategy 2: Load Export Data (jsonl or json)
    let (mut export, meta) = if ext == "jsonl" {
        load_export_jsonl_content(&content)?
    } else {
        load_export_json_content(&content)?
    };

    export.module_roots = meta.module_roots.clone();
    export.module_depth = meta.module_depth;
    export.children = meta.children;

    Ok(ExportBundle {
        export,
        meta,
        export_path: Some(path.clone()),
        entry_point: Some(path.clone()),
        root: run_dir
            .unwrap_or_else(|| std::env::current_dir().unwrap_or_else(|_| PathBuf::from("."))),
    })
}

fn load_export_jsonl_content(content: &str) -> Result<(tokmd_types::ExportData, ExportMetaLite)> {
    let mut rows = Vec::new();
    let mut meta = ExportMetaLite::default();

    for line in content.lines() {
        let line = line.trim();
        if line.is_empty() {
            continue;
        }
        let value: serde_json::Value = serde_json::from_str(line)?;
        let ty = value.get("type").and_then(|v| v.as_str()).unwrap_or("row");
        if ty == "meta" {
            if let Some(schema) = value.get("schema_version").and_then(|v| v.as_u64()) {
                meta.schema_version = Some(schema as u32);
            }
            if let Some(generated) = value.get("generated_at_ms").and_then(|v| v.as_u64()) {
                meta.generated_at_ms = Some(generated as u128);
            }
            if let Some(args) = value.get("args") {
                let parsed: tokmd_types::ExportArgsMeta = serde_json::from_value(args.clone())?;
                meta.module_roots = parsed.module_roots.clone();
                meta.module_depth = parsed.module_depth;
                meta.children = parsed.children;
            }
            continue;
        }

        let row: tokmd_types::FileRow = serde_json::from_value(value)?;
        rows.push(row);
    }

    Ok((
        tokmd_types::ExportData {
            rows,
            module_roots: meta.module_roots.clone(),
            module_depth: meta.module_depth,
            children: meta.children,
        },
        meta,
    ))
}

fn load_export_json_content(content: &str) -> Result<(tokmd_types::ExportData, ExportMetaLite)> {
    // Try ExportReceipt wrapper first
    if let Ok(receipt) = serde_json::from_str::<tokmd_types::ExportReceipt>(content) {
        let meta = ExportMetaLite {
            schema_version: Some(receipt.schema_version),
            generated_at_ms: Some(receipt.generated_at_ms),
            module_roots: receipt.args.module_roots.clone(),
            module_depth: receipt.args.module_depth,
            children: receipt.args.children,
        };
        return Ok((receipt.data, meta));
    }

    // Fallback to raw list of rows
    let rows: Vec<tokmd_types::FileRow> =
        serde_json::from_str(content).context("Failed to parse export rows")?;
    let meta = ExportMetaLite::default();

    Ok((
        tokmd_types::ExportData {
            rows,
            module_roots: meta.module_roots.clone(),
            module_depth: meta.module_depth,
            children: meta.children,
        },
        meta,
    ))
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::cli::GlobalArgs;
    use tempfile::tempdir;
    use tokmd_types::{
        ChildIncludeMode, ConfigMode, ExportArgsMeta, ExportData, ExportFormat, ExportReceipt,
        FileKind, FileRow, RedactMode, RunReceipt, ScanArgs, ScanStatus, ToolInfo,
    };

    fn sample_row() -> FileRow {
        FileRow {
            path: "src/main.rs".to_string(),
            module: "src".to_string(),
            lang: "Rust".to_string(),
            kind: FileKind::Parent,
            code: 10,
            comments: 0,
            blanks: 0,
            lines: 10,
            bytes: 120,
            tokens: 50,
        }
    }

    fn sample_args_meta() -> ExportArgsMeta {
        ExportArgsMeta {
            format: ExportFormat::Jsonl,
            module_roots: vec!["src".to_string()],
            module_depth: 1,
            children: ChildIncludeMode::Separate,
            min_code: 0,
            max_rows: 0,
            redact: RedactMode::None,
            strip_prefix: None,
            strip_prefix_redacted: false,
        }
    }

    fn sample_scan_args() -> ScanArgs {
        ScanArgs {
            paths: vec![".".to_string()],
            excluded: Vec::new(),
            excluded_redacted: false,
            config: ConfigMode::Auto,
            hidden: false,
            no_ignore: false,
            no_ignore_parent: false,
            no_ignore_dot: false,
            no_ignore_vcs: false,
            treat_doc_strings_as_comments: false,
        }
    }

    #[test]
    fn load_export_jsonl_content_parses_meta_and_rows() -> anyhow::Result<()> {
        let args = sample_args_meta();
        let meta_line = serde_json::json!({
            "type": "meta",
            "schema_version": 2,
            "generated_at_ms": 123,
            "args": args,
        });
        let row = sample_row();
        let content = format!("{}\n{}\n", meta_line, serde_json::to_string(&row)?);

        let (export, meta) = load_export_jsonl_content(&content)?;
        assert_eq!(meta.schema_version, Some(2));
        assert_eq!(meta.generated_at_ms, Some(123));
        assert_eq!(meta.module_roots, vec!["src".to_string()]);
        assert_eq!(meta.module_depth, 1);
        assert_eq!(export.rows.len(), 1);
        assert_eq!(export.rows[0].path, "src/main.rs");
        Ok(())
    }

    #[test]
    fn load_export_json_content_with_receipt() -> anyhow::Result<()> {
        let row = sample_row();
        let args = sample_args_meta();
        let receipt = ExportReceipt {
            schema_version: 2,
            generated_at_ms: 42,
            tool: ToolInfo {
                name: "tokmd".to_string(),
                version: "0.0.0".to_string(),
            },
            mode: "export".to_string(),
            status: ScanStatus::Complete,
            warnings: Vec::new(),
            scan: sample_scan_args(),
            args: args.clone(),
            data: ExportData {
                rows: vec![row.clone()],
                module_roots: args.module_roots.clone(),
                module_depth: args.module_depth,
                children: args.children,
            },
        };
        let content = serde_json::to_string(&receipt)?;

        let (export, meta) = load_export_json_content(&content)?;
        assert_eq!(meta.schema_version, Some(2));
        assert_eq!(meta.generated_at_ms, Some(42));
        assert_eq!(meta.module_roots, vec!["src".to_string()]);
        assert_eq!(export.rows.len(), 1);
        assert_eq!(export.rows[0].path, row.path);
        Ok(())
    }

    #[test]
    fn load_export_json_content_with_raw_rows() -> anyhow::Result<()> {
        let rows = vec![sample_row()];
        let content = serde_json::to_string(&rows)?;

        let (export, meta) = load_export_json_content(&content)?;
        assert!(meta.schema_version.is_none());
        assert_eq!(export.rows.len(), 1);
        assert_eq!(export.rows[0].path, "src/main.rs");
        Ok(())
    }

    #[test]
    fn load_export_from_inputs_prefers_receipt_in_dir() -> anyhow::Result<()> {
        let dir = tempdir()?;
        let export_path = dir.path().join("export.jsonl");
        let receipt_path = dir.path().join("receipt.json");

        let args = sample_args_meta();
        let meta_line = serde_json::json!({
            "type": "meta",
            "schema_version": 2,
            "generated_at_ms": 999,
            "args": args,
        });
        let row = sample_row();
        let jsonl = format!("{}\n{}\n", meta_line, serde_json::to_string(&row)?);
        std::fs::write(&export_path, jsonl)?;

        let receipt = RunReceipt {
            schema_version: 2,
            generated_at_ms: 999,
            lang_file: "lang.json".to_string(),
            module_file: "module.json".to_string(),
            export_file: "export.jsonl".to_string(),
        };
        std::fs::write(&receipt_path, serde_json::to_string(&receipt)?)?;

        let bundle = load_export_from_inputs(&[dir.path().to_path_buf()], &GlobalArgs::default())?;
        assert_eq!(bundle.export.rows.len(), 1);
        assert_eq!(
            bundle
                .export_path
                .as_ref()
                .expect("should exist")
                .file_name()
                .expect("should have name"),
            "export.jsonl"
        );
        assert_eq!(
            bundle
                .entry_point
                .as_ref()
                .expect("should exist")
                .file_name()
                .expect("should have name"),
            "receipt.json"
        );
        Ok(())
    }

    #[test]
    fn load_export_from_inputs_scans_non_json_file() -> anyhow::Result<()> {
        let dir = tempdir()?;
        let file_path = dir.path().join("sample.rs");
        std::fs::write(&file_path, "fn main() {}\n")?;

        let bundle =
            load_export_from_inputs(std::slice::from_ref(&file_path), &GlobalArgs::default())?;
        assert!(bundle.export_path.is_none());
        assert!(
            bundle
                .export
                .rows
                .iter()
                .any(|row| row.path.contains("sample.rs"))
        );
        Ok(())
    }
}