Offline, privacy-first grammar checker. Fast, open-source, Rust-powered
feat: added obsidian plugin to build scripts
Elijah Potter4a5f7c8e931b
diff --git a/Dockerfile b/Dockerfileindex c999e8124..1a74546e7 100644--- a/Dockerfile+++ b/Dockerfile@@ -18,7 +18,7 @@ WORKDIR /usr/build/RUN mkdir harper-wasmCOPY --from=wasm-build /usr/build/harper-wasm/pkg /usr/build/harper-wasm/pkg-COPY web web+COPY packages/web webCOPY demo.md .WORKDIR /usr/build/webdiff --git a/harper-core/src/linting/matcher.rs b/harper-core/src/linting/matcher.rsindex 9745fa381..6f7b6f68a 100644--- a/harper-core/src/linting/matcher.rs+++ b/harper-core/src/linting/matcher.rs@@ -4,7 +4,7 @@ use crate::{Document, Lint, LintKind, Linter, Punctuation, Span, Suggestion, Tok#[derive(Debug, PartialEq, PartialOrd, Clone)]struct PatternToken {kind: TokenKind,- content: Option<DictWord>,+ content: Option<DictWord>}impl PatternToken {@@ -12,12 +12,12 @@ impl PatternToken {if token.kind.is_word() {Self {kind: token.kind,- content: Some(document.get_span_content(token.span).into()),+ content: Some(document.get_span_content(token.span).into())}} else {Self {kind: token.kind,- content: None,+ content: None}}}@@ -85,13 +85,13 @@ macro_rules! pt {struct Rule {pattern: Vec<PatternToken>,- replace_with: Vec<char>,+ replace_with: Vec<char>}/// A linter that uses a variety of curated pattern matches to find and fix/// common grammatical issues.pub struct Matcher {- triggers: Vec<Rule>,+ triggers: Vec<Rule>}impl Matcher {@@ -199,24 +199,24 @@ impl Matcher {// We need to be more explicit that we are replacing with an Em dashtriggers.push(Rule {pattern: vec![pt!(Hyphen), pt!(Hyphen), pt!(Hyphen)],- replace_with: vecword!("—"),+ replace_with: vecword!("—")});// Same goes for this En dashtriggers.push(Rule {pattern: vec![pt!(Hyphen), pt!(Hyphen)],- replace_with: vecword!("–"),+ replace_with: vecword!("–")});// And this ellipsistriggers.push(Rule {pattern: vec![pt!(Period), pt!(Period), pt!(Period)],- replace_with: vecword!("…"),+ replace_with: vecword!("…")});triggers.push(Rule {pattern: vec![pt!("L"), pt!(Period), pt!("L"), pt!(Period), pt!("M")],- replace_with: vecword!("large language model"),+ replace_with: vecword!("large language model")});triggers.push(Rule {@@ -228,7 +228,7 @@ impl Matcher {pt!("M"),pt!(Period),],- replace_with: vecword!("large language model"),+ replace_with: vecword!("large language model")});Self { triggers }@@ -268,7 +268,7 @@ impl Linter for Matcher {if match_tokens.len() == trigger.pattern.len() && !match_tokens.is_empty() {let span = Span::new(match_tokens.first().unwrap().span.start,- match_tokens.last().unwrap().span.end,+ match_tokens.last().unwrap().span.end);lints.push(Lint {@@ -279,7 +279,7 @@ impl Linter for Matcher {"Did you mean “{}”?",trigger.replace_with.iter().collect::<String>()),- priority: 15,+ priority: 15})}}diff --git a/harper-ls/src/tree_sitter_parser.rs b/harper-ls/src/tree_sitter_parser.rsindex 45aaaff0a..c3ee76920 100644--- a/harper-ls/src/tree_sitter_parser.rs+++ b/harper-ls/src/tree_sitter_parser.rs@@ -10,7 +10,7 @@ use super::comment_parsers::{Go, Unit};/// exclusively parses comments in any language supported by [`tree_sitter`].pub struct TreeSitterParser {language: Language,- comment_parser: Box<dyn Parser>,+ comment_parser: Box<dyn Parser>}impl TreeSitterParser {@@ -33,17 +33,17 @@ impl TreeSitterParser {"cs" => tree_sitter_c_sharp::language(),"toml" => tree_sitter_toml::language(),"lua" => tree_sitter_lua::language(),- _ => return None,+ _ => return None};let comment_parser: Box<dyn Parser> = match file_extension {"go" => Box::new(Go),- _ => Box::new(Unit),+ _ => Box::new(Unit)};Some(Self {language,- comment_parser,+ comment_parser})}diff --git a/harper-wasm/src/lib.rs b/harper-wasm/src/lib.rsindex 4041fdfc1..70389e33e 100644--- a/harper-wasm/src/lib.rs+++ b/harper-wasm/src/lib.rs@@ -9,7 +9,7 @@ use wasm_bindgen::JsValue;static LINTER: Lazy<Mutex<LintGroup<FullDictionary>>> = Lazy::new(|| {Mutex::new(LintGroup::new(Default::default(),- FullDictionary::create_from_curated(),+ FullDictionary::create_from_curated()))});@@ -63,7 +63,7 @@ pub fn parse(text: String) -> Vec<JsValue> {pub fn apply_suggestion(text: String,span: JsValue,- suggestion: JsValue,+ suggestion: JsValue) -> Result<String, String> {let span = serde_wasm_bindgen::from_value(span).map_err(|e| e.to_string())?;let suggestion = serde_wasm_bindgen::from_value(suggestion).map_err(|e| e.to_string())?;diff --git a/packages/obsidian-plugin/README.md b/packages/obsidian-plugin/README.mdnew file mode 100644index 000000000..a1875c1ae--- /dev/null+++ b/packages/obsidian-plugin/README.md@@ -0,0 +1,11 @@+# Obsidian Plugin++This directory contains the source code for the [Obsidian](https://obsidian.md/) plugin.++## Building++In order to build the plugin, you must first compile `harper-wasm` with:++```bash+wasm-pack build --target web+```diff --git a/packages/obsidian-plugin/rollup.config.mjs b/packages/obsidian-plugin/rollup.config.mjsindex 6d0b2d697..afb2e7686 100644--- a/packages/obsidian-plugin/rollup.config.mjs+++ b/packages/obsidian-plugin/rollup.config.mjs@@ -1,26 +1,29 @@-import { wasm } from '@rollup/plugin-wasm';-import { nodeResolve } from '@rollup/plugin-node-resolve';+import { wasm } from "@rollup/plugin-wasm";+import { nodeResolve } from "@rollup/plugin-node-resolve";export default {- input: 'src/main.js',- output: {- dir: '.',- format: 'cjs'- },- external: [- "obsidian",- "electron",- "@codemirror/autocomplete",- "@codemirror/collab",- "@codemirror/commands",- "@codemirror/language",- "@codemirror/lint",- "@codemirror/search",- "@codemirror/state",- "@codemirror/view",- "@lezer/common",- "@lezer/highlight",- "@lezer/lr",- ],- plugins: [wasm({ maxFileSize: Math.pow(2, 32), publicPath: "./" }), nodeResolve()]+ input: "src/main.js",+ output: {+ dir: ".",+ format: "cjs",+ },+ external: [+ "obsidian",+ "electron",+ "@codemirror/autocomplete",+ "@codemirror/collab",+ "@codemirror/commands",+ "@codemirror/language",+ "@codemirror/lint",+ "@codemirror/search",+ "@codemirror/state",+ "@codemirror/view",+ "@lezer/common",+ "@lezer/highlight",+ "@lezer/lr",+ ],+ plugins: [+ wasm({ maxFileSize: Math.pow(2, 32), publicPath: "./" }),+ nodeResolve(),+ ],};diff --git a/packages/obsidian-plugin/src/main.js b/packages/obsidian-plugin/src/main.jsindex 945ae1ea9..0b48866c1 100644--- a/packages/obsidian-plugin/src/main.js+++ b/packages/obsidian-plugin/src/main.js@@ -1,65 +1,63 @@import { linter } from "@codemirror/lint";import { Plugin } from "obsidian";-import { EditorView } from "@codemirror/view"+import { EditorView } from "@codemirror/view";import wasm from "wasm/harper_wasm_bg.wasm";import init, { lint, use_spell_check } from "wasm";function contentToString(content) {- return content.reduce((p, c) => p + c, "");+ return content.reduce((p, c) => p + c, "");}function suggestionToLabel(sug) {- if (sug === "Remove") {- return "Remove";- } else {- return `Replace with "${contentToString(sug.ReplaceWith)}"`;- }+ if (sug === "Remove") {+ return "Remove";+ } else {+ return `Replace with "${contentToString(sug.ReplaceWith)}"`;+ }}const harperLinter = linter(- async (view) => {- let text = view.state.doc.sliceString(-1);+ async (view) => {+ let text = view.state.doc.sliceString(-1);await init(await wasm());use_spell_check(false);- let lints = lint(text);+ let lints = lint(text);- return lints.map((lint) => {- return {- from: lint.span.start,- to: lint.span.end,- severity: "error",- message: lint.message,- actions: lint.suggestions.map((sug, i) => {- return {- name: suggestionToLabel(sug),- apply: (view) => {- if (sug === "Remove") {- view.dispatch({- changes: {- from: lint.span.start,- to: lint.span.end,- insert: "",- },- });- } else {- view.dispatch({- changes: {- from: lint.span.start,- to: lint.span.end,- insert: contentToString(- sug.ReplaceWith,- ),- },- });- }- },- };- }),- };- });- },- { delay: -1 },+ return lints.map((lint) => {+ return {+ from: lint.span.start,+ to: lint.span.end,+ severity: "error",+ message: lint.message,+ actions: lint.suggestions.map((sug, i) => {+ return {+ name: suggestionToLabel(sug),+ apply: (view) => {+ if (sug === "Remove") {+ view.dispatch({+ changes: {+ from: lint.span.start,+ to: lint.span.end,+ insert: "",+ },+ });+ } else {+ view.dispatch({+ changes: {+ from: lint.span.start,+ to: lint.span.end,+ insert: contentToString(sug.ReplaceWith),+ },+ });+ }+ },+ };+ }),+ };+ });+ },+ { delay: -1 },);const theme = EditorView.baseTheme({@@ -87,12 +85,12 @@ const theme = EditorView.baseTheme({whiteSpace: "nowrap !important",backgroundColor: "white !important",color: "black !important",- width: "100%"+ width: "100%",},".cm-diagnosticSource": {fontSize: "70%",- opacity: .7+ opacity: 0.7,},".cm-tooltip-lint": {@@ -122,23 +120,23 @@ const theme = EditorView.baseTheme({left: "-2px",borderLeft: "3px solid transparent",borderRight: "3px solid transparent",- borderBottom: "4px solid #d11"- }+ borderBottom: "4px solid #d11",+ },},".cm-lintPoint-warning": {- "&:after": { borderBottomColor: "orange" }+ "&:after": { borderBottomColor: "orange" },},".cm-lintPoint-info": {- "&:after": { borderBottomColor: "#999" }+ "&:after": { borderBottomColor: "#999" },},".cm-lintPoint-hint": {- "&:after": { borderBottomColor: "#66d" }+ "&:after": { borderBottomColor: "#66d" },},-})+});export default class HarperPlugin extends Plugin {- async onload() {- this.registerEditorExtension([harperLinter, theme]);- }+ async onload() {+ this.registerEditorExtension([harperLinter, theme]);+ }}diff --git a/packages/obsidian-plugin/yarn.lock b/packages/obsidian-plugin/yarn.lockindex ecbbb84c5..7bd1b21c3 100644--- a/packages/obsidian-plugin/yarn.lock+++ b/packages/obsidian-plugin/yarn.lock@@ -202,5 +202,6 @@ supports-preserve-symlinks-flag@^1.0.0:resolved "https://registry.yarnpkg.com/supports-preserve-symlinks-flag/-/supports-preserve-symlinks-flag-1.0.0.tgz#6eda4bd344a3c94aea376d4cc31bc77311039e09"integrity sha512-ot0WnXS9fgdkgIcePe6RHNk1WA8+muPa6cSjeR3V8K27q9BB1rTE3R1p7Hv0z1ZyAc8s6Vvv8DIyWf681MAt0w==-"wasm@file:../../../../Projects/harper/harper-wasm/pkg":- version "0.1.0"+"wasm@link:../../harper-wasm/pkg":+ version "0.0.0"+ uid ""diff --git a/packages/web/README.md b/packages/web/README.mdnew file mode 100644index 000000000..e74f0a1e4--- /dev/null+++ b/packages/web/README.md@@ -0,0 +1,11 @@+# Web++This directory contains the source code for [https://writewithharper.com].++## Building++In order to build the site, you must first compile `harper-wasm` with:++```bash+wasm-pack build --target bundler+```diff --git a/packages/web/package.json b/packages/web/package.jsonindex 24996fe72..716046879 100644--- a/packages/web/package.json+++ b/packages/web/package.json@@ -1,47 +1,47 @@{- "name": "harper-web",- "version": "0.0.1",- "private": true,- "scripts": {- "dev": "vite dev",- "build": "vite build",- "preview": "vite preview",- "check": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json",- "check:watch": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json --watch",- "lint": "prettier --check . && eslint .",- "format": "prettier --write ."- },- "devDependencies": {- "@flydotio/dockerfile": "^0.5.0",- "@sveltejs/adapter-node": "^3.0.3",- "@sveltejs/kit": "^1.20.4",- "@typescript-eslint/eslint-plugin": "^6.0.0",- "@typescript-eslint/parser": "^6.0.0",- "autoprefixer": "^10.4.16",- "eslint": "^8.28.0",- "eslint-config-prettier": "^9.0.0",- "eslint-plugin-prettier": "^5.0.1",- "eslint-plugin-svelte": "^2.34.0",- "flowbite": "^1.8.1",- "flowbite-svelte": "^0.44.18",- "postcss": "^8.4.31",- "prettier": "^3.0.3",- "prettier-plugin-svelte": "^3.0.3",- "svelte": "^4.0.5",- "svelte-check": "^3.4.3",- "tailwindcss": "^3.3.3",- "tslib": "^2.4.1",- "typescript": "^5.0.0",- "vite": "^4.4.2",- "vite-plugin-top-level-await": "^1.4.1",- "vite-plugin-wasm": "^3.3.0"- },- "type": "module",- "dependencies": {- "wasm": "link:../harper-wasm/pkg",- "@codemirror/lint": "^6.5.0",- "@codemirror/state": "^6.4.1",- "codemirror": "^6.0.1",- "lodash-es": "^4.17.21"- }+ "name": "harper-web",+ "version": "0.0.1",+ "private": true,+ "scripts": {+ "dev": "vite dev",+ "build": "vite build",+ "preview": "vite preview",+ "check": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json",+ "check:watch": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json --watch",+ "lint": "prettier --check . && eslint .",+ "format": "prettier --write ."+ },+ "devDependencies": {+ "@flydotio/dockerfile": "^0.5.0",+ "@sveltejs/adapter-node": "^3.0.3",+ "@sveltejs/kit": "^1.20.4",+ "@typescript-eslint/eslint-plugin": "^6.0.0",+ "@typescript-eslint/parser": "^6.0.0",+ "autoprefixer": "^10.4.16",+ "eslint": "^8.28.0",+ "eslint-config-prettier": "^9.0.0",+ "eslint-plugin-prettier": "^5.0.1",+ "eslint-plugin-svelte": "^2.34.0",+ "flowbite": "^1.8.1",+ "flowbite-svelte": "^0.44.18",+ "postcss": "^8.4.31",+ "prettier": "^3.0.3",+ "prettier-plugin-svelte": "^3.0.3",+ "svelte": "^4.0.5",+ "svelte-check": "^3.4.3",+ "tailwindcss": "^3.3.3",+ "tslib": "^2.4.1",+ "typescript": "^5.0.0",+ "vite": "^4.4.2",+ "vite-plugin-top-level-await": "^1.4.1",+ "vite-plugin-wasm": "^3.3.0"+ },+ "type": "module",+ "dependencies": {+ "wasm": "link:../../harper-wasm/pkg",+ "@codemirror/lint": "^6.5.0",+ "@codemirror/state": "^6.4.1",+ "codemirror": "^6.0.1",+ "lodash-es": "^4.17.21"+ }}diff --git a/packages/web/src/lib/NewEditor.svelte b/packages/web/src/lib/NewEditor.svelteindex 970e35881..caa88282e 100644--- a/packages/web/src/lib/NewEditor.svelte+++ b/packages/web/src/lib/NewEditor.svelte@@ -3,7 +3,7 @@import { minimalSetup, EditorView } from 'codemirror';import { contentToString, lintText, type Suggestion } from './analysis';import { linter } from '@codemirror/lint';- import demoText from '../../../demo.md?raw';+ import demoText from '../../../../demo.md?raw';import { Card } from 'flowbite-svelte';let editorDiv: HTMLDivElement;@@ -28,7 +28,7 @@to: lint.span.end,severity: 'error',message: lint.message,- actions: lint.suggestions.map((sug, i) => {+ actions: lint.suggestions.map((sug) => {return {name: suggestionToLabel(sug),apply: (view) => {diff --git a/packages/web/yarn.lock b/packages/web/yarn.lockindex decd26004..6871c9fb1 100644--- a/packages/web/yarn.lock+++ b/packages/web/yarn.lock@@ -2678,7 +2678,7 @@ w3c-keyname@^2.2.4:resolved "https://registry.yarnpkg.com/w3c-keyname/-/w3c-keyname-2.2.8.tgz#7b17c8c6883d4e8b86ac8aba79d39e880f8869c5"integrity sha512-dpojBhNsCNN7T82Tm7k26A6G9ML3NkhDsnw9n/eoxSRlVBB4CEtIQ/KTCLI2Fwf3ataSXRhYFkQi3SlnFwPvPQ==-"wasm@link:../harper-wasm/pkg":+"wasm@link:../../harper-wasm/pkg":version "0.0.0"uid ""diff --git a/precommit.sh b/precommit.shindex 302d3da0f..eecc085ba 100755--- a/precommit.sh+++ b/precommit.sh@@ -17,11 +17,18 @@ cargo build --releasecargo benchcd $R/harper-wasm-wasm-pack build+wasm-pack build --target bundler-cd $R/web-yarn install+cd $R/packages/web+yarn install -fyarn run format --checkyarn run lintyarn run checkyarn run build++cd $R/harper-wasm+wasm-pack build --target web++cd $R/packages/obsidian-plugin+yarn install -f+yarn run build