Skip to content

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

feat(harper.js): added ability to explicitly set config to the default

Elijah Potterad58c1050750
diff --git a/harper-wasm/src/lib.rs b/harper-wasm/src/lib.rs
index 7343462ee..a1da7d5a7 100644
--- a/harper-wasm/src/lib.rs
+++ b/harper-wasm/src/lib.rs
@@ -105,6 +105,10 @@ impl Linter {
self.lint_group.config.serialize(&serializer).unwrap()
}
+ pub fn fill_lint_config_with_default(&mut self) {
+ self.lint_group.config.fill_default_values();
+ }
+
pub fn set_lint_config_from_object(&mut self, object: JsValue) -> Result<(), String> {
self.lint_group.config =
serde_wasm_bindgen::from_value(object).map_err(|v| v.to_string())?;
diff --git a/packages/harper.js/src/Linter.test.ts b/packages/harper.js/src/Linter.test.ts
index ef7086616..e576a8ef7 100644
--- a/packages/harper.js/src/Linter.test.ts
+++ b/packages/harper.js/src/Linter.test.ts
@@ -121,6 +121,18 @@ for (const [linterName, Linter] of Object.entries(linters)) {
expect(value).not.toHaveLength(0);
}
});
+
+ test(`${linterName} default lint config has no null values`, async () => {
+ const linter = new Linter();
+
+ await linter.setLintConfigToDefault();
+
+ const lintConfig = await linter.getLintConfig();
+
+ for (const value of Object.values(lintConfig)) {
+ expect(value).not.toBeNull();
+ }
+ });
}
test('Linters have the same config format', async () => {
diff --git a/packages/harper.js/src/Linter.ts b/packages/harper.js/src/Linter.ts
index 6febf738f..ee7a312c1 100644
--- a/packages/harper.js/src/Linter.ts
+++ b/packages/harper.js/src/Linter.ts
@@ -25,6 +25,9 @@ export default interface Linter {
/** Get the linter's current configuration. */
getLintConfig(): Promise<LintConfig>;
+ /** Set the linter's current configuration to the official Harper default. */
+ setLintConfigToDefault(): Promise<void>;
+
/** Set the linter's current configuration. */
setLintConfig(config: LintConfig): Promise<void>;
diff --git a/packages/harper.js/src/LocalLinter.ts b/packages/harper.js/src/LocalLinter.ts
index 8f9031e0c..169386f25 100644
--- a/packages/harper.js/src/LocalLinter.ts
+++ b/packages/harper.js/src/LocalLinter.ts
@@ -84,4 +84,10 @@ export default class LocalLinter implements Linter {
await this.initialize();
return this.inner!.get_lint_descriptions_as_json();
}
+
+ async setLintConfigToDefault(): Promise<void> {
+ await this.initialize();
+
+ this.inner?.fill_lint_config_with_default();
+ }
}
diff --git a/packages/harper.js/src/WorkerLinter/index.ts b/packages/harper.js/src/WorkerLinter/index.ts
index 7710140c7..89d825bca 100644
--- a/packages/harper.js/src/WorkerLinter/index.ts
+++ b/packages/harper.js/src/WorkerLinter/index.ts
@@ -106,6 +106,10 @@ export default class WorkerLinter implements Linter {
return JSON.parse(await this.getLintDescriptionsAsJSON()) as Record<string, string>;
}
+ setLintConfigToDefault(): Promise<void> {
+ return this.rpc('setLintConfigToDefault', []);
+ }
+
/** Run a procedure on the remote worker. */
private async rpc(procName: string, args: any[]): Promise<any> {
const promise = new Promise((resolve, reject) => {