fix: files.ignore setting should work (#462)

Author: juleswritescode

Cargo.lock

@@ -47,7 +47,7 @@ convert_case             = "0.6.0"
 prost-reflect            = "0.15.3"
 protox                   = "0.8.0"
 sqlx                     = { version = "0.8.2", features = ["runtime-tokio", "runtime-async-std", "postgres", "json"] }
-syn                      = "1.0.109"
+syn                      = { version = "1.0.109", features = ["full"] }
 termcolor                = "1.4.1"
 test-log                 = "0.2.17"
 tokio                    = { version = "1.40.0", features = ["full"] }
@@ -85,6 +85,7 @@ pgt_tokenizer              = { path = "./crates/pgt_tokenizer", version = "0.0.0
 pgt_treesitter_queries     = { path = "./crates/pgt_treesitter_queries", version = "0.0.0" }
 pgt_typecheck              = { path = "./crates/pgt_typecheck", version = "0.0.0" }
 pgt_workspace              = { path = "./crates/pgt_workspace", version = "0.0.0" }
+pgt_workspace_macros       = { path = "./crates/pgt_workspace_macros", version = "0.0.0" }
 
 pgt_test_macros = { path = "./crates/pgt_test_macros" }
 pgt_test_utils  = { path = "./crates/pgt_test_utils" }

Cargo.toml

@@ -164,6 +164,7 @@ impl From<super::Location<'_>> for Location {
 #[serde(rename_all = "camelCase")]
 #[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
 #[cfg_attr(test, derive(Eq, PartialEq))]
+
 struct Advices {
     advices: Vec<Advice>,
 }
@@ -250,7 +251,7 @@ impl super::Advices for Advices {
 #[derive(Clone, Debug, Serialize, Deserialize)]
 #[serde(rename_all = "camelCase")]
 #[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
-#[cfg_attr(test, derive(Eq, PartialEq))]
+#[cfg_attr(test, derive(PartialEq, Eq))]
 enum Advice {
     Log(LogCategory, MarkupBuf),
     List(Vec<MarkupBuf>),

crates/pgt_diagnostics/src/serde.rs

@@ -32,6 +32,7 @@ pgt_statement_splitter    = { workspace = true }
 pgt_suppressions          = { workspace = true }
 pgt_text_size.workspace   = true
 pgt_typecheck             = { workspace = true }
+pgt_workspace_macros      = { workspace = true }
 rustc-hash                = { workspace = true }
 schemars                  = { workspace = true, optional = true }
 serde                     = { workspace = true, features = ["derive"] }

crates/pgt_workspace/Cargo.toml

@@ -12,7 +12,7 @@ pub struct CodeActionsParams {
     pub skip: Vec<RuleSelector>,
 }
 
-#[derive(Debug, serde::Serialize, serde::Deserialize)]
+#[derive(Debug, serde::Serialize, serde::Deserialize, Default)]
 #[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
 pub struct CodeActionsResult {
     pub actions: Vec<CodeAction>,
@@ -57,7 +57,7 @@ pub struct ExecuteStatementParams {
     pub path: PgTPath,
 }
 
-#[derive(Debug, serde::Serialize, serde::Deserialize)]
+#[derive(Debug, serde::Serialize, serde::Deserialize, Default, PartialEq, Eq)]
 #[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
 pub struct ExecuteStatementResult {
     pub message: String,

crates/pgt_workspace/src/features/code_actions.rs

@@ -12,7 +12,7 @@ pub struct PullDiagnosticsParams {
     pub skip: Vec<RuleSelector>,
 }
 
-#[derive(Debug, serde::Serialize, serde::Deserialize)]
+#[derive(Debug, serde::Serialize, serde::Deserialize, Default)]
 #[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
 pub struct PullDiagnosticsResult {
     pub diagnostics: Vec<pgt_diagnostics::serde::Diagnostic>,

crates/pgt_workspace/src/features/diagnostics.rs

@@ -21,6 +21,7 @@ use pgt_diagnostics::{
 };
 use pgt_fs::{ConfigName, PgTPath};
 use pgt_typecheck::{IdentifierType, TypecheckParams, TypedIdentifier};
+use pgt_workspace_macros::ignored_path;
 use schema_cache_manager::SchemaCacheManager;
 use sqlx::{Executor, PgPool};
 use tracing::{debug, info};
@@ -30,7 +31,7 @@ use crate::{
     configuration::to_analyser_rules,
     features::{
         code_actions::{
-            self, CodeAction, CodeActionKind, CodeActionsResult, CommandAction,
+            CodeAction, CodeActionKind, CodeActionsParams, CodeActionsResult, CommandAction,
             CommandActionCategory, ExecuteStatementParams, ExecuteStatementResult,
         },
         completions::{CompletionsResult, GetCompletionsParams, get_statement_for_completions},
@@ -262,6 +263,7 @@ impl Workspace for WorkspaceServer {
     }
 
     /// Add a new file to the workspace
+    #[ignored_path(path=&params.path)]
     #[tracing::instrument(level = "info", skip_all, fields(path = params.path.as_path().as_os_str().to_str()), err)]
     fn open_file(&self, params: OpenFileParams) -> Result<(), WorkspaceError> {
         let mut documents = self.documents.write().unwrap();
@@ -277,6 +279,7 @@ impl Workspace for WorkspaceServer {
     }
 
     /// Remove a file from the workspace
+    #[ignored_path(path=&params.path)]
     fn close_file(&self, params: super::CloseFileParams) -> Result<(), WorkspaceError> {
         let mut documents = self.documents.write().unwrap();
         documents
@@ -291,6 +294,7 @@ impl Workspace for WorkspaceServer {
         path = params.path.as_os_str().to_str(),
         version = params.version
     ), err)]
+    #[ignored_path(path=&params.path)]
     fn change_file(&self, params: super::ChangeFileParams) -> Result<(), WorkspaceError> {
         let mut documents = self.documents.write().unwrap();
 
@@ -312,6 +316,7 @@ impl Workspace for WorkspaceServer {
         None
     }
 
+    #[ignored_path(path=&params.path)]
     fn get_file_content(&self, params: GetFileContentParams) -> Result<String, WorkspaceError> {
         let documents = self.documents.read().unwrap();
         let document = documents
@@ -324,10 +329,11 @@ impl Workspace for WorkspaceServer {
         Ok(self.is_ignored(params.pgt_path.as_path()))
     }
 
+    #[ignored_path(path=&params.path)]
     fn pull_code_actions(
         &self,
-        params: code_actions::CodeActionsParams,
-    ) -> Result<code_actions::CodeActionsResult, WorkspaceError> {
+        params: CodeActionsParams,
+    ) -> Result<CodeActionsResult, WorkspaceError> {
         let documents = self.documents.read().unwrap();
         let parser = documents
             .get(&params.path)
@@ -366,6 +372,7 @@ impl Workspace for WorkspaceServer {
         Ok(CodeActionsResult { actions })
     }
 
+    #[ignored_path(path=&params.path)]
     fn execute_statement(
         &self,
         params: ExecuteStatementParams,
@@ -409,6 +416,7 @@ impl Workspace for WorkspaceServer {
         })
     }
 
+    #[ignored_path(path=&params.path)]
     fn pull_diagnostics(
         &self,
         params: PullDiagnosticsParams,
@@ -607,6 +615,7 @@ impl Workspace for WorkspaceServer {
         })
     }
 
+    #[ignored_path(path=&params.path)]
     #[tracing::instrument(level = "debug", skip_all, fields(
         path = params.path.as_os_str().to_str(),
         position = params.position.to_string()

crates/pgt_workspace/src/workspace/server.rs

@@ -1,15 +1,21 @@
-use biome_deserialize::Merge;
+use std::sync::Arc;
+
+use biome_deserialize::{Merge, StringSet};
 use pgt_analyse::RuleCategories;
-use pgt_configuration::{PartialConfiguration, database::PartialDatabaseConfiguration};
+use pgt_configuration::{
+    PartialConfiguration, database::PartialDatabaseConfiguration, files::PartialFilesConfiguration,
+};
 use pgt_diagnostics::Diagnostic;
 use pgt_fs::PgTPath;
 use pgt_text_size::TextRange;
 use sqlx::PgPool;
 
 use crate::{
     Workspace, WorkspaceError,
+    features::code_actions::ExecuteStatementResult,
     workspace::{
-        OpenFileParams, RegisterProjectFolderParams, UpdateSettingsParams, server::WorkspaceServer,
+        OpenFileParams, RegisterProjectFolderParams, StatementId, UpdateSettingsParams,
+        server::WorkspaceServer,
     },
 };
 
@@ -152,3 +158,51 @@ async fn test_syntax_error(test_db: PgPool) {
         Some(TextRange::new(7.into(), 15.into()))
     );
 }
+
+#[tokio::test]
+async fn correctly_ignores_files() {
+    let mut conf = PartialConfiguration::init();
+    conf.merge_with(PartialConfiguration {
+        files: Some(PartialFilesConfiguration {
+            ignore: Some(StringSet::from_iter(["test.sql".to_string()])),
+            ..Default::default()
+        }),
+        ..Default::default()
+    });
+
+    let workspace = get_test_workspace(Some(conf)).expect("Unable to create test workspace");
+
+    let path = PgTPath::new("test.sql");
+    let content = r#"
+      seect 1;
+    "#;
+
+    let diagnostics_result = workspace.pull_diagnostics(crate::workspace::PullDiagnosticsParams {
+        path: path.clone(),
+        categories: RuleCategories::all(),
+        max_diagnostics: 100,
+        only: vec![],
+        skip: vec![],
+    });
+
+    assert!(
+        diagnostics_result.is_ok_and(|res| res.diagnostics.is_empty()
+            && res.errors == 0
+            && res.skipped_diagnostics == 0)
+    );
+
+    let close_file_result =
+        workspace.close_file(crate::workspace::CloseFileParams { path: path.clone() });
+
+    assert!(close_file_result.is_ok());
+
+    let execute_statement_result =
+        workspace.execute_statement(crate::workspace::ExecuteStatementParams {
+            path: path.clone(),
+            statement_id: StatementId::Root {
+                content: Arc::from(content),
+            },
+        });
+
+    assert!(execute_statement_result.is_ok_and(|res| res == ExecuteStatementResult::default()));
+}

crates/pgt_workspace/src/workspace/server.tests.rs

@@ -0,0 +1,19 @@
+[package]
+authors.workspace    = true
+categories.workspace = true
+description          = "<DESCRIPTION>"
+edition.workspace    = true
+homepage.workspace   = true
+keywords.workspace   = true
+license.workspace    = true
+name                 = "pgt_workspace_macros"
+repository.workspace = true
+version              = "0.0.0"
+
+[lib]
+proc-macro = true
+
+[dependencies]
+proc-macro2 = { version = "1.0.95" }
+quote       = { workspace = true }
+syn         = { workspace = true }