Offline, privacy-first grammar checker. Fast, open-source, Rust-powered
feat(harper.js): pass entire summary out
Elijah Pottera24bc190e8e3
diff --git a/harper-stats/src/summary.rs b/harper-stats/src/summary.rsindex 04bbbfad2..dcfa51b1d 100644--- a/harper-stats/src/summary.rs+++ b/harper-stats/src/summary.rs@@ -1,8 +1,9 @@use std::{collections::HashMap, fmt::Display};use harper_core::linting::{LintGroupConfig, LintKind};+use serde::{Deserialize, Serialize};-#[derive(Debug, Default)]+#[derive(Debug, Default, Serialize, Deserialize)]pub struct Summary {pub lint_counts: HashMap<LintKind, u32>,pub total_applied: u32,diff --git a/harper-wasm/src/lib.rs b/harper-wasm/src/lib.rsindex faacf2299..6fdc80b77 100644--- a/harper-wasm/src/lib.rs+++ b/harper-wasm/src/lib.rs@@ -1,6 +1,5 @@#![doc = include_str!("../README.md")]-use std::collections::HashMap;use std::convert::Into;use std::io::Cursor;use std::sync::Arc;@@ -14,6 +13,7 @@ use harper_core::{};use harper_stats::{Record, RecordKind, Stats};use serde::{Deserialize, Serialize};+use serde_wasm_bindgen::Serializer;use wasm_bindgen::JsValue;use wasm_bindgen::prelude::wasm_bindgen;@@ -179,20 +179,15 @@ impl Linter {operable_copy.records.retain(|i| i.when < end_time);}- serde_wasm_bindgen::to_value(- &operable_copy- .summarize()- .lint_counts- .iter()- .map(|(key, value)| (key.to_string_key(), *value))- .collect::<HashMap<_, _>>(),- )- .unwrap()+ operable_copy+ .summarize()+ .serialize(&Serializer::json_compatible())+ .unwrap()}/// Get a Record containing the descriptions of all the linting rules.pub fn get_lint_descriptions_as_object(&self) -> JsValue {- let serializer = serde_wasm_bindgen::Serializer::json_compatible();+ let serializer = Serializer::json_compatible();self.lint_group.all_descriptions().serialize(&serializer)@@ -201,7 +196,7 @@ impl Linter {pub fn get_lint_config_as_object(&self) -> JsValue {// Important for downstream JSON serialization- let serializer = serde_wasm_bindgen::Serializer::json_compatible();+ let serializer = Serializer::json_compatible();self.lint_group.config.serialize(&serializer).unwrap()}@@ -470,7 +465,7 @@ pub fn get_default_lint_config() -> JsValue {LintGroup::new_curated(MutableDictionary::new().into(), Dialect::American.into()).config;// Important for downstream JSON serialization- let serializer = serde_wasm_bindgen::Serializer::json_compatible();+ let serializer = Serializer::json_compatible();config.serialize(&serializer).unwrap()}diff --git a/packages/harper.js/src/Linter.test.ts b/packages/harper.js/src/Linter.test.tsindex e9ad24887..f333a9d81 100644--- a/packages/harper.js/src/Linter.test.ts+++ b/packages/harper.js/src/Linter.test.ts@@ -209,7 +209,7 @@ for (const [linterName, Linter] of Object.entries(linters)) {expect(applied).toBe('This is a test.');const summary = await linter.summarizeStats();- expect(summary).toBeTypeOf('object');+ expect(summary).toBeTypeOf('object');});test(`${linterName} can save and restore stat records`, async () => {diff --git a/packages/harper.js/src/Linter.ts b/packages/harper.js/src/Linter.tsindex b030bea5c..5002c7155 100644--- a/packages/harper.js/src/Linter.ts+++ b/packages/harper.js/src/Linter.ts@@ -82,7 +82,7 @@ export default interface Linter {* You may optionally pass in a start and/or end time.** If so, the summary with only include data from a _after_ the start time but _before_ the end time. */- summarizeStats(start?: bigint, end?: bigint): Promise<Record<string, number>>;+ summarizeStats(start?: bigint, end?: bigint): Promise<any>;/** Generate a statistics log file you can save to permanent storage. */generateStatsFile(): Promise<string>;diff --git a/packages/harper.js/src/LocalLinter.ts b/packages/harper.js/src/LocalLinter.tsindex 8234a9d90..e52eeaab2 100644--- a/packages/harper.js/src/LocalLinter.ts+++ b/packages/harper.js/src/LocalLinter.ts@@ -143,7 +143,7 @@ export default class LocalLinter implements Linter {return Promise.resolve();}- async summarizeStats(start?: bigint, end?: bigint): Promise<Record<string, number>> {+ async summarizeStats(start?: bigint, end?: bigint): Promise<any> {const inner = await this.inner;return inner.summarize_stats(start, end);}diff --git a/packages/harper.js/src/WorkerLinter/index.ts b/packages/harper.js/src/WorkerLinter/index.tsindex f75240b31..e7afe49d9 100644--- a/packages/harper.js/src/WorkerLinter/index.ts+++ b/packages/harper.js/src/WorkerLinter/index.ts@@ -149,7 +149,7 @@ export default class WorkerLinter implements Linter {return this.rpc('setDialect', [dialect]);}- summarizeStats(start?: bigint, end?: bigint): Promise<Record<string, number>> {+ summarizeStats(start?: bigint, end?: bigint): Promise<any> {return this.rpc('summarizeStats', [start, end]);}diff --git a/packages/harper.js/src/binary.ts b/packages/harper.js/src/binary.tsindex 74164dcb9..55847ee9e 100644--- a/packages/harper.js/src/binary.ts+++ b/packages/harper.js/src/binary.ts@@ -30,7 +30,7 @@ export type SerializableTypes =| 'string'| 'number'| 'boolean'- | 'object'+ | 'object'| 'Suggestion'| 'Lint'| 'Span'@@ -140,9 +140,9 @@ export class BinaryModule {return { json, type };}- if (argType == 'object'){- return { json: JSON.stringify(arg), type: 'object'}- }+ if (argType == 'object') {+ return { json: JSON.stringify(arg), type: 'object' };+ }throw new Error(`Unhandled case: ${arg}`);}@@ -175,10 +175,10 @@ export class BinaryModule {assert(Array.isArray(parsed));return await Promise.all(parsed.map((arg) => this.deserializeArg(arg)));}- case 'object': {+ case 'object': {const parsed = JSON.parse(requestArg.json);return parsed;- }+ }default:throw new Error(`Unhandled case: ${requestArg.type}`);}