dotr-dear 1.4.1

A dotfiles manager as dear as a daughter.
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
use std::path::{Path, PathBuf};

use clap::{Args, Parser, Subcommand};

use crate::{
    config::{self, Config},
    context::Context,
};

#[derive(Debug, Parser)]
#[command(
    name = "dotr",
    version,
    about,
    long_about = "DotR keeps a repository of your dotfiles separate from where they're \
actually used, and manages copying or symlinking them into place.\n\n\
Packages describe individual files or directories with a source and \
destination; profiles let the same repository describe different \
machines (work, home, server) with different packages, variables, and \
destinations. Config files can embed Tera template syntax compiled at \
deploy time, and pre/post shell hooks can run around each deployment."
)]
pub struct Cli {
    #[clap(subcommand)]
    pub command: Option<Command>,
    /// Run as if invoked from this directory instead of the current one.
    #[clap(short, long, global = true)]
    pub working_dir: Option<String>,
}

#[derive(Debug, Subcommand)]
pub enum Command {
    Init(InitArgs),
    Import(ImportArgs),
    Deploy(DeployArgs),
    Update(UpdateArgs),
    Diff(DiffArgs),
    Remove(RemovePackageArgs),
    PrintVars(PrintVarsArgs),
    Packages(PackagesArgs),
    Profiles(ProfilesArgs),
}

#[derive(Debug, Args, Default)]
#[command(
    name = "remove",
    about = "Remove a managed package.",
    long_about = "Deletes a package's entry from config.toml and its files from \
dotfiles/. Refuses to remove a package that another package or profile still depends \
on unless --force is given."
)]
pub struct RemovePackageArgs {
    /// Packages to remove.
    #[arg(num_args(0..))]
    pub packages: Option<Vec<String>>,

    /// Remove even if another package or profile still depends on it.
    #[arg(short, long, default_value_t = false)]
    pub force: bool,

    /// Also remove dependencies left unreferenced after this removal.
    #[arg(long, default_value_t = false)]
    pub remove_orphans: bool,

    /// Preview what would be removed without making changes.
    #[arg(long, default_value_t = false)]
    pub dry_run: bool,

    /// Profile context used to resolve dependencies.
    #[arg(short = 'P', long)]
    pub profile: Option<String>,
}

#[derive(Debug, Args)]
#[command(
    name = "init",
    about = "Initialize dotfiles repository.",
    long_about = "Creates config.toml, a dotfiles/ directory, and a .gitignore in the \
working directory. Safe to re-run - if config.toml already exists, it's left untouched."
)]
pub struct InitArgs {}

#[derive(Debug, Args, Default)]
#[command(
    name = "print-vars",
    about = "Print all user variables.",
    long_about = "Prints every variable resolved for the given (or default) profile - \
config, environment, package, profile, and prompt-sourced - useful for debugging why a \
template rendered the way it did."
)]
pub struct PrintVarsArgs {
    /// Resolve variables for this profile instead of the default.
    #[arg(short, long)]
    pub profile: Option<String>,
}

#[derive(Debug, Args)]
#[command(
    name = "import",
    about = "Import dotfile and update configuration.",
    long_about = "Copies a file or directory into the repository and registers it as a \
package in config.toml, with a source and destination. Use --symlink to also deploy it \
immediately as a symlink instead of a copy."
)]
#[derive(Default)]
pub struct ImportArgs {
    /// Path to the file or directory to import.
    #[arg(value_name = "IMPORT_PATH")]
    pub path: String,

    /// Deploy as a symlink instead of a copy, and deploy immediately.
    #[arg(short, long, default_value_t = false)]
    pub symlink: bool,

    /// Override the auto-derived package name.
    #[arg(short, long)]
    pub name: Option<String>,

    /// Add the package to this profile's dependencies instead of default.
    #[arg(short, long)]
    pub profile: Option<String>,
}

#[derive(Debug, Args, Default)]
#[command(
    name = "diff",
    about = "Show differences between dotfiles.",
    long_about = "Shows a colored, line-by-line diff between what's in the repository \
and what's currently deployed, without changing anything."
)]
pub struct DiffArgs {
    /// Diff only these packages. Omit to diff the active profile's packages.
    #[arg(num_args(0..), short, long)]
    pub packages: Option<Vec<String>>,

    /// Use this profile instead of the resolved default.
    #[arg(short = 'P', long)]
    pub profile: Option<String>,

    /// Keep diffing remaining packages if one fails.
    #[arg(long, default_value_t = false)]
    pub ignore_errors: bool,
}

#[derive(Debug, Args, Default)]
#[command(
    name = "update",
    about = "Update dotfiles from deployed versions.",
    long_about = "Copies changes made to deployed files back into the repository, so \
dotfiles/ keeps reflecting what's actually deployed. Templated packages are skipped, \
since the template file is the source of truth."
)]
pub struct UpdateArgs {
    /// Update only these packages. Omit to update the active profile's packages.
    #[arg(num_args(0..), short, long)]
    pub packages: Option<Vec<String>>,

    /// Use this profile instead of the resolved default.
    #[arg(short = 'P', long)]
    pub profile: Option<String>,

    /// Keep updating remaining packages if one fails.
    #[arg(long, default_value_t = false)]
    pub ignore_errors: bool,

    /// Override the clean mode setting for this run.
    #[arg(long)]
    pub clean: Option<bool>,

    /// Preview without changing anything.
    #[arg(long, default_value_t = false)]
    pub dry_run: bool,
}

#[derive(Debug, Args, Default)]
#[command(
    name = "deploy",
    about = "Deploy dotfiles from repository.",
    long_about = "Copies (or symlinks) every selected package from the repository to \
its destination. Selects the active profile's packages by default, or a specific set \
via --packages."
)]
pub struct DeployArgs {
    /// Deploy only these packages (plus dependencies, unless
    /// --ignore-dependencies). Omit to deploy the active profile's packages.
    #[arg(num_args(0..), short, long)]
    pub packages: Option<Vec<String>>,

    /// Use this profile instead of the resolved default.
    #[arg(short = 'P', long)]
    pub profile: Option<String>,

    /// Keep deploying remaining packages if one fails.
    #[arg(long, default_value_t = false)]
    pub ignore_errors: bool,

    /// Override the clean mode setting for this run.
    #[arg(long)]
    pub clean: Option<bool>,

    /// Preview without changing anything.
    #[arg(long, default_value_t = false)]
    pub dry_run: bool,

    /// Skip both pre- and post-actions.
    #[arg(long, default_value_t = false)]
    pub skip_actions: bool,

    /// Skip only pre-actions.
    #[arg(long, default_value_t = false)]
    pub skip_pre_actions: bool,

    /// Skip only post-actions.
    #[arg(long, default_value_t = false)]
    pub skip_post_actions: bool,

    /// Deploy only the selected packages, without pulling in dependencies.
    #[arg(long, default_value_t = false)]
    pub ignore_dependencies: bool,
}

#[derive(Debug, Args, Default)]
#[command(
    name = "packages",
    about = "Manage packages (list, import, deploy, update, remove, diff).",
    long_about = "Groups package-scoped commands under one namespace. Each subcommand \
behaves the same as its top-level equivalent, plus list for viewing all managed packages."
)]
pub struct PackagesArgs {
    /// Profile context for the packages subcommand.
    #[arg(short = 'P', long)]
    pub profile: Option<String>,
    #[clap(subcommand)]
    pub command: Option<PackagesCommand>,
}

#[derive(Debug, Subcommand)]
pub enum PackagesCommand {
    List(PackagesListArgs),
    Import(ImportArgs),
    Deploy(DeployArgs),
    Update(UpdateArgs),
    Remove(RemovePackageArgs),
    Diff(DiffArgs),
}

#[derive(Debug, Args, Default)]
#[command(
    name = "list",
    about = "List all managed packages.",
    long_about = "Lists every package currently tracked in config.toml. Use --verbose \
to also show each package's source, destination, and other fields."
)]
pub struct PackagesListArgs {
    /// Show detailed information for each package.
    #[arg(short, long, default_value_t = false)]
    pub verbose: bool,
}

#[derive(Debug, Args, Default)]
#[command(
    name = "profiles",
    about = "Manage profiles (list, add, remove).",
    long_about = "Profiles describe an environment (work, home, a server) as a set of \
packages, variables, and prompts, so the same repository can deploy differently \
depending on which profile is active."
)]
pub struct ProfilesArgs {
    #[clap(subcommand)]
    pub command: Option<ProfilesCommand>,
}

#[derive(Debug, Subcommand)]
pub enum ProfilesCommand {
    Add(ProfilesAddArgs),
    List(ProfilesListArgs),
    Remove(ProfileRemoveArgs),
}

#[derive(Debug, Args, Default)]
#[command(
    name = "remove",
    about = "Remove a profile.",
    long_about = "Deletes a profile from config.toml. The default profile cannot be \
removed. Use --remove-orphans to also clean up packages that were only referenced by \
this profile."
)]
pub struct ProfileRemoveArgs {
    /// Name of the profile to remove.
    #[arg(value_name = "PROFILE_NAME")]
    pub name: String,

    /// Preview what would be removed without making changes.
    #[arg(long, default_value_t = false)]
    pub dry_run: bool,

    /// Also remove packages that were only referenced by this profile.
    #[arg(long, default_value_t = false)]
    pub remove_orphans: bool,
}

#[derive(Debug, Args, Default)]
#[command(
    name = "list",
    about = "List all profiles.",
    long_about = "Lists every profile defined in config.toml. Use --verbose to also \
show each profile's dependencies and variables."
)]
pub struct ProfilesListArgs {
    /// Show detailed information for each profile.
    #[arg(short, long, default_value_t = false)]
    pub verbose: bool,
}

#[derive(Debug, Args, Default)]
#[command(
    name = "add",
    about = "Add a new profile.",
    long_about = "Creates a new, empty profile in config.toml. Use --set-as-current to \
make it the default on this machine by writing DOTR_PROFILE into .uservariables.toml."
)]
pub struct ProfilesAddArgs {
    /// Name for the new profile.
    #[arg(value_name = "PROFILE_NAME")]
    pub name: String,

    /// Save this profile as the default (writes DOTR_PROFILE to .uservariables.toml).
    #[arg(long, default_value_t = false)]
    pub set_as_current: bool,
}

const BANNER: &str = r#"
██████╗  ██████╗ ████████╗██████╗ 
██╔══██╗██╔═══██╗╚══██╔══╝██╔══██╗
██║  ██║██║   ██║   ██║   ██████╔╝
██║  ██║██║   ██║   ██║   ██╔══██╗
██████╔╝╚██████╔╝   ██║   ██║  ██║
╚═════╝  ╚═════╝    ╚═╝   ╚═╝  ╚═╝
"#;

pub fn run_cli(args: Cli) -> Result<(), anyhow::Error> {
    let mut working_dir = std::env::current_dir()?;
    if let Some(wd) = args.working_dir {
        working_dir = PathBuf::from(wd);
    }

    if !working_dir.exists() {
        anyhow::bail!("The specified working directory does not exist");
    }
    working_dir = working_dir.canonicalize()?;

    match args.command {
        Some(Command::Init(_)) => {
            println!("Initializing configuration...");
            Config::init(&working_dir)?;
            println!("Configuration initialized successfully.");
        }
        Some(Command::Import(args)) => {
            let (mut conf, ctx) = init_config(&working_dir, &args.profile, true)?;
            conf.import_package(&args, &ctx)?;
        }
        Some(Command::Deploy(args)) => {
            let (conf, mut ctx) = init_config(&working_dir, &args.profile, false)?;
            ctx.get_prompted_variables(&conf, &args.packages)?;
            conf.deploy_packages(&ctx, &args)?;
        }
        Some(Command::Update(args)) => {
            let (conf, mut ctx) = init_config(&working_dir, &args.profile, false)?;
            ctx.get_prompted_variables(&conf, &args.packages)?;
            conf.backup_packages(&ctx, &args)?;
        }
        Some(Command::Diff(args)) => {
            let (conf, mut ctx) = init_config(&working_dir, &args.profile, false)?;
            ctx.get_prompted_variables(&conf, &args.packages)?;
            conf.diff_packages(&ctx, &args)?;
        }
        Some(Command::PrintVars(args)) => {
            let (_, ctx) = init_config(&working_dir, &args.profile, false)?;
            ctx.print_variables();
        }
        Some(Command::Remove(args)) => {
            let (mut conf, ctx) = init_config(&working_dir, &args.profile, false)?;
            conf.remove_packages(&args, &ctx)?;
        }
        Some(Command::Packages(args)) => {
            let (mut conf, mut ctx) = init_config(&working_dir, &args.profile, false)?;
            match args.command {
                Some(PackagesCommand::List(args)) => {
                    conf.list_packages(&ctx, &args)?;
                }
                Some(PackagesCommand::Import(import_args)) => {
                    conf.import_package(&import_args, &ctx)?;
                }
                Some(PackagesCommand::Deploy(deploy_args)) => {
                    ctx.get_prompted_variables(&conf, &deploy_args.packages)?;
                    conf.deploy_packages(&ctx, &deploy_args)?;
                }
                Some(PackagesCommand::Update(update_args)) => {
                    ctx.get_prompted_variables(&conf, &update_args.packages)?;
                    conf.backup_packages(&ctx, &update_args)?;
                }
                Some(PackagesCommand::Diff(diff_args)) => {
                    ctx.get_prompted_variables(&conf, &diff_args.packages)?;
                    conf.diff_packages(&ctx, &diff_args)?;
                }
                Some(PackagesCommand::Remove(remove_args)) => {
                    conf.remove_packages(&remove_args, &ctx)?;
                }
                None => {
                    println!("No packages command provided. Use --help for more information.");
                }
            }
        }
        Some(Command::Profiles(args)) => {
            let (mut conf, mut ctx) = init_config(&working_dir, &None, false)?;
            match args.command {
                Some(ProfilesCommand::List(list_args)) => {
                    conf.list_profiles(&list_args)?;
                }
                Some(ProfilesCommand::Add(add_args)) => {
                    conf.add_profile(&add_args, &mut ctx)?;
                }
                Some(ProfilesCommand::Remove(remove_args)) => {
                    conf.remove_profile(&remove_args, &ctx)?;
                }
                None => {
                    println!("No profiles command provided. Use --help for more information.");
                }
            }
        }
        None => {
            println!("No command provided. Use --help for more information.");
        }
    }
    Ok(())
}

fn init_config(
    working_dir: &Path,
    profile: &Option<String>,
    create_if_missing: bool,
) -> anyhow::Result<(Config, Context)> {
    let mut conf = config::Config::from_path(working_dir)?;
    if conf.banner {
        println!("{}", BANNER);
    }
    let (ctx, profile_created) = Context::new(working_dir, &conf, profile, create_if_missing)?;
    if profile_created {
        conf.update_profiles(&ctx.profile, &ctx)?;
    }
    Ok((conf, ctx))
}