Extract semantic analysis from templates to new crate (#223)

Author: joshuadavidthomas

Cargo.lock

@@ -5,6 +5,7 @@ resolver = "2"
 [workspace.dependencies]
 djls = { path = "crates/djls" }
 djls-conf = { path = "crates/djls-conf" }
+djls-semantic = { path = "crates/djls-semantic" }
 djls-project = { path = "crates/djls-project" }
 djls-server = { path = "crates/djls-server" }
 djls-templates = { path = "crates/djls-templates" }

Cargo.toml

@@ -0,0 +1,18 @@
+[package]
+name = "djls-semantic"
+version = "0.0.0"
+edition = "2021"
+
+[dependencies]
+djls-conf = { workspace = true }
+djls-templates = { workspace = true }
+djls-workspace = { workspace = true }
+
+salsa = { workspace = true }
+tower-lsp-server = { workspace = true }
+
+[dev-dependencies]
+tempfile = { workspace = true }
+
+[lints]
+workspace = true

crates/djls-semantic/Cargo.toml

@@ -0,0 +1,13 @@
+use std::sync::Arc;
+
+use djls_templates::Db as TemplateDb;
+use djls_workspace::Db as WorkspaceDb;
+
+use crate::specs::TagSpecs;
+
+/// Semantic database trait extending the template and workspace databases
+#[salsa::db]
+pub trait SemanticDb: TemplateDb + WorkspaceDb {
+    /// Get the Django tag specifications for semantic analysis
+    fn tag_specs(&self) -> Arc<TagSpecs>;
+}

crates/djls-templates/src/templatetags/builtins.rs renamed to crates/djls-semantic/src/builtins.rs

@@ -0,0 +1,42 @@
+pub mod builtins;
+pub mod db;
+pub mod snippets;
+pub mod specs;
+pub mod validation;
+
+pub use builtins::django_builtin_specs;
+pub use db::SemanticDb;
+pub use snippets::generate_partial_snippet;
+pub use snippets::generate_snippet_for_tag;
+pub use snippets::generate_snippet_for_tag_with_end;
+pub use snippets::generate_snippet_from_args;
+pub use specs::ArgType;
+pub use specs::EndTag;
+pub use specs::IntermediateTag;
+pub use specs::SimpleArgType;
+pub use specs::TagArg;
+pub use specs::TagSpec;
+pub use specs::TagSpecs;
+pub use validation::TagValidator;
+
+pub enum TagType {
+    Opener,
+    Intermediate,
+    Closer,
+    Standalone,
+}
+
+impl TagType {
+    #[must_use]
+    pub fn for_name(name: &str, tag_specs: &TagSpecs) -> TagType {
+        if tag_specs.is_opener(name) {
+            TagType::Opener
+        } else if tag_specs.is_closer(name) {
+            TagType::Closer
+        } else if tag_specs.is_intermediate(name) {
+            TagType::Intermediate
+        } else {
+            TagType::Standalone
+        }
+    }
+}

crates/djls-semantic/src/db.rs

@@ -1,3 +1,7 @@
+// TODO: Move snippets module to djls-ide crate
+// Snippet generation is an IDE/editor feature, not a semantic analysis concern.
+// It belongs with other editor features like completions, hover, and folding.
+
 use super::specs::ArgType;
 use super::specs::SimpleArgType;
 use super::specs::TagArg;
@@ -122,8 +126,8 @@ pub fn generate_partial_snippet(spec: &TagSpec, starting_from_position: usize) -
 #[cfg(test)]
 mod tests {
     use super::*;
-    use crate::templatetags::specs::ArgType;
-    use crate::templatetags::specs::SimpleArgType;
+    use crate::specs::ArgType;
+    use crate::specs::SimpleArgType;
 
     #[test]
     fn test_snippet_for_for_tag() {
@@ -202,8 +206,8 @@ mod tests {
 
     #[test]
     fn test_snippet_for_block_tag() {
-        use crate::templatetags::specs::EndTag;
-        use crate::templatetags::specs::TagSpec;
+        use crate::specs::EndTag;
+        use crate::specs::TagSpec;
 
         let spec = TagSpec {
             name: None,
@@ -230,8 +234,8 @@ mod tests {
 
     #[test]
     fn test_snippet_with_end_tag() {
-        use crate::templatetags::specs::EndTag;
-        use crate::templatetags::specs::TagSpec;
+        use crate::specs::EndTag;
+        use crate::specs::TagSpec;
 
         let spec = TagSpec {
             name: None,

crates/djls-semantic/src/lib.rs

@@ -97,7 +97,7 @@ impl TagSpecs {
 impl From<&djls_conf::Settings> for TagSpecs {
     fn from(settings: &djls_conf::Settings) -> Self {
         // Start with built-in specs
-        let mut specs = crate::templatetags::django_builtin_specs();
+        let mut specs = crate::builtins::django_builtin_specs();
 
         // Convert and merge user-defined tagspecs
         let mut user_specs = HashMap::new();