mirrors/ruff
1
0
Fork 0
mirror of https://github.com/astral-sh/ruff.git synced 2025-08-03 18:28:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

refactor: Move name out of OptionField & OptionGroup

Browse source
This commit is contained in:
Martin Fischer 2023-02-11 18:07:16 +01:00 • committed by Charlie Marsh
parent 37e80d98ab
commit bbe44360e8
3 changed files with 21 additions and 57 deletions
Download patch file Download diff file Expand all files Collapse all files

11
crates/ruff/src/settings/options_base.rs
View file

@ -1,24 +1,17 @@
pub trait ConfigurationOptions {
fn get_available_options() -> Vec<OptionEntry>;
fn get_available_options() -> Vec<(&'static str, OptionEntry)>;
}
#[derive(Debug)]
pub enum OptionEntry {
Field(OptionField),
Group(OptionGroup),
Group(Vec<(&'static str, OptionEntry)>),
}
#[derive(Debug)]
pub struct OptionField {
pub name: &'static str,
pub doc: &'static str,
pub default: &'static str,
pub value_type: &'static str,
pub example: &'static str,
}
#[derive(Debug)]
pub struct OptionGroup {
pub name: &'static str,
pub fields: Vec<OptionEntry>,
}

53
crates/ruff_dev/src/generate_options.rs
View file

@ -18,8 +18,8 @@ pub struct Args {
pub(crate) dry_run: bool,
}
fn emit_field(output: &mut String, field: &OptionField, group_name: Option<&str>) {
output.push_str(&format!("#### [`{0}`](#{0})\n", field.name));
fn emit_field(output: &mut String, name: &str, field: &OptionField, group_name: Option<&str>) {
output.push_str(&format!("#### [`{0}`](#{0})\n", name));
output.push('\n');
output.push_str(field.doc);
output.push_str("\n\n");
@ -42,49 +42,24 @@ fn emit_field(output: &mut String, field: &OptionField, group_name: Option<&str>
pub fn main(args: &Args) -> Result<()> {
let mut output = String::new();
let mut sorted_options = Options::get_available_options();
sorted_options.sort_by_key(|(name, _)| *name);
// Generate all the top-level fields.
for field in Options::get_available_options()
.into_iter()
.filter_map(|entry| {
if let OptionEntry::Field(field) = entry {
Some(field)
} else {
None
}
})
.sorted_by_key(|field| field.name)
{
emit_field(&mut output, &field, None);
for (name, entry) in &sorted_options {
let OptionEntry::Field(field) = entry else { continue; };
emit_field(&mut output, name, field, None);
output.push_str("---\n\n");
}
// Generate all the sub-groups.
for group in Options::get_available_options()
.into_iter()
.filter_map(|entry| {
if let OptionEntry::Group(group) = entry {
Some(group)
} else {
None
}
})
.sorted_by_key(|group| group.name)
{
output.push_str(&format!("### `{}`\n", group.name));
for (group_name, entry) in &sorted_options {
let OptionEntry::Group(fields) = entry else { continue; };
output.push_str(&format!("### `{}`\n", group_name));
output.push('\n');
for field in group
.fields
.iter()
.filter_map(|entry| {
if let OptionEntry::Field(field) = entry {
Some(field)
} else {
None
}
})
.sorted_by_key(|field| field.name)
{
emit_field(&mut output, field, Some(group.name));
for (name, entry) in fields.iter().sorted_by_key(|(name, _)| name) {
let OptionEntry::Field(field) = entry else { continue; };
emit_field(&mut output, name, field, Some(group_name));
output.push_str("---\n\n");
}
}

14
crates/ruff_macros/src/config.rs
View file

@ -45,11 +45,11 @@ pub fn derive_impl(input: DeriveInput) -> syn::Result<proc_macro2::TokenStream>
}
Ok(quote! {
use crate::settings::options_base::{OptionEntry, OptionField, OptionGroup, ConfigurationOptions};
use crate::settings::options_base::{OptionEntry, OptionField, ConfigurationOptions};
#[automatically_derived]
impl ConfigurationOptions for #ident {
fn get_available_options() -> Vec<OptionEntry> {
fn get_available_options() -> Vec<(&'static str, OptionEntry)> {
vec![#(#output),*]
}
}
@ -86,10 +86,7 @@ fn handle_option_group(field: &Field) -> syn::Result<proc_macro2::TokenStream> {
let kebab_name = LitStr::new(&ident.to_string().replace('_', "-"), ident.span());
Ok(quote_spanned!(
ident.span() => OptionEntry::Group(OptionGroup {
name: #kebab_name,
fields: #path::get_available_options(),
})
ident.span() => (#kebab_name, OptionEntry::Group(#path::get_available_options()))
))
}
_ => Err(syn::Error::new(
@ -148,13 +145,12 @@ fn handle_option(
let kebab_name = LitStr::new(&ident.to_string().replace('_', "-"), ident.span());
Ok(quote_spanned!(
ident.span() => OptionEntry::Field(OptionField {
name: #kebab_name,
ident.span() => (#kebab_name, OptionEntry::Field(OptionField {
doc: &#doc,
default: &#default,
value_type: &#value_type,
example: &#example,
})
}))
))
}