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 Caddy;
impl Language for Caddy {
fn name(&self) -> &'static str {
"Caddy"
}
fn extensions(&self) -> &'static [&'static str] {
&["caddyfile"]
}
fn grammar_name(&self) -> &'static str {
"caddy"
}
fn has_symbols(&self) -> bool {
true
}
fn container_kinds(&self) -> &'static [&'static str] {
&["site_block", "directive_block"]
}
fn function_kinds(&self) -> &'static [&'static str] {
&[]
}
fn type_kinds(&self) -> &'static [&'static str] {
&[]
}
fn import_kinds(&self) -> &'static [&'static str] {
&["import"]
}
fn public_symbol_kinds(&self) -> &'static [&'static str] {
&["site_block"]
}
fn visibility_mechanism(&self) -> VisibilityMechanism {
VisibilityMechanism::AllPublic
}
fn extract_public_symbols(&self, node: &Node, content: &str) -> Vec<Export> {
if node.kind() != "site_block" {
return Vec::new();
}
if let Some(name) = self.node_name(node, content) {
return vec![Export {
name: name.to_string(),
kind: SymbolKind::Module,
line: node.start_position().row + 1,
}];
}
Vec::new()
}
fn scope_creating_kinds(&self) -> &'static [&'static str] {
&["site_block", "directive_block"]
}
fn control_flow_kinds(&self) -> &'static [&'static str] {
&[]
}
fn complexity_nodes(&self) -> &'static [&'static str] {
&[]
}
fn nesting_nodes(&self) -> &'static [&'static str] {
&["site_block", "directive_block"]
}
fn signature_suffix(&self) -> &'static str {
""
}
fn extract_function(
&self,
_node: &Node,
_content: &str,
_in_container: bool,
) -> Option<Symbol> {
None
}
fn extract_container(&self, node: &Node, content: &str) -> Option<Symbol> {
if node.kind() != "site_block" && node.kind() != "directive_block" {
return None;
}
let name = self.node_name(node, content)?;
let text = &content[node.byte_range()];
let first_line = text.lines().next().unwrap_or(text);
Some(Symbol {
name: name.to_string(),
kind: SymbolKind::Module,
signature: first_line.trim().to_string(),
docstring: None,
attributes: Vec::new(),
start_line: node.start_position().row + 1,
end_line: node.end_position().row + 1,
visibility: Visibility::Public,
children: Vec::new(),
is_interface_impl: false,
implements: Vec::new(),
})
}
fn extract_type(&self, _node: &Node, _content: &str) -> Option<Symbol> {
None
}
fn extract_docstring(&self, _node: &Node, _content: &str) -> Option<String> {
None
}
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()];
vec![Import {
module: text.trim().to_string(),
names: Vec::new(),
alias: None,
is_wildcard: false,
is_relative: false,
line: node.start_position().row + 1,
}]
}
fn format_import(&self, import: &Import, _names: Option<&[&str]>) -> String {
format!("import {}", import.module)
}
fn is_public(&self, _node: &Node, _content: &str) -> bool {
true
}
fn get_visibility(&self, _node: &Node, _content: &str) -> Visibility {
Visibility::Public
}
fn is_test_symbol(&self, _symbol: &crate::Symbol) -> bool {
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> {
if let Some(name_node) = node.child_by_field_name("name") {
return Some(&content[name_node.byte_range()]);
}
let mut cursor = node.walk();
if let Some(first_child) = node.children(&mut cursor).next() {
return Some(&content[first_child.byte_range()]);
}
None
}
fn file_path_to_module_name(&self, path: &Path) -> Option<String> {
let name = path.file_name()?.to_str()?;
if name.to_lowercase().contains("caddy") {
return Some(name.to_string());
}
None
}
fn module_name_to_paths(&self, _module: &str) -> Vec<String> {
vec!["Caddyfile".to_string()]
}
fn lang_key(&self) -> &'static str {
"caddy"
}
fn is_stdlib_import(&self, _: &str, _: &Path) -> bool {
false
}
fn find_stdlib(&self, _: &Path) -> Option<PathBuf> {
None
}
fn resolve_local_import(&self, _: &str, _: &Path, _: &Path) -> Option<PathBuf> {
None
}
fn resolve_external_import(&self, _: &str, _: &Path) -> Option<ResolvedPackage> {
None
}
fn get_version(&self, _: &Path) -> Option<String> {
None
}
fn find_package_cache(&self, _: &Path) -> Option<PathBuf> {
None
}
fn indexable_extensions(&self) -> &'static [&'static str] {
&[]
}
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::skip_dotfiles;
if skip_dotfiles(name) {
return true;
}
!is_dir && !name.to_lowercase().contains("caddy")
}
fn discover_packages(&self, _: &crate::PackageSource) -> Vec<(String, PathBuf)> {
Vec::new()
}
fn package_module_name(&self, entry_name: &str) -> String {
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] = &[
"matcher_name", "matcher_path", "matcher_path_regexp", "matcher_token",
"matcher_definition", "standard_matcher", "uri_path_with_placeholders",
"directive_import", "directive_request_body", "request_body_option_max_size",
"fastcgi_option_try_files", "encode_format", "log_option_format",
"global_options_block",
];
validate_unused_kinds_audit(&Caddy, documented_unused)
.expect("Caddy unused node kinds audit failed");
}
}