Skip to content

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

feat(wp): add dialect select

Elijah Potterc5f0249034f0
diff --git a/packages/harper.js/src/Linter.ts b/packages/harper.js/src/Linter.ts
index 0b2714d33..6ba9f136d 100644
--- a/packages/harper.js/src/Linter.ts
+++ b/packages/harper.js/src/Linter.ts
@@ -74,6 +74,9 @@ export default interface Linter {
/** Get the dialect of English this linter was constructed for. */
getDialect(): Promise<Dialect>;
+
+ /** Get the dialect of English this linter was constructed for. */
+ setDialect(dialect: Dialect): Promise<void>;
}
export interface LinterInit {
diff --git a/packages/harper.js/src/LocalLinter.ts b/packages/harper.js/src/LocalLinter.ts
index c7bb83561..2ae0acff4 100644
--- a/packages/harper.js/src/LocalLinter.ts
+++ b/packages/harper.js/src/LocalLinter.ts
@@ -12,9 +12,13 @@ export default class LocalLinter implements Linter {
constructor(init: LinterInit) {
this.binary = init.binary;
- this.inner = LazyPromise.from(async () => {
+ this.inner = this.createInner(init.dialect);
+ }
+
+ private createInner(dialect?: Dialect): Promise<WasmLinter> {
+ return LazyPromise.from(async () => {
await this.binary.setup();
- return this.binary.createLinter(init.dialect);
+ return this.binary.createLinter(dialect);
});
}
@@ -126,4 +130,14 @@ export default class LocalLinter implements Linter {
return inner.get_dialect();
}
+
+ async setDialect(dialect: Dialect): Promise<void> {
+ const inner = await this.inner;
+
+ if (inner.get_dialect() != dialect) {
+ this.inner = this.createInner(dialect);
+ }
+
+ return Promise.resolve();
+ }
}
diff --git a/packages/harper.js/src/WorkerLinter/index.ts b/packages/harper.js/src/WorkerLinter/index.ts
index f927f9720..eb12f4109 100644
--- a/packages/harper.js/src/WorkerLinter/index.ts
+++ b/packages/harper.js/src/WorkerLinter/index.ts
@@ -144,6 +144,10 @@ export default class WorkerLinter implements Linter {
return this.rpc('getDialect', []);
}
+ setDialect(dialect: Dialect): Promise<void> {
+ return this.rpc('setDialect', [dialect]);
+ }
+
/** Run a procedure on the remote worker. */
private async rpc(procName: string, args: any[]): Promise<any> {
const promise = new Promise((resolve, reject) => {
diff --git a/packages/wordpress-plugin/src/harper/DialectSelectRow.tsx b/packages/wordpress-plugin/src/harper/DialectSelectRow.tsx
new file mode 100644
index 000000000..2dd3c160c
--- /dev/null
+++ b/packages/wordpress-plugin/src/harper/DialectSelectRow.tsx
@@ -0,0 +1,38 @@
+import useDialect from './useDialect';
+import { SelectControl } from '@wordpress/components';
+import { Dialect } from 'harper.js';
+import React from 'react';
+
+export default function DialectSelectRow() {
+ const [dialect, setDialect] = useDialect();
+
+ return (
+ <div>
+ <h3>Dialect</h3>
+ <p>Choose which English dialect Harper should expect.</p>
+ <SelectControl
+ label="Dialect"
+ value={dialect.toString()}
+ options={[
+ {
+ label: 'American',
+ value: Dialect.American.toString()
+ },
+ {
+ label: 'Canadian',
+ value: Dialect.Canadian.toString()
+ },
+ {
+ label: 'Australian',
+ value: Dialect.Australian.toString()
+ },
+ {
+ label: 'British',
+ value: Dialect.British.toString()
+ }
+ ]}
+ onChange={(value) => setDialect(parseInt(value))}
+ ></SelectControl>
+ </div>
+ );
+}
diff --git a/packages/wordpress-plugin/src/harper/SidebarTabContainer.tsx b/packages/wordpress-plugin/src/harper/SidebarTabContainer.tsx
index b7a23d7c3..6cc0da8c5 100644
--- a/packages/wordpress-plugin/src/harper/SidebarTabContainer.tsx
+++ b/packages/wordpress-plugin/src/harper/SidebarTabContainer.tsx
@@ -1,6 +1,7 @@
import React from 'react';
import LintSettingList from './LintSettingList';
-import { Panel, PanelBody, TabPanel } from '@wordpress/components';
+import DialectSelectRow from './DialectSelectRow';
+import { Panel, PanelBody, SelectControl, TabPanel } from '@wordpress/components';
import LintList from './LintList';
import { IgnorableLintBox } from './Box';
@@ -26,6 +27,7 @@ export default function SidebarTabContainer({
return (
<Panel>
<PanelBody title="Rules">
+ <DialectSelectRow />
<LintSettingList />
</PanelBody>
</Panel>
diff --git a/packages/wordpress-plugin/src/harper/useDialect.ts b/packages/wordpress-plugin/src/harper/useDialect.ts
new file mode 100644
index 000000000..bbb521846
--- /dev/null
+++ b/packages/wordpress-plugin/src/harper/useDialect.ts
@@ -0,0 +1,24 @@
+import { useDispatch, useSelect } from '@wordpress/data';
+import { Dialect } from 'harper.js';
+import { useCallback, useMemo } from 'react';
+
+const KEY = 'dialect';
+
+export default function useDialect(): [Dialect, (newState: Dialect) => void] {
+ const dialect = useSelect((select) => select('core/preferences').get('harper-wp', KEY), []);
+
+ const { set } = useDispatch('core/preferences');
+
+ const setConfig = useCallback((newValue) => {
+ set('harper-wp', KEY, newValue);
+ }, []);
+
+ const nonNull = useMemo(() => {
+ if (dialect == null) {
+ return Dialect.American;
+ }
+ return dialect;
+ }, [dialect]);
+
+ return [nonNull, setConfig];
+}
diff --git a/packages/wordpress-plugin/src/harper/useLintBoxes.ts b/packages/wordpress-plugin/src/harper/useLintBoxes.ts
index a4f5360d0..3d1bc8fc8 100644
--- a/packages/wordpress-plugin/src/harper/useLintBoxes.ts
+++ b/packages/wordpress-plugin/src/harper/useLintBoxes.ts
@@ -6,6 +6,7 @@ import { Lint } from 'harper.js';
import { useLinter } from './LinterProvider';
import useLintConfig from './useLintConfig';
import useIgnoredLintState, { useIgnoreLint } from './useIgnoredLintState';
+import useDialect from './useDialect';
/**
* Lint given elements and return the resulting error targets.
@@ -15,6 +16,7 @@ import useIgnoredLintState, { useIgnoreLint } from './useIgnoredLintState';
export default function useLintBoxes(richTexts: RichText[]): [IgnorableLintBox[][], boolean] {
const linter = useLinter();
const [config] = useLintConfig();
+ const [dialect] = useDialect();
const [ignoreState] = useIgnoredLintState();
const [personalDictionary] = usePersonalDictionary();
const ignoreLint = useIgnoreLint();
@@ -28,6 +30,10 @@ export default function useLintBoxes(richTexts: RichText[]): [IgnorableLintBox[]
await linter.clearIgnoredLints();
}
+ console.log(dialect);
+
+ await linter.setDialect(dialect);
+
if (personalDictionary) {
await linter.importWords(personalDictionary);
}
@@ -51,7 +57,7 @@ export default function useLintBoxes(richTexts: RichText[]): [IgnorableLintBox[]
setLoading(false);
setLints(newLints);
- }, [richTexts, linter, config, ignoreState, personalDictionary]);
+ }, [richTexts, linter, config, ignoreState, personalDictionary, dialect]);
useEffect(() => {
updateLints();