Skip to content

Offline, privacy-first grammar checker. Fast, open-source, Rust-powered

feat(ls): added code actions to ignore lints

Elijah Potter7f673c1ef1a2
diff --git a/harper-core/src/document.rs b/harper-core/src/document.rs
index 4a5e5202d..7b5bf493a 100644
--- a/harper-core/src/document.rs
+++ b/harper-core/src/document.rs
@@ -28,9 +28,10 @@ impl Document {
/// Locate all the tokens that intersect a provided span.
///
/// Desperately needs optimization.
- pub fn tokens_intersecting(&self, span: Span) -> Vec<Token> {
+ pub fn token_indices_intersecting(&self, span: Span) -> Vec<usize> {
self.tokens()
- .filter(|tok| tok.span.overlaps_with(span))
+ .enumerate()
+ .filter_map(|(idx, tok)| tok.span.overlaps_with(span).then_some(idx))
.collect()
}
diff --git a/harper-core/src/ignored_lints.rs b/harper-core/src/ignored_lints.rs
index 41044e825..07c97792f 100644
--- a/harper-core/src/ignored_lints.rs
+++ b/harper-core/src/ignored_lints.rs
@@ -16,12 +16,22 @@ impl IgnoredLints {
}
fn hash_lint_context(&self, lint: &Lint, document: &Document) -> u64 {
- let problem_tokens = document.tokens_intersecting(lint.span);
+ let problem_tokens = document.token_indices_intersecting(lint.span);
+ let prequel_tokens = lint
+ .span
+ .with_len(2)
+ .pulled_by(2)
+ .map(|v| document.token_indices_intersecting(v))
+ .unwrap_or_default();
+ let sequel_tokens = document.token_indices_intersecting(lint.span.with_len(2).pushed_by(2));
let mut hasher = DefaultHasher::default();
problem_tokens
.into_iter()
+ .chain(prequel_tokens)
+ .chain(sequel_tokens)
+ .flat_map(|idx| document.get_token(idx))
.for_each(|tok| tok.kind.hash(&mut hasher));
let lint_hash = lint.spanless_hash();
diff --git a/harper-ls/src/backend.rs b/harper-ls/src/backend.rs
index 437475610..4342f1e97 100644
--- a/harper-ls/src/backend.rs
+++ b/harper-ls/src/backend.rs
@@ -336,6 +336,7 @@ impl LanguageServer for Backend {
"HarperAddToUserDict".to_owned(),
"HarperAddToFileDict".to_owned(),
"HarperOpen".to_owned(),
+ "HarperIgnoreLint".to_owned(),
],
..Default::default()
}),
@@ -456,8 +457,8 @@ impl LanguageServer for Backend {
async fn execute_command(&self, params: ExecuteCommandParams) -> JsonResult<Option<Value>> {
let mut string_args = params
.arguments
- .into_iter()
- .map(|v| serde_json::from_value::<String>(v).unwrap());
+ .iter()
+ .map(|v| serde_json::from_value::<String>(v.clone()).unwrap());
let Some(first) = string_args.next() else {
return Ok(None);
@@ -533,6 +534,34 @@ impl LanguageServer for Backend {
error!("Unable to open URL: {}", err);
}
},
+ "HarperIgnoreLint" => {
+ let Ok(url) = Url::parse(&first) else {
+ error!("Unable to parse URL from command: {first}");
+ return Ok(None);
+ };
+
+ let Some(second) = params.arguments.into_iter().nth(1) else {
+ error!("Not enough arguments to HarperIgnoreLint");
+ return Ok(None);
+ };
+
+ let Ok(lint) = serde_json::from_value(second) else {
+ error!("Unable to parse lint.");
+ return Ok(None);
+ };
+
+ let mut doc_lock = self.doc_state.lock().await;
+ let Some(doc_state) = doc_lock.get_mut(&url) else {
+ error!("Requested document has not been loaded.");
+ return Ok(None);
+ };
+
+ doc_state.ignore_lint(&lint);
+
+ drop(doc_lock);
+
+ self.publish_diagnostics(&url).await;
+ }
_ => (),
}
diff --git a/harper-ls/src/diagnostics.rs b/harper-ls/src/diagnostics.rs
index e30710d40..7673032fd 100644
--- a/harper-ls/src/diagnostics.rs
+++ b/harper-ls/src/diagnostics.rs
@@ -27,7 +27,14 @@ pub fn lint_to_code_actions<'a>(
source: &'a [char],
config: &CodeActionConfig,
) -> Vec<CodeActionOrCommand> {
- let mut results = Vec::new();
+ let mut results = vec![CodeActionOrCommand::Command(Command {
+ title: "Ignore grammatical error.".to_owned(),
+ command: "HarperIgnoreLint".to_owned(),
+ arguments: Some(vec![
+ serde_json::Value::String(url.to_string()),
+ serde_json::to_value(lint).unwrap(),
+ ]),
+ })];
results.extend(
lint.suggestions
diff --git a/harper-ls/src/document_state.rs b/harper-ls/src/document_state.rs
index f25d708b3..1bab0e0e9 100644
--- a/harper-ls/src/document_state.rs
+++ b/harper-ls/src/document_state.rs
@@ -1,8 +1,8 @@
use crate::config::{CodeActionConfig, DiagnosticSeverity};
use crate::diagnostics::{lint_to_code_actions, lints_to_diagnostics};
use crate::pos_conv::range_to_span;
-use harper_core::linting::{LintGroup, Linter};
-use harper_core::{Document, FullDictionary, MergedDictionary, TokenKind};
+use harper_core::linting::{Lint, LintGroup, Linter};
+use harper_core::{Document, FullDictionary, IgnoredLints, MergedDictionary, TokenKind};
use harper_core::{Lrc, Token};
use tower_lsp::lsp_types::{CodeActionOrCommand, Command, Diagnostic, Range, Url};
@@ -12,12 +12,19 @@ pub struct DocumentState {
pub dict: Lrc<MergedDictionary>,
pub linter: LintGroup<Lrc<MergedDictionary>>,
pub language_id: Option<String>,
+ pub ignored_lints: IgnoredLints,
pub url: Url,
}
impl DocumentState {
+ pub fn ignore_lint(&mut self, lint: &Lint) {
+ self.ignored_lints.ignore_lint(lint, &self.document);
+ }
+
pub fn generate_diagnostics(&mut self, severity: DiagnosticSeverity) -> Vec<Diagnostic> {
- let lints = self.linter.lint(&self.document);
+ let mut lints = self.linter.lint(&self.document);
+ self.ignored_lints
+ .remove_ignored(&mut lints, &self.document);
lints_to_diagnostics(self.document.get_full_content(), &lints, severity)
}
@@ -29,6 +36,9 @@ impl DocumentState {
code_action_config: &CodeActionConfig,
) -> Vec<CodeActionOrCommand> {
let mut lints = self.linter.lint(&self.document);
+ self.ignored_lints
+ .remove_ignored(&mut lints, &self.document);
+
lints.sort_by_key(|l| l.priority);
let source_chars = self.document.get_full_content();
@@ -69,6 +79,7 @@ impl Default for DocumentState {
dict: Default::default(),
linter: Default::default(),
language_id: Default::default(),
+ ignored_lints: Default::default(),
url: Url::parse("https://example.net").unwrap(),
}
}