Skip to content

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

feat(core): get more context in `IgnoredLints`

Elijah Potterb7d626788768
diff --git a/harper-core/src/fat_token.rs b/harper-core/src/fat_token.rs
index 26db3b52e..9f1fbd830 100644
--- a/harper-core/src/fat_token.rs
+++ b/harper-core/src/fat_token.rs
@@ -4,7 +4,7 @@ use crate::TokenKind;
/// A [`Token`](crate::Token) that holds its content as a fat [`Vec<char>`] rather than as a
/// [`Span`](crate::Span).
-#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, PartialOrd)]
+#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, PartialOrd, Hash)]
pub struct FatToken {
pub content: Vec<char>,
pub kind: TokenKind,
diff --git a/harper-core/src/ignored_lints/lint_context.rs b/harper-core/src/ignored_lints/lint_context.rs
new file mode 100644
index 000000000..9487cc4b8
--- /dev/null
+++ b/harper-core/src/ignored_lints/lint_context.rs
@@ -0,0 +1,54 @@
+use serde::{Deserialize, Serialize};
+
+use crate::{
+ linting::{Lint, LintKind, Suggestion},
+ Document, FatToken,
+};
+
+/// A location-agnostic structure that attempts to captures the context and content that a [`Lint`]
+/// occurred.
+#[derive(Debug, Hash, Serialize, Deserialize)]
+pub struct LintContext {
+ pub lint_kind: LintKind,
+ pub suggestions: Vec<Suggestion>,
+ pub message: String,
+ pub priority: u8,
+ pub tokens: Vec<FatToken>,
+}
+
+impl LintContext {
+ pub fn from_lint(lint: &Lint, document: &Document) -> Self {
+ let Lint {
+ lint_kind,
+ suggestions,
+ message,
+ priority,
+ ..
+ } = lint.clone();
+
+ 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 tokens = prequel_tokens
+ .into_iter()
+ .chain(problem_tokens)
+ .chain(sequel_tokens)
+ .flat_map(|idx| document.get_token(idx))
+ .map(|t| t.to_fat(document.get_source()))
+ .collect();
+
+ Self {
+ lint_kind,
+ suggestions,
+ message,
+ priority,
+ tokens,
+ }
+ }
+}
diff --git a/harper-core/src/ignored_lints.rs b/harper-core/src/ignored_lints/mod.rs
similarity index 79%
rename from harper-core/src/ignored_lints.rs
rename to harper-core/src/ignored_lints/mod.rs
index 66480fb72..86b97fbcf 100644
--- a/harper-core/src/ignored_lints.rs
+++ b/harper-core/src/ignored_lints/mod.rs
@@ -1,6 +1,9 @@
+mod lint_context;
+
use std::hash::{DefaultHasher, Hash, Hasher};
use hashbrown::HashSet;
+use lint_context::LintContext;
use serde::{Deserialize, Serialize};
use crate::{linting::Lint, Document};
@@ -22,26 +25,10 @@ impl IgnoredLints {
}
fn hash_lint_context(&self, lint: &Lint, document: &Document) -> u64 {
- 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 context = LintContext::from_lint(lint, document);
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();
- lint_hash.hash(&mut hasher);
+ context.hash(&mut hasher);
hasher.finish()
}