fix: CreateChangeFile (like knope document-change) now prints package names. (#669)

Closes #634

Co-authored-by: Dylan Anthony <[email protected]>

Author: dbanty

docs/src/content/docs/tutorials/releasing-multiple-packages.mdx

@@ -227,19 +227,19 @@ Knope will ask which packages the change impacts:
 
 ```text
 ? Which packages does this change affect?
-> [ ] pizza
+  [x] pizza
   [ ] toppings
-  [ ] calzone
+> [x] calzone
 [↑↓ to move, space to select one, → to all, ← to none, type to filter]
 ```
 
 Use the arrow keys and space bar to select `pizza` and `calzone`, then press enter.
-Next, select `patch` as the change type for each (they're in order):
+Next, select `patch` as the change type for each:
 
 ```text
 > Which packages does this change affect? pizza, calzone
-> What type of change is this? patch
-? What type of change is this?
+> What type of change is this for pizza? patch
+? What type of change is this for calzone?
   major
   minor
 > patch
@@ -250,8 +250,8 @@ Finally, summarize the change:
 
 ```text
 > Which packages does this change affect? pizza, calzone
-> What type of change is this? patch
-> What type of change is this? patch
+> What type of change is this for pizza? patch
+> What type of change is this for calzone? patch
 ? What is a short summary of this change? The cheese is now distributed more evenly
 [This will be used as a header in the changelog]
 ```
@@ -260,8 +260,8 @@ This will create a change file that looks like this:
 
 ```md title=".changeset/the_cheese_is_now_distributed_more_evenly.md"
 ---
-calzone: patch
 pizza: patch
+calzone: patch
 ---
 
 # The cheese is now distributed more evenly

src/step/releases/changesets.rs

@@ -31,7 +31,7 @@ pub(crate) fn create_change_file(run_type: RunType) -> Result<RunType, Error> {
     let versioning = packages
         .into_iter()
         .map(|package| {
-            let package_name = package.to_string();
+            let package_name = package.name;
             let change_types = package
                 .changelog_sections
                 .into_keys()
@@ -43,11 +43,21 @@ pub(crate) fn create_change_file(run_type: RunType) -> Result<RunType, Error> {
                     }
                 })
                 .collect_vec();
-            Select::new("What type of change is this?", change_types)
+            let prompt = if let Some(package_name) = package_name.as_ref() {
+                format!("What type of change is this for {package_name}?")
+            } else {
+                "What type of change is this?".to_string()
+            };
+            Select::new(&prompt, change_types)
                 .prompt()
                 .map_err(prompt::Error::from)
                 .map_err(Error::from)
-                .map(|change_type| (package_name, change_type.into()))
+                .map(|change_type| {
+                    (
+                        package_name.unwrap_or_default().to_string(),
+                        change_type.into(),
+                    )
+                })
         })
         .collect::<Result<Versioning, Error>>()?;
     let summary = inquire::Text::new("What is a short summary of this change?")

src/step/releases/package.rs

@@ -164,6 +164,12 @@ impl Display for Package {
 #[serde(transparent)]
 pub(crate) struct PackageName(String);
 
+impl Default for PackageName {
+    fn default() -> Self {
+        Self(DEFAULT_CHANGESET_PACKAGE_NAME.to_string())
+    }
+}
+
 impl Display for PackageName {
     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
         self.0.fmt(f)