chore: Make commands module

Signed-off-by: Awiteb <a@4rs.nl>
This commit is contained in:
Awiteb
2025-05-23 13:15:37 +00:00
parent 226909ef16
commit 15c0eaa5dc
8 changed files with 119 additions and 90 deletions

111
src/cli/commands/mod.rs Normal file
View File

@@ -0,0 +1,111 @@
// n34 - A CLI to interact with NIP-34 and other stuff related to codes in nostr
// Copyright (C) 2025 Awiteb <a@4rs.nl>
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <https://gnu.org/licenses/gpl-3.0.html>.
/// `issue` subcommands
mod issue;
/// 'reply` command
mod reply;
/// `repo` subcommands
mod repo;
use std::fmt;
use clap::{ArgGroup, Args, Parser};
use nostr::key::{Keys, PublicKey, SecretKey};
use nostr::types::RelayUrl;
use self::issue::IssueSubcommands;
use self::reply::ReplyArgs;
use self::repo::RepoSubcommands;
use super::traits::CommandRunner;
use crate::error::N34Result;
/// The command-line interface options
#[derive(Args, Clone)]
#[clap(
group(
ArgGroup::new("auth")
.args(&["secret_key"])
.required(true)
)
)]
pub struct CliOptions {
/// Your Nostr secret key
#[arg(short, long)]
pub secret_key: Option<SecretKey>,
/// Where your relays list. And repository relays if not included in naddr
#[arg(short, long, required = true)]
pub relays: Vec<RelayUrl>,
/// Proof of Work difficulty when creatring events
#[arg(long, default_value_t = 0)]
pub pow: u8,
}
/// N34 commands
#[derive(Parser, Debug)]
pub enum Commands {
/// Manage repositories
Repo {
#[command(subcommand)]
subcommands: RepoSubcommands,
},
/// Manage issues
Issue {
#[command(subcommand)]
subcommands: IssueSubcommands,
},
// /// Manage patches
// Patch {
// #[command(subcommand)]
// subcommands: PatchSubcommands,
// },
/// Reply to issues and patches.
Reply(ReplyArgs),
}
impl CommandRunner for Commands {
async fn run(self, options: CliOptions) -> N34Result<()> {
tracing::trace!("Options: {options:#?}");
tracing::trace!("Handling: {self:#?}");
match self {
Self::Repo { subcommands } => subcommands.run(options).await,
Self::Issue { subcommands } => subcommands.run(options).await,
Commands::Reply(args) => args.run(options).await,
}
}
}
impl CliOptions {
/// Gets the public key of the user.
pub async fn pubkey(&self) -> N34Result<PublicKey> {
if let Some(sk) = &self.secret_key {
return Ok(Keys::new(sk.clone()).public_key());
}
unreachable!("There is no other method until now")
}
}
impl fmt::Debug for CliOptions {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("CliOptions")
.field("secret_key", &self.secret_key.as_ref().map(|_| "*******"))
.field("relays", &self.relays)
.finish()
}
}

View File

@@ -24,8 +24,9 @@ use nostr::{
types::RelayUrl, types::RelayUrl,
}; };
use super::{CliOptions, CommandRunner, parsers}; use super::{CliOptions, CommandRunner};
use crate::{ use crate::{
cli::parsers,
error::{N34Error, N34Result}, error::{N34Error, N34Result},
nostr_utils::{NostrClient, utils}, nostr_utils::{NostrClient, utils},
}; };

View File

@@ -14,27 +14,17 @@
// You should have received a copy of the GNU General Public License // You should have received a copy of the GNU General Public License
// along with this program. If not, see <https://gnu.org/licenses/gpl-3.0.html>. // along with this program. If not, see <https://gnu.org/licenses/gpl-3.0.html>.
/// `issue` subcommands /// Commands module
mod issue; mod commands;
/// CLI arguments parsers /// CLI arguments parsers
pub mod parsers; pub mod parsers;
/// 'reply` command
mod reply;
/// `repo` subcommands
mod repo;
/// CLI traits /// CLI traits
mod traits; mod traits;
use std::fmt; use clap::Parser;
use clap::{ArgGroup, Args, Parser};
use clap_verbosity_flag::Verbosity; use clap_verbosity_flag::Verbosity;
use nostr::key::Keys;
use nostr::{PublicKey, RelayUrl, SecretKey};
use self::issue::IssueSubcommands; pub use self::commands::*;
use self::reply::ReplyArgs;
use self::repo::RepoSubcommands;
use self::traits::CommandRunner; use self::traits::CommandRunner;
use crate::error::N34Result; use crate::error::N34Result;
@@ -52,63 +42,21 @@ const FOOTER: &str = r#"Please report bugs to <naddr1qqpkuve5qgsqqqqqq9g9uljgjfc
/// Name of the file storing the repository address /// Name of the file storing the repository address
pub const NOSTR_ADDRESS_FILE: &str = "nostr-address"; pub const NOSTR_ADDRESS_FILE: &str = "nostr-address";
/// The command-line interface options
#[derive(Args, Clone)]
#[clap(
group(
ArgGroup::new("auth")
.args(&["secret_key"])
.required(true)
)
)]
pub struct CliOptions {
/// Your Nostr secret key
#[arg(short, long)]
pub secret_key: Option<SecretKey>,
/// Where your relays list. And repository relays if not included in naddr
#[arg(short, long, required = true)]
pub relays: Vec<RelayUrl>,
/// Proof of Work difficulty when creatring events
#[arg(long, default_value_t = 0)]
pub pow: u8,
}
#[derive(Parser, Debug)] #[derive(Parser, Debug)]
#[command(about, version, before_long_help = HEADER, after_long_help = FOOTER)] #[command(about, version, before_long_help = HEADER, after_long_help = FOOTER)]
/// A command-line interface for interacting with NIP-34 and other Nostr /// A command-line interface for interacting with NIP-34 and other Nostr
/// code-related stuff. /// code-related stuff.
pub struct Cli { pub struct Cli {
#[command(flatten)] #[command(flatten)]
pub options: CliOptions, pub options: commands::CliOptions,
/// Controls the verbosity level of output /// Controls the verbosity level of output
#[command(flatten)] #[command(flatten)]
pub verbosity: Verbosity, pub verbosity: Verbosity,
/// The subcommand to execute /// The subcommand to execute
#[command(subcommand)] #[command(subcommand)]
pub command: Commands, pub command: commands::Commands,
} }
/// N34 commands
#[derive(Parser, Debug)]
pub enum Commands {
/// Manage repositories
Repo {
#[command(subcommand)]
subcommands: RepoSubcommands,
},
/// Manage issues
Issue {
#[command(subcommand)]
subcommands: IssueSubcommands,
},
// /// Manage patches
// Patch {
// #[command(subcommand)]
// subcommands: PatchSubcommands,
// },
/// Reply to issues and patches.
Reply(ReplyArgs),
}
impl Cli { impl Cli {
/// Executes the command /// Executes the command
@@ -116,34 +64,3 @@ impl Cli {
self.command.run(self.options).await self.command.run(self.options).await
} }
} }
impl CommandRunner for Commands {
async fn run(self, options: CliOptions) -> N34Result<()> {
tracing::trace!("Options: {options:#?}");
tracing::trace!("Handling: {self:#?}");
match self {
Self::Repo { subcommands } => subcommands.run(options).await,
Self::Issue { subcommands } => subcommands.run(options).await,
Commands::Reply(args) => args.run(options).await,
}
}
}
impl CliOptions {
/// Gets the public key of the user.
pub async fn pubkey(&self) -> N34Result<PublicKey> {
if let Some(sk) = &self.secret_key {
return Ok(Keys::new(sk.clone()).public_key());
}
unreachable!("There is no other method until now")
}
}
impl fmt::Debug for CliOptions {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("CliOptions")
.field("secret_key", &self.secret_key.as_ref().map(|_| "*******"))
.field("relays", &self.relays)
.finish()
}
}