Skip to content

Lower type rendering level in json output #661

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.

Sign up for GitHub

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
merged 1 commit into from
Jul 23, 2025
Merged

Lower type rendering level in json output #661

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 1 addition & 18 deletions crates/emmylua_code_analysis/src/db_index/type/humanize_type.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,7 @@ use itertools::Itertools;
use crate::{
DbIndex, GenericTpl, LuaAliasCallType, LuaFunctionType, LuaGenericType, LuaInstanceType,
LuaIntersectionType, LuaMemberKey, LuaMemberOwner, LuaObjectType, LuaSignatureId,
LuaStringTplType, LuaTupleType, LuaType, LuaTypeDeclId, LuaUnionType, TypeSubstitutor,
VariadicType,
LuaStringTplType, LuaTupleType, LuaType, LuaTypeDeclId, LuaUnionType, VariadicType,
};

use super::{LuaAliasCallKind, LuaMultiLineUnion};
Expand Down Expand Up @@ -484,22 +483,6 @@ fn humanize_generic_type(db: &DbIndex, generic: &LuaGenericType, level: RenderLe
};

let full_name = type_decl.get_full_name();
match level {
RenderLevel::Brief => {
if type_decl.is_alias() {
let params = generic
.get_params()
.iter()
.map(|ty| ty.clone())
.collect::<Vec<_>>();
let substitutor = TypeSubstitutor::from_type_array(params);
if let Some(origin) = type_decl.get_alias_origin(db, Some(&substitutor)) {
return humanize_type(db, &origin, level.next_level());
}
}
}
_ => {}
}

let generic_params = generic
.get_params()
Expand Down
4 changes: 2 additions & 2 deletions crates/emmylua_doc_cli/src/common.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
use emmylua_code_analysis::{humanize_type, DbIndex, LuaType, RenderLevel};

pub fn render_typ(db: &DbIndex, typ: &LuaType) -> String {
pub fn render_typ(db: &DbIndex, typ: &LuaType, level: RenderLevel) -> String {
match typ {
LuaType::IntegerConst(_) => "integer".to_string(),
LuaType::FloatConst(_) => "number".to_string(),
LuaType::StringConst(_) => "string".to_string(),
LuaType::BooleanConst(_) => "boolean".to_string(),
_ => humanize_type(db, typ, RenderLevel::Documentation),
_ => humanize_type(db, typ, level),
}
}

Expand Down
40 changes: 27 additions & 13 deletions crates/emmylua_doc_cli/src/json_generator/export.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ use crate::common::{render_const, render_typ};
use crate::json_generator::json_types::*;
use emmylua_code_analysis::{
DbIndex, FileId, LuaDeprecated, LuaMemberKey, LuaMemberOwner, LuaNoDiscard, LuaSemanticDeclId,
LuaSignature, LuaType, LuaTypeCache, LuaTypeDecl, LuaTypeDeclId, Vfs,
LuaSignature, LuaType, LuaTypeCache, LuaTypeDecl, LuaTypeDeclId, RenderLevel, Vfs,
};
use rowan::TextRange;

Expand Down Expand Up @@ -34,7 +34,7 @@ fn export_modules(db: &DbIndex) -> Vec<Module> {
let member_owner = LuaMemberOwner::Element(i.get_range().clone());
(export_members(db, member_owner), None)
}
typ => (Vec::new(), Some(render_typ(db, typ))),
typ => (Vec::new(), Some(render_typ(db, typ, RenderLevel::Simple))),
};

let property = module
Expand Down Expand Up @@ -118,7 +118,7 @@ fn export_globals(db: &DbIndex) -> Vec<Global> {
name: decl.get_name().to_string(),
property,
loc,
typ: render_typ(db, typ),
typ: render_typ(db, typ, RenderLevel::Simple),
literal: render_const(typ),
})),
}
Expand All @@ -140,7 +140,7 @@ fn export_class(db: &DbIndex, type_decl: &LuaTypeDecl) -> Class {
.get_super_types(&type_decl_id)
.unwrap_or_default()
.iter()
.map(|typ| render_typ(db, typ))
.map(|typ| render_typ(db, typ, RenderLevel::Simple))
.collect(),
generics: export_generics(db, &type_decl_id),
members: export_members(db, member_owner),
Expand All @@ -156,7 +156,9 @@ fn export_alias(db: &DbIndex, type_decl: &LuaTypeDecl) -> Alias {
name: type_decl.get_full_name().to_string(),
property,
loc: export_loc_for_type(db, type_decl),
typ: type_decl.get_alias_ref().map(|typ| render_typ(db, typ)),
typ: type_decl
.get_alias_ref()
.map(|typ| render_typ(db, typ, RenderLevel::Simple)),
generics: export_generics(db, &type_decl_id),
members: export_members(db, member_owner),
}
Expand All @@ -173,7 +175,7 @@ fn export_enum(db: &DbIndex, type_decl: &LuaTypeDecl) -> Enum {
loc: export_loc_for_type(db, type_decl),
typ: type_decl
.get_enum_field_type(db)
.map(|typ| render_typ(db, &typ)),
.map(|typ| render_typ(db, &typ, RenderLevel::Simple)),
generics: export_generics(db, &type_decl_id),
members: export_members(db, member_owner),
}
Expand All @@ -189,7 +191,9 @@ fn export_generics(db: &DbIndex, type_decl_id: &LuaTypeDeclId) -> Vec<TypeVar> {
.iter()
.map(|(name, typ)| TypeVar {
name: name.clone(),
base: typ.as_ref().map(|typ| render_typ(db, typ)),
base: typ
.as_ref()
.map(|typ| render_typ(db, typ, RenderLevel::Simple)),
})
.collect()
}
Expand All @@ -212,7 +216,9 @@ fn export_members(db: &DbIndex, member_owner: LuaMemberOwner) -> Vec<Member> {
let name = match member_key {
LuaMemberKey::Name(name) => name.to_string(),
LuaMemberKey::Integer(i) => format!("[{i}]"),
LuaMemberKey::ExprType(typ) => format!("[{}]", render_typ(db, typ)),
LuaMemberKey::ExprType(typ) => {
format!("[{}]", render_typ(db, typ, RenderLevel::Simple))
}
_ => return None,
};

Expand Down Expand Up @@ -254,7 +260,9 @@ fn export_signature(
.iter()
.map(|(name, typ)| TypeVar {
name: name.clone(),
base: typ.as_ref().map(|typ| render_typ(db, typ)),
base: typ
.as_ref()
.map(|typ| render_typ(db, typ, RenderLevel::Simple)),
})
.collect(),
params: signature
Expand All @@ -264,7 +272,7 @@ fn export_signature(
.map(|(i, name)| match signature.param_docs.get(&i) {
Some(param_info) => FnParam {
name: Some(name.clone()),
typ: Some(render_typ(db, &param_info.type_ref)),
typ: Some(render_typ(db, &param_info.type_ref, RenderLevel::Simple)),
desc: param_info.description.clone(),
},
None => FnParam {
Expand All @@ -278,14 +286,20 @@ fn export_signature(
.iter()
.map(|ret| FnParam {
name: ret.name.clone(),
typ: Some(render_typ(db, &ret.type_ref)),
typ: Some(render_typ(db, &ret.type_ref, RenderLevel::Simple)),
desc: ret.description.clone(),
})
.collect(),
overloads: signature
.overloads
.iter()
.map(|overload| render_typ(db, &LuaType::DocFunction(overload.clone())))
.map(|overload| {
render_typ(
db,
&LuaType::DocFunction(overload.clone()),
RenderLevel::Simple,
)
})
.collect(),
is_async: signature.is_async,
is_meth: signature.is_colon_define,
Expand All @@ -308,7 +322,7 @@ fn export_field(
name,
property,
loc,
typ: render_typ(db, typ),
typ: render_typ(db, typ, RenderLevel::Simple),
literal: render_const(typ),
}
}
Expand Down
18 changes: 13 additions & 5 deletions crates/emmylua_doc_cli/src/markdown_generator/render.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,11 @@ fn render_doc_function_type(
.map(|param| {
let name = param.0.clone();
if let Some(ty) = &param.1 {
format!("{}: {}", name, render_typ(db, ty))
format!(
"{}: {}",
name,
render_typ(db, ty, RenderLevel::Documentation)
)
} else {
name.to_string()
}
Expand All @@ -71,7 +75,7 @@ fn render_doc_function_type(

let ret_type = lua_func.get_ret();

let ret_strs = render_typ(db, ret_type);
let ret_strs = render_typ(db, ret_type, RenderLevel::Documentation);

let mut result = String::new();
result.push_str("```lua\n");
Expand Down Expand Up @@ -126,7 +130,11 @@ fn render_signature_type(
.map(|param| {
let name = param.0.clone();
if let Some(ty) = &param.1 {
format!("{}: {}", name, render_typ(db, ty))
format!(
"{}: {}",
name,
render_typ(db, ty, RenderLevel::Documentation)
)
} else {
name.to_string()
}
Expand Down Expand Up @@ -160,14 +168,14 @@ fn render_signature_type(
0 => {}
1 => {
result.push_str(" -> ");
let type_text = render_typ(db, &rets[0].type_ref);
let type_text = render_typ(db, &rets[0].type_ref, RenderLevel::Documentation);
let name = rets[0].name.clone().unwrap_or("".to_string());
result.push_str(format!("{} {}", name, type_text).as_str());
}
_ => {
result.push('\n');
for ret in rets {
let type_text = render_typ(db, &ret.type_ref);
let type_text = render_typ(db, &ret.type_ref, RenderLevel::Documentation);
let name = ret.name.clone().unwrap_or("".to_string());
result.push_str(format!(" -> {} {}\n", name, type_text).as_str());
}
Expand Down
Loading