Skip to content

feat: add --no-prompt to upgrade #122

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
willemneal merged 1 commit into from
Jun 26, 2025
Merged

feat: add --no-prompt to upgrade #122

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions crates/stellar-scaffold-cli/src/arg_parsing.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,10 @@ pub enum Error {
ScAddress(#[from] sc_address::Error),
#[error(transparent)]
Config(#[from] config::Error),
// #[error("")]
// HelpMessage(String),
#[error(transparent)]
Dialoguer(#[from] dialoguer::Error),
#[error(transparent)]
Spec(#[from] soroban_spec_tools::contract::Error),
}

pub fn build_custom_cmd(name: &str, spec: &Spec) -> Result<clap::Command, Error> {
Expand Down Expand Up @@ -106,3 +108,6 @@ Each arg has a corresponding --<arg_name>-file-path which is a path to a file co
Note: The only types which aren't JSON are Bytes and BytesN, which are raw bytes"
)
}

mod parser;
pub use parser::*;
154 changes: 154 additions & 0 deletions crates/stellar-scaffold-cli/src/arg_parsing/parser.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,154 @@
use dialoguer::{Confirm, Input, Select};

use super::Error;

pub struct ArgParser {
skip_prompt: bool,
}

impl ArgParser {
pub fn get_constructor_args(
skip_prompt: bool,
contract_name: &str,
wasm: &[u8],
) -> Result<Option<String>, Error> {
let entries = soroban_spec_tools::contract::Spec::new(wasm)?.spec;
let spec = soroban_spec_tools::Spec::new(entries.clone());

// Check if constructor function exists
let Ok(func) = spec.find_function("__constructor") else {
return Ok(None);
};
if func.inputs.is_empty() {
return Ok(None);
}

// Build the custom command for the constructor
let cmd = super::build_custom_cmd("__constructor", &spec)?;
let parser = Self { skip_prompt };

println!("\n📋 Contract '{contract_name}' requires constructor arguments:");
let args = cmd
.get_arguments()
.filter(|arg| !arg.get_id().as_str().ends_with("-file-path"))
.filter_map(|arg| parser.handle_constructor_argument(arg).transpose())
.collect::<Result<Vec<_>, _>>()?
.join(" ");
Ok((!args.is_empty()).then_some(args))
}

fn handle_constructor_argument(&self, arg: &clap::Arg) -> Result<Option<String>, Error> {
let arg_name = arg.get_id().as_str();

let help_text = arg.get_long_help().or(arg.get_help()).map_or_else(
|| "No description available".to_string(),
ToString::to_string,
);

let value_name = arg
.get_value_names()
.map_or_else(|| "VALUE".to_string(), |names| names.join(" "));

// Display help text before the prompt
println!("\n --{arg_name}");
if value_name != "bool" && !help_text.is_empty() {
println!(" {help_text}");
}

if value_name == "bool" {
self.handle_bool_argument(arg_name)
} else if value_name.contains('|') && is_simple_enum(&value_name) {
self.handle_simple_enum_argument(arg_name, &value_name)
} else {
// For all other types (complex enums, structs, strings), use string input
self.handle_formatted_input(arg_name)
}
}

fn handle_formatted_input(&self, arg_name: &str) -> Result<Option<String>, Error> {
let input_result: String = if self.skip_prompt {
String::new()
} else {
Input::new()
.with_prompt(format!("Enter value for --{arg_name}"))
.allow_empty(true)
.interact()?
};

let value = input_result.trim();

let value = if value.is_empty() {
"# TODO: <Fill in value>"
} else {
// Check if the value is already quoted
let is_already_quoted = (value.starts_with('"') && value.ends_with('"'))
|| (value.starts_with('\'') && value.ends_with('\''));

// Only wrap in quotes if it's not already quoted and contains special characters or spaces
if !is_already_quoted
&& (value.contains(' ')
|| value.contains('{')
|| value.contains('[')
|| value.contains('"'))
{
&format!("'{value}'")
} else {
value
}
};
Ok(Some(format!("--{arg_name} {value}")))
}

fn handle_simple_enum_argument(
&self,
arg_name: &str,
value_name: &str,
) -> Result<Option<String>, Error> {
// Parse the values from "a | b | c" format and add numeric options
let values: Vec<_> = value_name.split('|').collect();

if self.skip_prompt {
return Ok(Some(format!(
"--{arg_name} TODO: Pick One <{}>",
values.join(" | ")
)));
}

let mut select = Select::new()
.with_prompt(format!("Select value for --{arg_name}"))
.default(0); // This will show the cursor on the first option initially

// Add "Skip" option
select = select.item("(Skip - leave blank)");

for value in &values {
select = select.item(format!("Value: {value}"));
}

let selection = select.interact()?;

Ok((selection > 0).then(|| {
// User selected an actual value (not skip)
let selected_value = values[selection - 1];
format!("--{arg_name} {selected_value}")
}))
}

fn handle_bool_argument(&self, arg_name: &str) -> Result<Option<String>, Error> {
if self.skip_prompt {
return Ok(Some(format!("TODO add or remove <--{arg_name}>")));
}
let bool_value = Confirm::new()
.with_prompt(format!("Set --{arg_name} to true?"))
.default(false)
.interact()?;
Ok(bool_value.then(|| format!("--{arg_name}")))
}
}

fn is_simple_enum(value_name: &str) -> bool {
value_name.split('|').all(|part| {
let trimmed = part.trim();
trimmed.parse::<i32>().is_ok() || trimmed.chars().all(|c| c.is_alphabetic() || c == '_')
})
}
151 changes: 8 additions & 143 deletions crates/stellar-scaffold-cli/src/commands/upgrade.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
use crate::arg_parsing::ArgParser;
use crate::commands::build::env_toml::{Account, Contract, Environment, Network};
use clap::Parser;
use degit::degit;
use dialoguer::{Confirm, Input, Select};
use indexmap::IndexMap;
use std::fs;
use std::fs::{create_dir_all, metadata, read_dir, write};
Expand All @@ -20,6 +20,9 @@ pub struct Cmd {
/// The path to the existing workspace (defaults to current directory)
#[arg(default_value = ".")]
pub workspace_path: PathBuf,
/// Skip the prompt to fill in constructor arguments
#[arg(long)]
pub skip_prompt: bool,
}

/// Errors that can occur during upgrade
Expand Down Expand Up @@ -47,8 +50,8 @@ pub enum Error {
TomlDeserializeError(#[from] toml::de::Error),
#[error(transparent)]
BuildError(#[from] build::Error),
#[error("Failed to get constructor arguments: {0}")]
ConstructorArgsError(String),
#[error("Failed to get constructor arguments: {0:?}")]
ConstructorArgsError(arg_parsing::Error),
#[error("WASM file not found for contract '{0}'. Please build the contract first.")]
WasmFileNotFound(String),
#[error(transparent)]
Expand Down Expand Up @@ -350,146 +353,8 @@ impl Cmd {

// Read the WASM file and get spec entries
let raw_wasm = fs::read(&wasm_path)?;
let entries = soroban_spec_tools::contract::Spec::new(&raw_wasm)?.spec;
let spec = soroban_spec_tools::Spec::new(entries.clone());

// Check if constructor function exists
let Ok(func) = spec.find_function("__constructor") else {
return Ok(None);
};
if func.inputs.is_empty() {
return Ok(None);
}

// Build the custom command for the constructor
let cmd = arg_parsing::build_custom_cmd("__constructor", &spec).map_err(|e| {
Error::ConstructorArgsError(format!("Failed to build constructor command: {e}"))
})?;

println!("\n📋 Contract '{contract_name}' requires constructor arguments:");

let mut args = Vec::new();

// Loop through the command arguments, skipping file args
for arg in cmd.get_arguments() {
let arg_name = arg.get_id().as_str();

// Skip file arguments (they end with -file-path)
if arg_name.ends_with("-file-path") {
continue;
}

if let Some(arg_value) = Self::handle_constructor_argument(arg)? {
args.push(arg_value);
}
}

Ok((!args.is_empty()).then(|| args.join(" ")))
}

fn handle_constructor_argument(arg: &clap::Arg) -> Result<Option<String>, Error> {
let arg_name = arg.get_id().as_str();

let help_text = arg.get_long_help().or(arg.get_help()).map_or_else(
|| "No description available".to_string(),
ToString::to_string,
);

let value_name = arg
.get_value_names()
.map_or_else(|| "VALUE".to_string(), |names| names.join(" "));

// Display help text before the prompt
println!("\n --{arg_name}");
if value_name != "bool" && !help_text.is_empty() {
println!(" {help_text}");
}

if value_name == "bool" {
Self::handle_bool_argument(arg_name)
} else if value_name.contains('|') && Self::is_simple_enum(&value_name) {
Self::handle_simple_enum_argument(arg_name, &value_name)
} else {
// For all other types (complex enums, structs, strings), use string input
Self::handle_formatted_input(arg_name)
}
}

fn is_simple_enum(value_name: &str) -> bool {
value_name.split('|').all(|part| {
let trimmed = part.trim();
trimmed.parse::<i32>().is_ok() || trimmed.chars().all(|c| c.is_alphabetic() || c == '_')
})
}

fn handle_formatted_input(arg_name: &str) -> Result<Option<String>, Error> {
let input_result: Result<String, _> = Input::new()
.with_prompt(format!("Enter value for --{arg_name}"))
.allow_empty(true)
.interact();

let value = input_result
.as_deref()
.map(str::trim)
.map_err(|e| Error::ConstructorArgsError(format!("Input error: {e}")))?;

let value = if value.is_empty() {
"# TODO: Fill in value"
} else {
// Check if the value is already quoted
let is_already_quoted = (value.starts_with('"') && value.ends_with('"'))
|| (value.starts_with('\'') && value.ends_with('\''));

// Only wrap in quotes if it's not already quoted and contains special characters or spaces
if !is_already_quoted
&& (value.contains(' ')
|| value.contains('{')
|| value.contains('[')
|| value.contains('"'))
{
&format!("'{value}'")
} else {
value
}
};
Ok(Some(format!("--{arg_name} {value}")))
}

fn handle_simple_enum_argument(
arg_name: &str,
value_name: &str,
) -> Result<Option<String>, Error> {
let mut select = Select::new()
.with_prompt(format!("Select value for --{arg_name}"))
.default(0); // This will show the cursor on the first option initially

// Add "Skip" option
select = select.item("(Skip - leave blank)");

// Parse the values from "a | b | c" format and add numeric options
let values: Vec<_> = value_name.split('|').collect();
for value in &values {
select = select.item(format!("Value: {value}"));
}

let selection = select
.interact()
.map_err(|e| Error::ConstructorArgsError(format!("Input error: {e}")))?;

Ok((selection > 0).then(|| {
// User selected an actual value (not skip)
let selected_value = values[selection - 1];
format!("--{arg_name} {selected_value}")
}))
}

fn handle_bool_argument(arg_name: &str) -> Result<Option<String>, Error> {
let bool_value = Confirm::new()
.with_prompt(format!("Set --{arg_name} to true?"))
.default(false)
.interact()
.map_err(|e| Error::ConstructorArgsError(format!("Input error: {e}")))?;
Ok(bool_value.then(|| format!("--{arg_name}")))
ArgParser::get_constructor_args(self.skip_prompt, contract_name, &raw_wasm)
.map_err(Error::ConstructorArgsError)
}

fn setup_env_file(&self) -> Result<(), Error> {
Expand Down