changesette 6.1.0

A version and changelog manager 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
101
102
103
104
105
106

use std::{collections::BTreeSet, path::Path};

use anyhow::{Context, Result, bail};
use tracing::debug;

use crate::{
    changeset::LoadedChange,
    config::Config,
    output::display_path,
    workspace::{Member, Workspace},
};

/// The names of the workspace members `version` skips.
pub(crate) struct SkipSet {
    names: BTreeSet<String>,
}

impl SkipSet {
    /// Collects the members skipped as private or ignored, resolving the
    /// ignore names from the config or `cli_ignore` (using both is an
    /// error).
    pub(crate) fn load(
        workspace: &Workspace,
        config: &Config,
        cli_ignore: &[String],
    ) -> Result<SkipSet> {
        let ignore = if config.has_ignore() {
            if !cli_ignore.is_empty() {
                bail!(
                    "the --ignore option cannot be used while ignore is defined in .changeset/config.json; use only one of them"
                );
            }
            config.resolve_ignore(workspace.members().iter().map(Member::name))
        } else {
            for name in cli_ignore {
                workspace.member(name).context("invalid `--ignore` value")?;
            }
            cli_ignore.to_vec()
        };
        let mut names = BTreeSet::new();
        for member in workspace.members() {
            if ignore.iter().any(|name| name == member.name()) {
                debug!("`{}` is skipped: ignored", member.name());
            } else if member.private() && !config.private_packages_version {
                debug!("`{}` is skipped: private", member.name());
            } else {
                continue;
            }
            names.insert(member.name().to_owned());
        }
        Ok(SkipSet { names })
    }

    pub(crate) fn contains(&self, name: &str) -> bool {
        self.names.contains(name)
    }

    /// Returns the changesets in `changes` whose releases are not all
    /// skipped; a changeset mixing skipped and not skipped packages is an
    /// error, as is one naming a non-member package.
    pub(crate) fn filter_changes(
        &self,
        workspace: &Workspace,
        changeset_dir: &Path,
        changes: &[LoadedChange],
    ) -> Result<Vec<LoadedChange>> {
        // Membership is checked before the skip judgment so that a changeset
        // naming an unknown package always reports that rather than a
        // mixed-changeset error.
        for change in changes {
            for (name, _) in &change.releases {
                workspace
                    .member(name)
                    .with_context(|| display_path(&changeset_dir.join(change.rel_path())))?;
            }
        }

        let mut consumed = Vec::new();
        for change in changes {
            let (skipped, not_skipped): (Vec<&str>, Vec<&str>) = change
                .releases
                .iter()
                .map(|(name, _)| name.as_str())
                .partition(|name| self.contains(name));
            if skipped.is_empty() {
                consumed.push(change.clone());
            } else if !not_skipped.is_empty() {
                bail!(
                    "{}: cannot mix skipped packages ({}) and not skipped packages ({})",
                    display_path(&changeset_dir.join(change.rel_path())),
                    quote_list(&skipped),
                    quote_list(&not_skipped)
                );
            }
        }
        Ok(consumed)
    }
}

fn quote_list(names: &[&str]) -> String {
    names
        .iter()
        .map(|name| format!("`{name}`"))
        .collect::<Vec<_>>()
        .join(", ")
}