Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Shell completions #129

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.

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
clearloop merged 4 commits into clearloop:master from akarsh1995:shell-completions
Jul 11, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 10 additions & 0 deletions Cargo.lock
View file Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions Cargo.toml
View file Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ toml = "0.5.9"
regex = "1.6.0"
scraper = "0.13.0"
anyhow = "1.0.71"
clap_complete = "4.3.2"

[dependencies.diesel]
version = "2.0.3"
Expand Down
17 changes: 17 additions & 0 deletions README.md
View file Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,23 @@
cargo install leetcode-cli
```

<details>
<summary>Shell completions</summary>

For Bash and Zsh (by default picks up `$SHELL` from environment)
```sh
eval "$(leetcode completions)"
```
Copy the line above to `.bash_profile` or `.zshrc`

You may also obtain specific shell configuration using.

```sh
leetcode completions fish
```

</details>

## Usage

**Make sure you have logged in to `leetcode.com` with `Firefox`**. See [Cookies](#cookies) for why you need to do this first.
Expand Down
16 changes: 10 additions & 6 deletions src/cli.rs
View file Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
//! Clap Commanders
use crate::{
cmds::{
Command, DataCommand, EditCommand, ExecCommand, ListCommand, PickCommand, StatCommand,
TestCommand,
completion_handler, Command, CompletionCommand, DataCommand, EditCommand, ExecCommand,
ListCommand, PickCommand, StatCommand, TestCommand,
},
err::Error,
flag::{Debug, Flag},
};
use clap::{crate_name, crate_version};
use clap::crate_version;
use log::LevelFilter;

/// This should be called before calling any cli method or printing any output.
Expand All @@ -26,7 +26,8 @@ pub fn reset_signal_pipe_handler() {
/// Get matches
pub async fn main() -> Result<(), Error> {
reset_signal_pipe_handler();
let m = clap::Command::new(crate_name!())

let mut cmd = clap::Command::new("leetcode")
.version(crate_version!())
.about("May the Code be with You 👻")
.subcommands(vec![
Expand All @@ -37,10 +38,12 @@ pub async fn main() -> Result<(), Error> {
PickCommand::usage().display_order(5),
StatCommand::usage().display_order(6),
TestCommand::usage().display_order(7),
CompletionCommand::usage().display_order(8),
])
.arg(Debug::usage())
.arg_required_else_help(true)
.get_matches();
.arg_required_else_help(true);

let m = cmd.clone().get_matches();

if m.get_flag("debug") {
Debug::handler()?;
Expand All @@ -59,6 +62,7 @@ pub async fn main() -> Result<(), Error> {
Some(("pick", sub_m)) => Ok(PickCommand::handler(sub_m).await?),
Some(("stat", sub_m)) => Ok(StatCommand::handler(sub_m).await?),
Some(("test", sub_m)) => Ok(TestCommand::handler(sub_m).await?),
Some(("completions", sub_m)) => Ok(completion_handler(sub_m, &mut cmd)?),
_ => Err(Error::MatchError),
}
}
62 changes: 62 additions & 0 deletions src/cmds/completions.rs
View file Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
//! Completions command

use super::Command;
use crate::err::Error;
use async_trait::async_trait;
use clap::{Arg, ArgAction, ArgMatches, Command as ClapCommand};
use clap_complete::{generate, Generator, Shell};

/// Abstract shell completions command
///
/// ```sh
/// Generate shell Completions

/// USAGE:
/// leetcode completions <shell>

/// ARGUMENTS:
/// <shell> [possible values: bash, elvish, fish, powershell, zsh]
/// ```
pub struct CompletionCommand;

#[async_trait]
impl Command for CompletionCommand {
/// `pick` usage
fn usage() -> ClapCommand {
ClapCommand::new("completions")
.about("Generate shell Completions")
.visible_alias("c")
.arg(
Arg::new("shell")
.action(ArgAction::Set)
.value_parser(clap::value_parser!(Shell)),
)
}

async fn handler(_m: &ArgMatches) -> Result<(), Error> {
// defining custom handler to print the completions. Handler method signature limits taking
// other params. We need &ArgMatches and &mut ClapCommand to generate completions.
println!("Don't use this handler. Does not implement the functionality to print completions. Use completions_handler() below.");
Ok(())
}
}

fn get_completions_string<G: Generator>(gen: G, cmd: &mut ClapCommand) -> Result<String, Error> {
let mut v: Vec<u8> = Vec::new();
let name = cmd.get_name().to_string();
generate(gen, cmd, name, &mut v);
Ok(String::from_utf8(v)?)
}

pub fn completion_handler(m: &ArgMatches, cmd: &mut ClapCommand) -> Result<(), Error> {
let shell = *m.get_one::<Shell>("shell").unwrap_or(
// if shell value is not provided try to get from the environment
{
println!("# Since shell arg value is not provided trying to get the default shell from the environment.");
&Shell::from_env().ok_or(Error::MatchError)?
}
);
let completions = get_completions_string(shell, cmd)?;
println!("{}", completions);
Ok(())
}
2 changes: 2 additions & 0 deletions src/cmds/mod.rs
View file Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,15 @@ pub trait Command {
async fn handler(m: &ArgMatches) -> Result<(), Error>;
}

mod completions;
mod data;
mod edit;
mod exec;
mod list;
mod pick;
mod stat;
mod test;
pub use completions::{completion_handler, CompletionCommand};
pub use data::DataCommand;
pub use edit::EditCommand;
pub use exec::ExecCommand;
Expand Down
11 changes: 10 additions & 1 deletion src/err.rs
View file Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
//! Errors in leetcode-cli
use crate::cmds::{Command, DataCommand};
use colored::Colorize;
use std::fmt;
use std::{fmt, string::FromUtf8Error};

// fixme: use this_error
/// Error enum
Expand All @@ -17,6 +17,7 @@ pub enum Error {
PremiumError,
DecryptError,
SilentError,
Utf8ParseError,
NoneError,
ChromeNotLogin,
Anyhow(anyhow::Error),
Expand Down Expand Up @@ -61,6 +62,7 @@ impl std::fmt::Debug for Error {
),
Error::ChromeNotLogin => write!(f, "maybe you not login on the Chrome, you can login and retry."),
Error::Anyhow(e) => write!(f, "{} {}", e, e),
Error::Utf8ParseError => write!(f, "cannot parse utf8 from buff {}", e),
}
}
}
Expand All @@ -72,6 +74,13 @@ impl std::convert::From<reqwest::Error> for Error {
}
}

// utf8 parse
impl std::convert::From<FromUtf8Error> for Error {
fn from(_err: FromUtf8Error) -> Self {
Error::Utf8ParseError
}
}

// nums
impl std::convert::From<std::num::ParseIntError> for Error {
fn from(err: std::num::ParseIntError) -> Self {
Expand Down

AltStyle によって変換されたページ (->オリジナル) /