nils-agent-docs 0.6.5

CLI crate for nils-agent-docs in the nils-cli workspace.
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
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
use std::collections::{HashMap, HashSet};
use std::path::{Path, PathBuf};

use crate::config::load_configs_from_roots;
use crate::env::ResolvedRoots;
use crate::model::{
    ConfigDocumentEntry, ConfigLoadError, ConfigScopeFile, Context, DocumentSource, DocumentStatus,
    FallbackMode, LoadedConfigs, ResolveReport, ResolveSummary, ResolvedDocument,
    SUPPORTED_CONTEXTS, Scope,
};
use crate::paths::normalize_path;

pub fn supported_contexts() -> &'static [Context] {
    &SUPPORTED_CONTEXTS
}

pub fn resolve(
    context: Context,
    roots: &ResolvedRoots,
    strict: bool,
) -> Result<ResolveReport, ConfigLoadError> {
    resolve_with_mode(context, roots, strict, FallbackMode::Auto)
}

pub fn resolve_with_mode(
    context: Context,
    roots: &ResolvedRoots,
    strict: bool,
    fallback_mode: FallbackMode,
) -> Result<ResolveReport, ConfigLoadError> {
    let configs = load_configs_from_roots(roots)?;
    Ok(resolve_with_configs_with_mode(
        context,
        roots,
        strict,
        fallback_mode,
        &configs,
    ))
}

pub fn resolve_builtin(context: Context, roots: &ResolvedRoots, strict: bool) -> ResolveReport {
    resolve_builtin_with_mode(context, roots, strict, FallbackMode::Auto)
}

pub fn resolve_builtin_with_mode(
    context: Context,
    roots: &ResolvedRoots,
    strict: bool,
    fallback_mode: FallbackMode,
) -> ResolveReport {
    match resolve_with_mode(context, roots, strict, fallback_mode) {
        Ok(report) => report,
        Err(_) => resolve_builtin_only_with_mode(context, roots, strict, fallback_mode),
    }
}

pub fn resolve_builtin_only(
    context: Context,
    roots: &ResolvedRoots,
    strict: bool,
) -> ResolveReport {
    resolve_builtin_only_with_mode(context, roots, strict, FallbackMode::Auto)
}

pub fn resolve_builtin_only_with_mode(
    context: Context,
    roots: &ResolvedRoots,
    strict: bool,
    fallback_mode: FallbackMode,
) -> ResolveReport {
    let project_fallback_root = project_fallback_root(roots, fallback_mode);
    let documents = match context {
        Context::Startup => resolve_startup(roots, fallback_mode),
        Context::SkillDev => vec![resolve_required_doc(
            Context::SkillDev,
            Scope::Home,
            &roots.agent_home,
            "DEVELOPMENT.md",
            "skill development guidance from AGENT_HOME/DEVELOPMENT.md",
            DocumentSource::Builtin,
        )],
        Context::TaskTools => vec![resolve_required_doc(
            Context::TaskTools,
            Scope::Home,
            &roots.agent_home,
            "CLI_TOOLS.md",
            "tool-selection guidance from AGENT_HOME/CLI_TOOLS.md",
            DocumentSource::Builtin,
        )],
        Context::ProjectDev => vec![resolve_required_doc_with_project_fallback(
            Context::ProjectDev,
            Scope::Project,
            &roots.project_path,
            "DEVELOPMENT.md",
            "project development guidance from PROJECT_PATH/DEVELOPMENT.md",
            DocumentSource::Builtin,
            project_fallback_root,
        )],
    };

    let summary = ResolveSummary::from_documents(&documents);

    ResolveReport {
        context,
        strict,
        agent_home: roots.agent_home.clone(),
        project_path: roots.project_path.clone(),
        is_linked_worktree: roots.is_linked_worktree,
        git_common_dir: roots.git_common_dir.clone(),
        primary_worktree_path: roots.primary_worktree_path.clone(),
        documents,
        summary,
    }
}

pub fn resolve_with_configs(
    context: Context,
    roots: &ResolvedRoots,
    strict: bool,
    configs: &LoadedConfigs,
) -> ResolveReport {
    resolve_with_configs_with_mode(context, roots, strict, FallbackMode::Auto, configs)
}

pub fn resolve_with_configs_with_mode(
    context: Context,
    roots: &ResolvedRoots,
    strict: bool,
    fallback_mode: FallbackMode,
    configs: &LoadedConfigs,
) -> ResolveReport {
    let mut documents =
        resolve_builtin_only_with_mode(context, roots, strict, fallback_mode).documents;
    let builtin_keys: HashSet<ResolveKey> =
        documents.iter().map(ResolveKey::from_document).collect();

    let mut extension_documents: Vec<ResolvedDocument> = Vec::new();
    let mut extension_indices: HashMap<ResolveKey, usize> = HashMap::new();

    for config in configs.in_load_order() {
        merge_extension_documents(
            context,
            roots,
            fallback_mode,
            config,
            &builtin_keys,
            &mut extension_documents,
            &mut extension_indices,
        );
    }

    documents.extend(extension_documents);
    let summary = ResolveSummary::from_documents(&documents);

    ResolveReport {
        context,
        strict,
        agent_home: roots.agent_home.clone(),
        project_path: roots.project_path.clone(),
        is_linked_worktree: roots.is_linked_worktree,
        git_common_dir: roots.git_common_dir.clone(),
        primary_worktree_path: roots.primary_worktree_path.clone(),
        documents,
        summary,
    }
}

fn merge_extension_documents(
    context: Context,
    roots: &ResolvedRoots,
    fallback_mode: FallbackMode,
    config: &ConfigScopeFile,
    builtin_keys: &HashSet<ResolveKey>,
    extension_documents: &mut Vec<ResolvedDocument>,
    extension_indices: &mut HashMap<ResolveKey, usize>,
) {
    for (index, entry) in config.documents.iter().enumerate() {
        if entry.context != context {
            continue;
        }

        let resolved_path =
            resolve_extension_path_with_project_fallback(entry, roots, fallback_mode);
        let key = ResolveKey::new(context, entry.scope, resolved_path.clone());
        if builtin_keys.contains(&key) {
            continue;
        }

        let document = ResolvedDocument {
            context,
            scope: entry.scope,
            path: resolved_path.clone(),
            required: entry.required,
            status: if resolved_path.exists() {
                DocumentStatus::Present
            } else {
                DocumentStatus::Missing
            },
            source: extension_source(config.source_scope),
            why: extension_why(config, index, entry),
        };

        if let Some(existing_index) = extension_indices.get(&key).copied() {
            extension_documents[existing_index] = document;
        } else {
            let next_index = extension_documents.len();
            extension_documents.push(document);
            extension_indices.insert(key, next_index);
        }
    }
}

fn extension_source(source_scope: Scope) -> DocumentSource {
    match source_scope {
        Scope::Home => DocumentSource::ExtensionHome,
        Scope::Project => DocumentSource::ExtensionProject,
    }
}

fn resolve_extension_path(entry: &ConfigDocumentEntry, roots: &ResolvedRoots) -> PathBuf {
    let root = match entry.scope {
        Scope::Home => &roots.agent_home,
        Scope::Project => &roots.project_path,
    };
    normalize_path(&root.join(&entry.path))
}

fn resolve_extension_path_with_project_fallback(
    entry: &ConfigDocumentEntry,
    roots: &ResolvedRoots,
    fallback_mode: FallbackMode,
) -> PathBuf {
    let local_path = resolve_extension_path(entry, roots);
    if local_path.exists()
        || !should_use_project_fallback(entry.scope, entry.required, fallback_mode)
    {
        return local_path;
    }

    let Some(primary_root) = project_fallback_root(roots, fallback_mode) else {
        return local_path;
    };

    let fallback_path = normalize_path(&primary_root.join(&entry.path));
    if fallback_path.exists() {
        fallback_path
    } else {
        local_path
    }
}

fn extension_why(config: &ConfigScopeFile, index: usize, entry: &ConfigDocumentEntry) -> String {
    match entry
        .notes
        .as_deref()
        .map(str::trim)
        .filter(|notes| !notes.is_empty())
    {
        Some(notes) => format!(
            "extension document from {} document[{index}] notes={notes}",
            config.file_path.display()
        ),
        None => format!(
            "extension document from {} document[{index}]",
            config.file_path.display()
        ),
    }
}

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
struct ResolveKey {
    context: &'static str,
    scope: &'static str,
    path: PathBuf,
}

impl ResolveKey {
    fn new(context: Context, scope: Scope, path: PathBuf) -> Self {
        Self {
            context: context.as_str(),
            scope: scope.as_str(),
            path,
        }
    }

    fn from_document(document: &ResolvedDocument) -> Self {
        Self::new(document.context, document.scope, document.path.clone())
    }
}

fn resolve_startup(roots: &ResolvedRoots, fallback_mode: FallbackMode) -> Vec<ResolvedDocument> {
    vec![
        resolve_startup_scope(Scope::Home, &roots.agent_home, None),
        resolve_startup_scope(
            Scope::Project,
            &roots.project_path,
            project_fallback_root(roots, fallback_mode),
        ),
    ]
}

fn resolve_startup_scope(
    scope: Scope,
    root: &Path,
    fallback_root: Option<&Path>,
) -> ResolvedDocument {
    let override_path = normalize_path(&root.join("AGENTS.override.md"));
    if override_path.exists() {
        return ResolvedDocument {
            context: Context::Startup,
            scope,
            path: override_path,
            required: true,
            status: DocumentStatus::Present,
            source: DocumentSource::Builtin,
            why: format!(
                "startup {} policy (AGENTS.override.md preferred over AGENTS.md)",
                scope
            ),
        };
    }

    let local_agents_path = normalize_path(&root.join("AGENTS.md"));
    if local_agents_path.exists() {
        return ResolvedDocument {
            context: Context::Startup,
            scope,
            path: local_agents_path,
            required: true,
            status: DocumentStatus::Present,
            source: DocumentSource::BuiltinFallback,
            why: format!(
                "startup {} policy (AGENTS.override.md missing, fallback AGENTS.md)",
                scope
            ),
        };
    }

    if let Some(fallback_root) = fallback_root {
        let fallback_override = normalize_path(&fallback_root.join("AGENTS.override.md"));
        if fallback_override.exists() {
            return ResolvedDocument {
                context: Context::Startup,
                scope,
                path: fallback_override,
                required: true,
                status: DocumentStatus::Present,
                source: DocumentSource::Builtin,
                why: format!(
                    "startup {} policy (local missing, fallback to primary AGENTS.override.md)",
                    scope
                ),
            };
        }

        let fallback_agents = normalize_path(&fallback_root.join("AGENTS.md"));
        if fallback_agents.exists() {
            return ResolvedDocument {
                context: Context::Startup,
                scope,
                path: fallback_agents,
                required: true,
                status: DocumentStatus::Present,
                source: DocumentSource::BuiltinFallback,
                why: format!(
                    "startup {} policy (local missing, fallback to primary AGENTS.md)",
                    scope
                ),
            };
        }
    }

    resolve_required_doc(
        Context::Startup,
        scope,
        root,
        "AGENTS.md",
        &format!(
            "startup {} policy (AGENTS.override.md missing, fallback AGENTS.md)",
            scope
        ),
        DocumentSource::BuiltinFallback,
    )
}

fn resolve_required_doc_with_project_fallback(
    context: Context,
    scope: Scope,
    root: &Path,
    file_name: &str,
    why: &str,
    source: DocumentSource,
    fallback_root: Option<&Path>,
) -> ResolvedDocument {
    let local_path = normalize_path(&root.join(file_name));
    if local_path.exists() {
        return ResolvedDocument {
            context,
            scope,
            path: local_path,
            required: true,
            status: DocumentStatus::Present,
            source,
            why: why.to_string(),
        };
    }

    if scope == Scope::Project
        && let Some(fallback_root) = fallback_root
    {
        let fallback_path = normalize_path(&fallback_root.join(file_name));
        if fallback_path.exists() {
            return ResolvedDocument {
                context,
                scope,
                path: fallback_path,
                required: true,
                status: DocumentStatus::Present,
                source,
                why: format!("{why} (fallback to primary worktree)"),
            };
        }
    }

    ResolvedDocument {
        context,
        scope,
        path: local_path,
        required: true,
        status: DocumentStatus::Missing,
        source,
        why: why.to_string(),
    }
}

fn project_fallback_root(roots: &ResolvedRoots, fallback_mode: FallbackMode) -> Option<&Path> {
    if fallback_mode == FallbackMode::Auto && roots.is_linked_worktree {
        roots.primary_worktree_path.as_deref()
    } else {
        None
    }
}

fn should_use_project_fallback(scope: Scope, required: bool, fallback_mode: FallbackMode) -> bool {
    scope == Scope::Project && required && fallback_mode == FallbackMode::Auto
}

fn resolve_required_doc(
    context: Context,
    scope: Scope,
    root: &Path,
    file_name: &str,
    why: &str,
    source: DocumentSource,
) -> ResolvedDocument {
    let path = normalize_path(&root.join(file_name));
    let status = if path.exists() {
        DocumentStatus::Present
    } else {
        DocumentStatus::Missing
    };

    ResolvedDocument {
        context,
        scope,
        path,
        required: true,
        status,
        source,
        why: why.to_string(),
    }
}