dodot-lib 4.0.0

Core library for dodot dotfiles manager
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

{%- if kind == "summary" -%}
[header]dodot probe[/header]
  [dim]data_dir:[/dim] {{ data_dir }}

[header]Subcommands:[/header]
{% for sub in available %}  [pack-name]{{ sub.name | col(20) }}[/pack-name] [description]{{ sub.description }}[/description]
{% endfor %}
{%- elif kind == "deployment-map" -%}
[header]Deployment map[/header]
  [dim]file:[/dim] {{ map_path }}

{% if entries %}  [dim]{{ "pack" | col(16) }} {{ "handler" | col(10) }} {{ "kind" | col(10) }} {{ "source" | col(40) }} datastore[/dim]
{% for e in entries %}  [pack-name]{{ e.pack | col(16) }}[/pack-name] [handler-symbol]{{ e.handler | col(10) }}[/handler-symbol] [description]{{ e.kind | col(10) }}[/description] {{ e.source | col(40) }} [dim]{{ e.datastore }}[/dim]
{% endfor %}{% else %}  [dim](nothing deployed — run `dodot up` first)[/dim]
{% endif %}
{%- elif kind == "show-data-dir" -%}
[header]Data directory[/header]
  [dim]root:[/dim] {{ data_dir }}
  [dim]nodes:[/dim] {{ total_nodes }}   [dim]size:[/dim] {{ total_size }} B

{% for line in lines %}{{ line.prefix }}{{ line.name }}{% if line.annotation %} [dim]{{ line.annotation }}[/dim]{% endif %}
{% endfor %}
{%- elif kind == "shell-init" -%}
[header]Shell-init profile[/header]
{% if stale %}  [warning]warning:[/warning] this profile was captured at {{ profile_when }} — before
           your most recent `dodot up` at {{ last_up_when }}. Open a new
           shell to capture a fresh profile.

{% endif %}{% if has_profile %}  [dim]run:[/dim] {{ filename }}
  [dim]shell:[/dim] {{ shell }}

{% for g in groups %}  [pack-name]{{ g.pack }}[/pack-name] [description]/[/description] [handler-symbol]{{ g.handler }}[/handler-symbol] [dim]({{ g.group_total_label }})[/dim]
{% for r in g.rows %}    {{ r.target | col(36) }} [{{ r.status_class }}]{{ r.duration_label | col(10) }}[/{{ r.status_class }}]{% if r.exit_status != 0 %} [error]exit {{ r.exit_status }}[/error]{% endif %}
{% endfor %}{% endfor %}
  [dim]──[/dim]
  user-sourced total   [deployed]{{ user_total_us }} µs[/deployed]
  dodot framing        [dim]{{ framing_us }} µs[/dim]
  grand total          [header]{{ total_us }} µs[/header]
{% else %}{% if profiling_enabled %}  [dim](no profile yet — open a new shell that sources `dodot-init.sh`,[/dim]
  [dim] then re-run `dodot probe shell-init`)[/dim]
{% else %}  [dim](profiling is disabled in config — set [profiling] enabled = true,[/dim]
  [dim] run `dodot up`, then start a new shell)[/dim]
{% endif %}{% endif %}
  [dim]profiles dir:[/dim] {{ profiles_dir }}
  [dim]for intra-file profiling, see `zprof` (zsh) or PS4 tracing (bash).[/dim]
{%- elif kind == "shell-init-aggregate" -%}
[header]Shell-init aggregate[/header]
{% if stale %}  [warning]warning:[/warning] the most recent run was captured at {{ latest_profile_when }} —
           before your most recent `dodot up` at {{ last_up_when }}. Open
           a new shell to capture a fresh profile.

{% endif %}  [dim]runs:[/dim] {{ runs }}{% if runs != requested_runs %} [warning](requested {{ requested_runs }})[/warning]{% endif %}

{% if rows %}  [dim]{{ "pack" | col(14) }} {{ "handler" | col(8) }} {{ "target" | col(28) }} {{ "p50" | col(10) }} {{ "p95" | col(10) }} {{ "max" | col(10) }} runs[/dim]
{% for r in rows %}  [pack-name]{{ r.pack | col(14) }}[/pack-name] [handler-symbol]{{ r.handler | col(8) }}[/handler-symbol] {{ r.target | col(28) }} [deployed]{{ r.p50_label | col(10) }}[/deployed] {{ r.p95_label | col(10) }} {{ r.max_label | col(10) }} [dim]{{ r.seen_label }}[/dim]
{% endfor %}{% else %}{% if profiling_enabled %}  [dim](no profiles yet — open a few shells that source `dodot-init.sh`,[/dim]
  [dim] then re-run with `--runs N`)[/dim]
{% else %}  [dim](profiling is disabled in config — set [profiling] enabled = true,[/dim]
  [dim] run `dodot up`, then start a new shell)[/dim]
{% endif %}{% endif %}
  [dim]profiles dir:[/dim] {{ profiles_dir }}
{%- elif kind == "shell-init-errors" -%}
[header]Shell-init errors[/header]
{% if stale %}  [warning]warning:[/warning] the most recent run was captured at {{ latest_profile_when }} —
           before your most recent `dodot up` at {{ last_up_when }}. Open
           a new shell to capture a fresh profile.

{% endif %}  [dim]examined:[/dim] {{ runs_examined }} run{% if runs_examined != 1 %}s{% endif %}

{% if targets %}{% for t in targets %}  [pack-name]{{ t.pack }}[/pack-name] [description]/[/description] [handler-symbol]{{ t.handler }}[/handler-symbol] [dim]/[/dim] {{ t.display_target }} [error]({{ t.failure_count }} failed)[/error]
  [dim]{{ t.target }}[/dim]
{% for r in t.runs %}    {{ r.when | col(18) }} [error]{{ r.duration_label | col(10) }}[/error] [error]exit {{ r.exit_status }}[/error]
{% for line in r.stderr_lines %}      [dim]>[/dim] [error]{{ line }}[/error]
{% endfor %}{% endfor %}
{% endfor %}{% else %}  [deployed](no failed sources in the last {{ runs_examined }} run{% if runs_examined != 1 %}s{% endif %})[/deployed]
{% endif %}  [dim]profiles dir:[/dim] {{ profiles_dir }}
{%- elif kind == "shell-init-filter" -%}
[header]Shell-init filter[/header] [pack-name]{{ filter }}[/pack-name]
{% if stale %}  [warning]warning:[/warning] the most recent run was captured at {{ latest_profile_when }} —
           before your most recent `dodot up` at {{ last_up_when }}. Open
           a new shell to capture a fresh profile.

{% endif %}  [dim]examined:[/dim] {{ runs_examined }} run{% if runs_examined != 1 %}s{% endif %}

{% if targets %}{% for t in targets %}  [pack-name]{{ t.pack }}[/pack-name] [description]/[/description] [handler-symbol]{{ t.handler }}[/handler-symbol] [dim]/[/dim] {{ t.display_target }}{% if t.failure_count > 0 %} [error]({{ t.failure_count }} failed)[/error]{% endif %}
  [dim]{{ t.target }}[/dim]
{% for r in t.runs %}    {{ r.when | col(18) }} [{{ r.status_class }}]{{ r.duration_label | col(10) }}[/{{ r.status_class }}]{% if r.exit_status != 0 %} [error]exit {{ r.exit_status }}[/error]{% else %} [dim]exit 0[/dim]{% endif %}
{% for line in r.stderr_lines %}      [dim]>[/dim] [error]{{ line }}[/error]
{% endfor %}{% endfor %}
{% endfor %}{% else %}  [dim](no entries matched `{{ filter }}` in the last {{ runs_examined }} run{% if runs_examined != 1 %}s{% endif %})[/dim]
{% endif %}  [dim]profiles dir:[/dim] {{ profiles_dir }}
{%- elif kind == "shell-init-history" -%}
[header]Shell-init history[/header]
{% if stale %}  [warning]warning:[/warning] the most recent run was captured at {{ latest_profile_when }} —
           before your most recent `dodot up` at {{ last_up_when }}. Open
           a new shell to capture a fresh profile.

{% endif %}
{% if rows %}  [dim]{{ "when (UTC)" | col(18) }} {{ "shell" | col(20) }} {{ "total" | col(10) }} {{ "user" | col(10) }} {{ "entries" | col(8) }} fail[/dim]
{% for r in rows %}  {{ r.when | col(18) }} {{ r.shell | col(20) }} [deployed]{{ r.total_label | col(10) }}[/deployed] {{ r.user_total_label | col(10) }} {{ r.entry_count | string | col(8) }} {% if r.failed_entries > 0 %}[error]{{ r.failed_entries }}[/error]{% else %}[dim]0[/dim]{% endif %}
{% endfor %}{% else %}{% if profiling_enabled %}  [dim](no profiles yet — open a shell that sources `dodot-init.sh`)[/dim]
{% else %}  [dim](profiling is disabled in config — set [profiling] enabled = true,[/dim]
  [dim] run `dodot up`, then start a new shell)[/dim]
{% endif %}{% endif %}
  [dim]profiles dir:[/dim] {{ profiles_dir }}
{%- elif kind == "app" -%}
[header]App-support probe: [pack-name]{{ pack }}[/pack-name][/header]
{% if not macos %}  [dim](non-macOS host — brew/Spotlight metadata not available; folder existence reflects collapsed app_support_dir)[/dim]
{% endif %}{% if entries %}{% for e in entries %}  [filename]{{ e.folder }}[/filename] [dim]({{ e.source_rule }})[/dim] {{ e.target_path }} {% if e.target_exists %}[deployed][exists][/deployed]{% else %}[warning][missing][/warning]{% endif %}
{% if e.cask %}    cask:   [filename]{{ e.cask }}[/filename] [dim](installed)[/dim]
{% endif %}{% if e.app_bundle %}    app:    [dim]/Applications/{{ e.app_bundle }}[/dim]
{% endif %}{% if e.bundle_id %}    bundle: [dim]{{ e.bundle_id }}[/dim]
{% endif %}{% endfor %}{% else %}  [dim](pack has no `_app/`, `force_app`, or `app_aliases` entries)[/dim]
{% endif %}{% if suggested_adoptions %}
[header]Suggested sibling adoptions[/header] [dim](from cask zap)[/dim]
{% for s in suggested_adoptions %}  [dim]{{ s }}[/dim]
{% endfor %}{% endif %}
{%- endif -%}