refactor: rename setup command to link

- Rename `coffee setup` command to `coffee link`
- Change function names from `setup_*` to `link_*` (e.g., `setup_with_cln` to `link_with_cln`)
- Update command references in `httpd` and `plugin` crates
- Modify relevant documentation to reflect the command name change

This refactor is to accommodate the addition of a new `unlink` command.

Signed-off-by: Tarek <[email protected]>

Author: tareknaser

coffee_cmd/src/cmd.rs

@@ -26,6 +26,10 @@ pub struct CoffeeArgs {
 /// Coffee subcommand of the command line daemon.
 #[derive(Debug, Subcommand)]
 pub enum CoffeeCommand {
+    /// Configure coffee with the core lightning
+    /// configuration
+    #[clap(arg_required_else_help = true)]
+    Link { cln_conf: String },
     /// Install a single by name.
     #[clap(arg_required_else_help = true)]
     Install {
@@ -56,10 +60,6 @@ pub enum CoffeeCommand {
         #[arg(name = "remote-name", help = "The name of the remote repository")]
         name: Option<String>,
     },
-    /// Configure coffee with the core lightning
-    /// configuration
-    #[clap(arg_required_else_help = true)]
-    Setup { cln_conf: String },
     /// show the README file of the plugin
     #[clap(arg_required_else_help = true)]
     Show { plugin: String },
@@ -99,14 +99,14 @@ pub enum RemoteAction {
 impl From<&CoffeeCommand> for coffee_core::CoffeeOperation {
     fn from(value: &CoffeeCommand) -> Self {
         match value {
+            CoffeeCommand::Link { cln_conf } => Self::Link(cln_conf.to_owned()),
             CoffeeCommand::Install {
                 plugin,
                 verbose,
                 dynamic,
             } => Self::Install(plugin.to_owned(), *verbose, *dynamic),
             CoffeeCommand::Upgrade { repo, verbose } => Self::Upgrade(repo.to_owned(), *verbose),
             CoffeeCommand::List {} => Self::List,
-            CoffeeCommand::Setup { cln_conf } => Self::Setup(cln_conf.to_owned()),
             CoffeeCommand::Remote { action, name } => {
                 if let Some(action) = action {
                     return Self::Remote(Some(action.into()), name.clone());

coffee_cmd/src/main.rs

@@ -16,6 +16,11 @@ use crate::cmd::RemoteAction;
 
 async fn run(args: CoffeeArgs, mut coffee: CoffeeManager) -> Result<(), CoffeeError> {
     match args.command {
+        CoffeeCommand::Link { cln_conf } => {
+            // FIXME: read the core lightning config
+            // and the coffee script
+            coffee.link(&cln_conf).await?;
+        }
         CoffeeCommand::Install {
             plugin,
             verbose,
@@ -134,11 +139,6 @@ async fn run(args: CoffeeArgs, mut coffee: CoffeeManager) -> Result<(), CoffeeEr
                 }
             }
         }
-        CoffeeCommand::Setup { cln_conf } => {
-            // FIXME: read the core lightning config
-            // and the coffee script
-            coffee.setup(&cln_conf).await?;
-        }
         CoffeeCommand::Show { plugin } => {
             let val = coffee.show(&plugin).await?;
 

coffee_core/src/coffee.rs

@@ -228,7 +228,7 @@ impl CoffeeManager {
         Ok(())
     }
 
-    pub async fn setup_with_cln(&mut self, cln_dir: &str) -> Result<(), CoffeeError> {
+    pub async fn link_with_cln(&mut self, cln_dir: &str) -> Result<(), CoffeeError> {
         if self.cln_config.is_some() {
             log::warn!("you are overriding the previous set up");
         }
@@ -417,8 +417,8 @@ impl PluginManager for CoffeeManager {
         Ok(status)
     }
 
-    async fn setup(&mut self, cln_dir: &str) -> Result<(), CoffeeError> {
-        self.setup_with_cln(cln_dir).await?;
+    async fn link(&mut self, cln_dir: &str) -> Result<(), CoffeeError> {
+        self.link_with_cln(cln_dir).await?;
         log::info!("cln configured");
         self.flush().await?;
         Ok(())

coffee_core/src/lib.rs

@@ -7,6 +7,8 @@ pub use coffee_lib as lib;
 
 #[derive(Clone, Debug)]
 pub enum CoffeeOperation {
+    /// Link coffee to the lightning configuration file
+    Link(String),
     /// Install(plugin name, verbose run, dynamic installation)
     Install(String, bool, bool),
     /// List
@@ -16,8 +18,6 @@ pub enum CoffeeOperation {
     Remove(String),
     /// Remote(name repository, url of the repository)
     Remote(Option<RemoteAction>, Option<String>),
-    /// Setup(core lightning root path)
-    Setup(String),
     Show(String),
     /// Search(plugin name)
     Search(String),

coffee_httpd/src/main.rs

@@ -13,7 +13,7 @@ async fn main() -> Result<(), CoffeeError> {
     env_logger::init();
     let cmd = cmd::HttpdArgs::parse();
     let mut coffee = CoffeeManager::new(&cmd).await?;
-    coffee.setup(&cmd.cln_path).await?;
+    coffee.link(&cmd.cln_path).await?;
 
     let port = cmd.port.unwrap_or(8080) as u16;
     log::info!("Running on port 127.0.0.1:{port}");

coffee_lib/src/plugin_manager.rs

@@ -39,9 +39,8 @@ pub trait PluginManager {
     /// List the plugins available in a remote repository.
     async fn get_plugins_in_remote(&self, name: &str) -> Result<CoffeeList, CoffeeError>;
 
-    /// set up the core lightning configuration target for the
-    /// plugin manager.
-    async fn setup(&mut self, cln_conf_path: &str) -> Result<(), CoffeeError>;
+    /// Link coffee to CLN configuration file
+    async fn link(&mut self, cln_conf_path: &str) -> Result<(), CoffeeError>;
 
     /// show the README file of the plugin
     async fn show(&mut self, plugin: &str) -> Result<CoffeeShow, CoffeeError>;

coffee_plugin/src/plugin/plugin_mod.rs

@@ -64,7 +64,7 @@ fn on_init(plugin: &mut Plugin<State>) -> Value {
         }
         let coffee = coffee.unwrap();
         plugin.state.set_coffee(coffee);
-        plugin.state.setup().await
+        plugin.state.link().await
     });
 
     if let Err(err) = result {

coffee_plugin/src/plugin/state.rs

@@ -41,11 +41,11 @@ impl State {
         self.args.clone().unwrap()
     }
 
-    pub async fn setup(&self) -> Result<(), CoffeeError> {
+    pub async fn link(&self) -> Result<(), CoffeeError> {
         self.coffee()
             .lock()
             .unwrap()
-            .setup(&self.args.clone().unwrap().conf)
+            .link(&self.args.clone().unwrap().conf)
             .await?;
         Ok(())
     }

docs/docs-book/src/introduction.md

@@ -37,7 +37,7 @@ In fact, you can install a Java plugin that supports Coffee in a couple of
 commands after you [install it](./install-coffee.md)
 
 ```bash
-coffee --network testnet setup /home/alice/.lightning
+coffee --network testnet link /home/alice/.lightning
 coffee --network testnet remote add lightningd https://github.com/lightningd/plugins.git
 coffee --network testnet install btcli4j
 ```

docs/docs-book/src/using-coffee.md

@@ -18,7 +18,7 @@ By default the Core Lightning home is stored in the `/home/<user>/.lightning`,
 and you can do it with the following command
 
 ```bash
-coffee setup /home/alice/.lightning
+coffee link /home/alice/.lightning
 ```
 
 Then you will find an include at the end of the config file at

tests/src/coffee_integration_tests.rs

@@ -81,7 +81,7 @@ pub async fn init_coffee_test_with_cln() -> anyhow::Result<()> {
     let lightning_dir = lightning_dir.strip_suffix("/regtest").unwrap();
     log::info!("lightning path: {lightning_dir}");
 
-    manager.coffee().setup(&lightning_dir).await?;
+    manager.coffee().link(&lightning_dir).await?;
 
     Ok(())
 }
@@ -103,7 +103,7 @@ pub async fn init_coffee_test_add_remote() {
     let lightning_dir = lightning_dir.strip_suffix("/regtest").unwrap();
     log::info!("lightning path: {lightning_dir}");
 
-    manager.coffee().setup(&lightning_dir).await.unwrap();
+    manager.coffee().link(&lightning_dir).await.unwrap();
 
     manager
         .coffee()
@@ -135,7 +135,7 @@ pub async fn test_add_remove_plugins() {
     let lightning_dir = lightning_dir.strip_suffix("/regtest").unwrap();
     log::info!("lightning path: {lightning_dir}");
 
-    manager.coffee().setup(&lightning_dir).await.unwrap();
+    manager.coffee().link(&lightning_dir).await.unwrap();
     // Add lightningd remote repository
     let repo_name = "lightningd";
     let repo_url = "https://github.com/lightningd/plugins.git";
@@ -254,7 +254,7 @@ pub async fn test_errors_and_show() {
     let lightning_dir = lightning_dir.strip_suffix("/regtest").unwrap();
     log::info!("lightning path: {lightning_dir}");
 
-    manager.coffee().setup(&lightning_dir).await.unwrap();
+    manager.coffee().link(&lightning_dir).await.unwrap();
     // Add lightningd remote repository
     let repo_name = "lightningd";
     let repo_url = "https://github.com/lightningd/plugins.git";
@@ -341,7 +341,7 @@ pub async fn install_plugin_in_two_networks() -> anyhow::Result<()> {
         network: "regtest".to_string(),
     };
     let mut manager = CoffeeTesting::tmp_with_args(&args, dir.clone()).await?;
-    let result = manager.coffee().setup(&lightning_regtest_dir).await;
+    let result = manager.coffee().link(&lightning_regtest_dir).await;
     assert!(result.is_ok(), "{:?}", result);
     // Add lightningd remote repository
     manager
@@ -378,11 +378,7 @@ pub async fn install_plugin_in_two_networks() -> anyhow::Result<()> {
     let mut manager = CoffeeTesting::tmp_with_args(&new_args, dir.clone()).await?;
     let new_root_path = manager.root_path().to_owned();
     assert_eq!(dir.path(), new_root_path.path());
-    manager
-        .coffee()
-        .setup(&lightning_testnet_dir)
-        .await
-        .unwrap();
+    manager.coffee().link(&lightning_testnet_dir).await.unwrap();
 
     let result = manager
         .coffee()
@@ -416,7 +412,7 @@ pub async fn test_double_slash() {
     let lightning_dir = cln.rpc().getinfo().unwrap().ligthning_dir;
     let lightning_dir = lightning_dir.strip_suffix("/regtest").unwrap();
     log::info!("lightning path: {lightning_dir}");
-    manager.coffee().setup(&lightning_dir).await.unwrap();
+    manager.coffee().link(&lightning_dir).await.unwrap();
 
     // Add lightningd remote repository
     let repo_name = "lightningd";
@@ -481,7 +477,7 @@ pub async fn test_plugin_installation_path() {
     let lightning_dir = lightning_dir.strip_suffix("/regtest").unwrap();
     log::info!("lightning path: {lightning_dir}");
 
-    manager.coffee().setup(&lightning_dir).await.unwrap();
+    manager.coffee().link(&lightning_dir).await.unwrap();
 
     // Add lightningd remote repository
     manager
@@ -589,7 +585,7 @@ pub async fn test_nurse_repository_missing_on_disk() {
     let lightning_dir = lightning_dir.strip_suffix("/regtest").unwrap();
     log::info!("lightning path: {lightning_dir}");
 
-    manager.coffee().setup(&lightning_dir).await.unwrap();
+    manager.coffee().link(&lightning_dir).await.unwrap();
 
     // Construct the root path
     let root_path = manager