feat: Implement print plan and basic checks for publish command

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## 0.3.5
+
+### Enhancements
+* Allow error on no changes detected
+* List crates to be published
+* Add dry-run mode for publishing
+
 ## 0.3.4
 
 ### Bug Fixes

README.md

@@ -20,6 +20,7 @@ But this will also work on single crates because by default every individual cra
       1. [Fixed or Independent](#fixed-or-independent)
    7. [Publish](#publish)
    8. [Rename](#rename)
+   9. [Plan](#plan)
 3. [Config](#config)
 4. [Changelog](#changelog)
 
@@ -83,8 +84,10 @@ USAGE:
     cargo workspaces list [OPTIONS]
 
 OPTIONS:
-    -a, --all     Show private crates that are normally hidden
     -h, --help    Print help information
+
+LIST OPTIONS:
+    -a, --all     Show private crates that are normally hidden
         --json    Show information as a JSON array
     -l, --long    Show extended information
 ```
@@ -105,15 +108,17 @@ USAGE:
     cargo workspaces changed [OPTIONS]
 
 OPTIONS:
-    -a, --all                         Show private crates that are normally hidden
         --error-on-empty              Return non-zero exit code if no changes detected
         --force <pattern>             Always include targeted crates matched by glob even when there are no changes
     -h, --help                        Print help information
         --ignore-changes <pattern>    Ignore changes in files matched by glob
         --include-merged-tags         Include tags from merged branches
-        --json                        Show information as a JSON array
-    -l, --long                        Show extended information
         --since <SINCE>               Use this git reference instead of the last tag
+
+LIST OPTIONS:
+    -a, --all     Show private crates that are normally hidden
+        --json    Show information as a JSON array
+    -l, --long    Show extended information
 ```
 
 ### Exec
@@ -216,8 +221,8 @@ OPTIONS:
     -h, --help    Print help information
 
 VERSION ARGS:
-    <BUMP>      Increment all versions by the given explicit semver keyword while skipping the prompts for them [possible values: major, minor, patch,
-                premajor, preminor, prepatch, prerelease, custom]
+    <BUMP>      Increment all versions by the given explicit semver keyword while skipping the prompts for them
+                [possible values: major, minor, patch, premajor, preminor, prepatch, skip, prerelease, custom]
     <CUSTOM>    Specify custom version value when 'bump' is set to 'custom'
 
 VERSION OPTIONS:
@@ -244,11 +249,14 @@ GIT OPTIONS:
 
 PUBLISH OPTIONS:
         --allow-dirty            Allow dirty working directories to be published
+        --dry-run                Runs in dry-run mode
         --no-remove-dev-deps     Don't remove dev-dependencies while publishing
         --no-verify              Skip crate verification (not recommended)
         --publish-as-is          Publish crates from the current commit without versioning
-        --registry <REGISTRY>    The Cargo registry to use for publishing
-        --token <TOKEN>          The token to use for publishing
+
+REGISTRY OPTIONS:
+        --registry <REGISTRY>    The Cargo registry to use
+        --token <TOKEN>          The token to use for accessing the registry
 ```
 
 ### Rename
@@ -269,6 +277,27 @@ OPTIONS:
         --ignore <pattern>    Ignore the crates matched by glob
 ```
 
+### Plan
+
+List the crates in publishing order. This does not check for changes or try to version. It takes the crates as-is.
+
+```
+USAGE:
+    cargo workspaces plan [OPTIONS]
+
+OPTIONS:
+    -h, --help              Print help information
+        --skip-published    Skip already published crate versions
+
+REGISTRY OPTIONS:
+        --registry <REGISTRY>    The Cargo registry to use
+        --token <TOKEN>          The token to use for accessing the registry
+
+LIST OPTIONS:
+        --json    Show information as a JSON array
+    -l, --long    Show extended information
+```
+
 ## Config
 
 There are two kind of options.

cargo-workspaces/Cargo.toml

@@ -43,6 +43,7 @@ tame-index = { version = "0.9.0", features = ["git", "sparse"] }
 dunce = "1.0.4"
 ctrlc = "3.4.1"
 toml_edit = "0.19.10"
+url = "2.5.2"
 
 [dev-dependencies]
 assert_cmd = "1.0"

cargo-workspaces/src/changed.rs

@@ -58,6 +58,6 @@ impl Changed {
             return Err(Error::NoChanges);
         }
 
-        return Ok(());
+        Ok(())
     }
 }

cargo-workspaces/src/exec.rs

@@ -1,4 +1,4 @@
-use crate::utils::{dag, info, is_private, Error, Result, INTERNAL_ERR};
+use crate::utils::{dag, filter_private, info, Error, Result, INTERNAL_ERR};
 
 use cargo_metadata::Metadata;
 use clap::Parser;
@@ -34,7 +34,11 @@ impl Exec {
             .map(|x| (x.clone(), x.version.to_string()))
             .collect::<Vec<_>>();
 
-        let (names, visited) = dag(&pkgs);
+        let (names, mut visited) = dag(&pkgs);
+
+        if self.ignore_private {
+            visited = filter_private(visited, &pkgs);
+        }
 
         let ignore = self
             .ignore
@@ -45,10 +49,6 @@ impl Exec {
         for p in &visited {
             let (pkg, _) = names.get(p).expect(INTERNAL_ERR);
 
-            if self.ignore_private && is_private(pkg) {
-                continue;
-            }
-
             if let Some(pattern) = &ignore {
                 if pattern.compile_matcher().is_match(&pkg.name) {
                     continue;

cargo-workspaces/src/list.rs

@@ -22,8 +22,7 @@ impl List {
 
         let pkg_ids = visited
             .into_iter()
-            .map(|p| names.get(&p).expect(INTERNAL_ERR).0.id.clone())
-            .collect::<Vec<_>>();
+            .map(|p| names.get(&p).expect(INTERNAL_ERR).0.id.clone());
 
         let pkgs = get_pkgs(&metadata, self.list.all)?;
 

cargo-workspaces/src/main.rs

@@ -3,6 +3,7 @@ mod create;
 mod exec;
 mod init;
 mod list;
+mod plan;
 mod publish;
 mod rename;
 mod version;
@@ -24,6 +25,7 @@ enum Subcommand {
     Create(create::Create),
     Rename(rename::Rename),
     Init(init::Init),
+    Plan(plan::Plan),
 }
 
 #[derive(Debug, Parser)]
@@ -83,6 +85,7 @@ fn main() {
             Subcommand::Exec(x) => x.run(metadata),
             Subcommand::Create(x) => x.run(metadata),
             Subcommand::Rename(x) => x.run(metadata),
+            Subcommand::Plan(x) => x.run(metadata),
             _ => unreachable!(),
         }
     };

cargo-workspaces/src/plan.rs

@@ -0,0 +1,70 @@
+use crate::utils::{
+    create_http_client, dag, filter_private, get_pkgs, is_published, list, package_registry,
+    ListOpt, ListPublicOpt, RegistryOpt, Result, INTERNAL_ERR,
+};
+
+use cargo_metadata::Metadata;
+use clap::Parser;
+
+/// List the crates in publishing order
+#[derive(Debug, Parser)]
+pub struct Plan {
+    /// Skip already published crate versions
+    #[clap(long)]
+    skip_published: bool,
+
+    #[clap(flatten)]
+    registry: RegistryOpt,
+
+    #[clap(flatten)]
+    list: ListPublicOpt,
+}
+
+impl Plan {
+    pub fn run(self, metadata: Metadata) -> Result {
+        let pkgs = metadata
+            .packages
+            .iter()
+            .map(|x| (x.clone(), x.version.to_string()))
+            .collect::<Vec<_>>();
+
+        let (names, visited) = dag(&pkgs);
+
+        let http_client = create_http_client(&metadata.workspace_root, &self.registry.token)?;
+
+        let pkg_ids = filter_private(visited, &pkgs)
+            .into_iter()
+            .map(|p| {
+                let (pkg, version) = names.get(&p).expect(INTERNAL_ERR);
+
+                let published = if self.skip_published {
+                    let index_url =
+                        package_registry(&metadata, self.registry.registry.as_ref(), pkg)?;
+                    is_published(&http_client, index_url, &pkg.name, version)?
+                } else {
+                    false
+                };
+
+                Ok((pkg.id.clone(), published))
+            })
+            .collect::<Result<Vec<_>>>()?
+            .into_iter()
+            .filter_map(|(id, published)| (!published).then_some(id));
+
+        let pkgs = get_pkgs(&metadata, false)?;
+
+        let ordered_pkgs = pkg_ids
+            .into_iter()
+            .filter_map(|id| pkgs.iter().find(|p| p.id == id))
+            .cloned()
+            .collect::<Vec<_>>();
+
+        list(
+            &ordered_pkgs,
+            ListOpt {
+                all: false,
+                list: self.list,
+            },
+        )
+    }
+}