ruff autocompletion for --select rules

[spaceone]

ruff check --select E currently suggests filenames starting with E instead of the rules starting with E.

It would be nice if that was supported for --select, --ignore, etc.

[spaceone]

Same for ruff rule E

[charliermarsh]

Probably has to do with the fact that we use a custom from_str for these, so they aren't picked up in auto-completion. But maybe there's a way around it.

[not-my-profile]

Yes there's indeed a way around this. I have already implemented this locally but would wait till #2517 is merged since that logic has to change when the RuleCodePrefix enum is split up.

[spaceone]

Same for ruff rule E
@not-my-profile can you do this as well?

I tried too long for myself but failed with:

diff --git crates/ruff_cli/src/args.rs crates/ruff_cli/src/args.rs
index 445534c7..e69bb043 100644                                                                                                                                             
--- crates/ruff_cli/src/args.rs  
+++ crates/ruff_cli/src/args.rs          
@@ -38,7 +38,7 @@ pub enum Command {                                                                                                                                        
     #[clap(alias = "--explain")]                                                                                                            
     Rule {                                                                                                                                                                 
         #[arg(value_parser=Rule::from_code)]                                                                                                                               
-        rule: Rule,                                                     
+        rule: RuleSelector,                                  
                                                    
         /// Output format                                    
         #[arg(long, value_enum, default_value = "pretty")]          
diff --git crates/ruff_cli/src/main.rs crates/ruff_cli/src/main.rs                                                                                                           
index cf806cde..ea3af2b4 100644          
--- crates/ruff_cli/src/main.rs     
+++ crates/ruff_cli/src/main.rs                                                                                                                                             
@@ -8,6 +8,7 @@ use clap::{CommandFactory, Parser, Subcommand};           
 use colored::Colorize;                       
 use notify::{recommended_watcher, RecursiveMode, Watcher};       
                               
+use ruff::registry::Rule;                          
 use ::ruff::logging::{set_up_logging, LogLevel};             
 use ::ruff::resolver::PyprojectDiscovery;
 use ::ruff::settings::types::SerializationFormat;                                                                                                                           
@@ -107,7 +108,7 @@ quoting the executed command, along with the relevant file contents and `pyproje
     set_up_logging(&log_level)?;            
                                                                             
     match command {        
-        Command::Rule { rule, format } => commands::rule::rule(&rule, format)?,
+        Command::Rule { rule, format } => commands::rule::rule(&Rule::from_code(rule.prefix_and_code().1).unwrap(), format)?,
         Command::Config { option } => return Ok(commands::config::config(option.as_deref())),                                                                              
         Command::Linter { format } => commands::linter::linter(format)?,
         Command::Clean => commands::clean::clean(log_level)?,

Also how can I enable that it displays the short-code like in the PR?:

$ ruff check --select=EM<Tab>
EM          -- flake8-errmsg
EM10   EM1  --
EM101       -- raw-string-in-exception
EM102       -- f-string-in-exception
EM103       -- dot-format-in-exception

for me it displays only the raw codes.

[not-my-profile]

can you do this as well?

I am currently busy with other stuff.

how can I enable that it displays the short-code like in the PR?

I don't know I am using Zsh and this just worked ... are you using a different shell?

[spaceone]

I am using bash.

[not-my-profile]

Ah ok yeah ... sorry it appears that clap_complete doesn't include the value help text for bash ... perhaps because bash doesn't support it?

$ ruff generate-shell-completion zsh | grep banned-api
TID251\:"banned-api"
TID251\:"banned-api"
TID251\:"banned-api"
TID251\:"banned-api"
TID251\:"banned-api"
TID251\:"banned-api"
$ ruff generate-shell-completion bash | grep banned-api
# nothing

I can recommend zsh ... it does in general have much better autocompletion than bash.

[spaceone]

ok, thanks