use crate::external_packages::ResolvedPackage;
use crate::{Export, Import, Language, Symbol, SymbolKind, Visibility, VisibilityMechanism};
use std::path::{Path, PathBuf};
use tree_sitter::Node;
pub struct Gleam;
impl Language for Gleam {
fn name(&self) -> &'static str {
"Gleam"
}
fn extensions(&self) -> &'static [&'static str] {
&["gleam"]
}
fn grammar_name(&self) -> &'static str {
"gleam"
}
fn has_symbols(&self) -> bool {
true
}
fn container_kinds(&self) -> &'static [&'static str] {
&["type_definition", "type_alias"]
}
fn function_kinds(&self) -> &'static [&'static str] {
&["function"]
}
fn type_kinds(&self) -> &'static [&'static str] {
&["type_definition", "type_alias"]
}
fn import_kinds(&self) -> &'static [&'static str] {
&["import"]
}
fn public_symbol_kinds(&self) -> &'static [&'static str] {
&["function", "type_definition", "type_alias", "constant"]
}
fn visibility_mechanism(&self) -> VisibilityMechanism {
VisibilityMechanism::ExplicitExport }
fn extract_public_symbols(&self, node: &Node, content: &str) -> Vec<Export> {
let text = &content[node.byte_range()];
if !text.starts_with("pub ") {
return Vec::new();
}
let name = match self.node_name(node, content) {
Some(n) => n.to_string(),
None => return Vec::new(),
};
let kind = match node.kind() {
"function" => SymbolKind::Function,
"type_definition" => SymbolKind::Type,
"type_alias" => SymbolKind::Type,
"constant" => SymbolKind::Variable,
_ => return Vec::new(),
};
vec![Export {
name,
kind,
line: node.start_position().row + 1,
}]
}
fn scope_creating_kinds(&self) -> &'static [&'static str] {
&["function", "anonymous_function"]
}
fn control_flow_kinds(&self) -> &'static [&'static str] {
&["case", "if"]
}
fn complexity_nodes(&self) -> &'static [&'static str] {
&["case", "case_clause", "if"]
}
fn nesting_nodes(&self) -> &'static [&'static str] {
&["function", "case", "block"]
}
fn signature_suffix(&self) -> &'static str {
""
}
fn extract_function(&self, node: &Node, content: &str, _in_container: bool) -> Option<Symbol> {
if node.kind() != "function" {
return None;
}
let name = self.node_name(node, content)?;
let text = &content[node.byte_range()];
let first_line = text.lines().next().unwrap_or(text);
let is_public = text.starts_with("pub ");
Some(Symbol {
name: name.to_string(),
kind: SymbolKind::Function,
signature: first_line.trim().to_string(),
docstring: self.extract_docstring(node, content),
attributes: Vec::new(),
start_line: node.start_position().row + 1,
end_line: node.end_position().row + 1,
visibility: if is_public {
Visibility::Public
} else {
Visibility::Private
},
children: Vec::new(),
is_interface_impl: false,
implements: Vec::new(),
})
}
fn extract_container(&self, node: &Node, content: &str) -> Option<Symbol> {
let name = self.node_name(node, content)?;
let text = &content[node.byte_range()];
let first_line = text.lines().next().unwrap_or(text);
let is_public = text.starts_with("pub ");
let kind = match node.kind() {
"type_definition" => SymbolKind::Type,
"type_alias" => SymbolKind::Type,
_ => return None,
};
Some(Symbol {
name: name.to_string(),
kind,
signature: first_line.trim().to_string(),
docstring: self.extract_docstring(node, content),
attributes: Vec::new(),
start_line: node.start_position().row + 1,
end_line: node.end_position().row + 1,
visibility: if is_public {
Visibility::Public
} else {
Visibility::Private
},
children: Vec::new(),
is_interface_impl: false,
implements: Vec::new(),
})
}
fn extract_type(&self, node: &Node, content: &str) -> Option<Symbol> {
self.extract_container(node, content)
}
fn extract_docstring(&self, node: &Node, content: &str) -> Option<String> {
let mut prev = node.prev_sibling();
let mut doc_lines = Vec::new();
while let Some(sibling) = prev {
let text = &content[sibling.byte_range()];
if sibling.kind() == "comment" && text.starts_with("///") {
let line = text.strip_prefix("///").unwrap_or(text).trim();
doc_lines.push(line.to_string());
prev = sibling.prev_sibling();
} else {
break;
}
}
if doc_lines.is_empty() {
return None;
}
doc_lines.reverse();
Some(doc_lines.join(" "))
}
fn extract_attributes(&self, _node: &Node, _content: &str) -> Vec<String> {
Vec::new()
}
fn extract_imports(&self, node: &Node, content: &str) -> Vec<Import> {
if node.kind() != "import" {
return Vec::new();
}
let text = &content[node.byte_range()];
let line = node.start_position().row + 1;
if let Some(rest) = text.strip_prefix("import ") {
let module = rest.split_whitespace().next().unwrap_or("").to_string();
if !module.is_empty() {
return vec![Import {
module,
names: Vec::new(),
alias: None,
is_wildcard: false,
is_relative: false,
line,
}];
}
}
Vec::new()
}
fn format_import(&self, import: &Import, names: Option<&[&str]>) -> String {
let names_to_use: Vec<&str> = names
.map(|n| n.to_vec())
.unwrap_or_else(|| import.names.iter().map(|s| s.as_str()).collect());
if names_to_use.is_empty() {
format!("import {}", import.module)
} else {
format!("import {}.{{{}}}", import.module, names_to_use.join(", "))
}
}
fn is_public(&self, node: &Node, content: &str) -> bool {
content[node.byte_range()].starts_with("pub ")
}
fn get_visibility(&self, node: &Node, content: &str) -> Visibility {
if self.is_public(node, content) {
Visibility::Public
} else {
Visibility::Private
}
}
fn is_test_symbol(&self, symbol: &crate::Symbol) -> bool {
let name = symbol.name.as_str();
match symbol.kind {
crate::SymbolKind::Function | crate::SymbolKind::Method => name.starts_with("test_"),
crate::SymbolKind::Module => name == "tests" || name == "test",
_ => false,
}
}
fn embedded_content(&self, _node: &Node, _content: &str) -> Option<crate::EmbeddedBlock> {
None
}
fn container_body<'a>(&self, node: &'a Node<'a>) -> Option<Node<'a>> {
node.child_by_field_name("body")
}
fn body_has_docstring(&self, _body: &Node, _content: &str) -> bool {
false
}
fn node_name<'a>(&self, node: &Node, content: &'a str) -> Option<&'a str> {
node.child_by_field_name("name")
.map(|n| &content[n.byte_range()])
}
fn file_path_to_module_name(&self, path: &Path) -> Option<String> {
let ext = path.extension()?.to_str()?;
if ext != "gleam" {
return None;
}
let stem = path.file_stem()?.to_str()?;
Some(stem.to_string())
}
fn module_name_to_paths(&self, module: &str) -> Vec<String> {
let path = module.replace('/', "/");
vec![format!("{}.gleam", path), format!("src/{}.gleam", path)]
}
fn lang_key(&self) -> &'static str {
"gleam"
}
fn is_stdlib_import(&self, import_name: &str, _project_root: &Path) -> bool {
import_name.starts_with("gleam/")
}
fn find_stdlib(&self, _project_root: &Path) -> Option<PathBuf> {
None
}
fn resolve_local_import(
&self,
import: &str,
_current_file: &Path,
project_root: &Path,
) -> Option<PathBuf> {
let path = import.replace('/', "/");
let full = project_root.join("src").join(format!("{}.gleam", path));
if full.is_file() { Some(full) } else { None }
}
fn resolve_external_import(&self, _: &str, _: &Path) -> Option<ResolvedPackage> {
None
}
fn get_version(&self, project_root: &Path) -> Option<String> {
if project_root.join("gleam.toml").is_file() {
return Some("gleam.toml".to_string());
}
None
}
fn find_package_cache(&self, project_root: &Path) -> Option<PathBuf> {
let build = project_root.join("build/packages");
if build.is_dir() {
return Some(build);
}
None
}
fn indexable_extensions(&self) -> &'static [&'static str] {
&["gleam"]
}
fn package_sources(&self, _: &Path) -> Vec<crate::PackageSource> {
Vec::new()
}
fn should_skip_package_entry(&self, name: &str, is_dir: bool) -> bool {
use crate::traits::{has_extension, skip_dotfiles};
if skip_dotfiles(name) {
return true;
}
if is_dir && name == "build" {
return true;
}
!is_dir && !has_extension(name, self.indexable_extensions())
}
fn discover_packages(&self, _: &crate::PackageSource) -> Vec<(String, PathBuf)> {
Vec::new()
}
fn package_module_name(&self, entry_name: &str) -> String {
entry_name
.strip_suffix(".gleam")
.unwrap_or(entry_name)
.to_string()
}
fn find_package_entry(&self, path: &Path) -> Option<PathBuf> {
if path.is_file() {
Some(path.to_path_buf())
} else {
None
}
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::validate_unused_kinds_audit;
#[test]
fn unused_node_kinds_audit() {
#[rustfmt::skip]
let documented_unused: &[&str] = &[
"data_constructor", "data_constructor_argument", "data_constructor_arguments",
"data_constructors", "external_type", "function_parameter", "function_parameter_types",
"function_parameters", "function_type", "opacity_modifier", "remote_type_identifier",
"tuple_type", "type", "type_argument", "type_arguments", "type_hole", "type_identifier",
"type_name", "type_parameter", "type_parameters", "type_var", "visibility_modifier",
"case_clause_guard", "case_clause_pattern", "case_clause_patterns", "case_clauses",
"case_subjects",
"binary_expression", "constructor_name", "external_function", "external_function_body",
"function_call", "remote_constructor_name",
"unqualified_import", "unqualified_imports",
"identifier", "module", "module_comment", "statement_comment",
];
validate_unused_kinds_audit(&Gleam, documented_unused)
.expect("Gleam unused node kinds audit failed");
}
}