changesette 2.0.0

A version and changelog manager for single-package applications, using the changesets file format
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

use std::{
    fs,
    io::{self, IsTerminal, Write},
    path::Path,
};

use anyhow::{Context, Result, bail, ensure};
use saphyr::{Mapping, Scalar, Yaml, YamlEmitter};
use ulid::Ulid;

use crate::{bump::Bump, package_json::PackageJson};

/// Creates a changeset file under `.changeset/` and prints its path to
/// stdout; the directory must already exist (see `init`). Inputs missing from
/// the flags are prompted for interactively when both stdin and stderr are
/// terminals; otherwise the missing flags are reported as an error.
pub(crate) fn run(bump: Option<Bump>, summary: Option<String>) -> Result<()> {
    let package_json = PackageJson::load(Path::new("."))?;

    let changeset_dir = Path::new(".changeset");
    ensure!(
        changeset_dir.is_dir(),
        "{}: changeset directory not found; run `changesette init` to create it",
        changeset_dir.display()
    );

    if let Some(summary) = &summary {
        ensure!(!summary.trim().is_empty(), "the summary must not be empty");
    }

    if !(io::stdin().is_terminal() && io::stderr().is_terminal()) {
        let mut missing = Vec::new();
        if bump.is_none() {
            missing.push("--bump");
        }
        if summary.is_none() {
            missing.push("--message");
        }
        if !missing.is_empty() {
            bail!(
                "missing required flags in non-interactive mode: {}",
                missing.join(", ")
            );
        }
    }

    let bump = match bump {
        Some(bump) => bump,
        None => prompt_bump()?,
    };
    let summary = match summary {
        Some(summary) => summary,
        None => prompt_summary()?,
    };

    let path = changeset_dir.join(format!("changesette-{}.md", Ulid::generate()));
    let mut mapping = Mapping::new();
    mapping.insert(
        Yaml::Value(Scalar::String(package_json.name().into())),
        Yaml::Value(Scalar::String(bump.as_str().into())),
    );
    let mut frontmatter = String::new();
    YamlEmitter::new(&mut frontmatter).dump(&Yaml::Mapping(mapping))?;
    let content = format!("{}\n---\n\n{}\n", frontmatter, summary.trim());
    fs::OpenOptions::new()
        .write(true)
        .create_new(true)
        .open(&path)
        .and_then(|mut file| file.write_all(content.as_bytes()))
        .with_context(|| path.display().to_string())?;
    println!("{}", path.display());
    Ok(())
}

fn prompt_bump() -> Result<Bump> {
    const ITEMS: [Bump; 3] = [Bump::Patch, Bump::Minor, Bump::Major];
    let index = dialoguer::Select::new()
        .with_prompt("Bump type")
        .items(ITEMS.map(Bump::as_str))
        .default(0)
        .interact()?;
    Ok(ITEMS[index])
}

fn prompt_summary() -> Result<String> {
    let input: String = dialoguer::Input::new()
        .with_prompt("Summary (leave empty to open your editor)")
        .allow_empty(true)
        .interact_text()?;
    if !input.trim().is_empty() {
        return Ok(input);
    }
    let edited = dialoguer::Editor::new()
        .edit("")
        .context("failed to edit the summary")?;
    match edited {
        Some(text) if !text.trim().is_empty() => Ok(text),
        _ => bail!("the summary must not be empty"),
    }
}