Eloquent is a proofreading software for English, Spanish, French, German, Portuguese, Polish, Dutch, and more than 20 other languages. It finds many errors that a simple spell checker cannot detect.
16 |It works fully offline, powered by LanguageTool standalone server.
17 |-
34 |
- Update LanguageTool from 6.5 to 20251204 35 |
- Fix background service 36 |
-
42 |
- Solve styling and placement issues with popover 43 |
- Use GNOME Platform 49 44 |
-
50 |
- Fix compatibity with Thunderbird 51 |
- Fix symbolic icon 52 |
-
58 |
- Improve language detection 59 |
- Runs LanguageTool as a service in the background 60 |
- Clean the list of languages 61 |
- Fix a small design bug in the status bar 62 |
This is the first release of Eloquent. We hope you like it.
68 |
2 |
3 | # Eloquent
4 |
5 | Your proofreading assistant
6 |
7 |
43 |
51 |
52 | Bookmarks
44 | 45 | - [Flathub](https://flathub.org/apps/re.sonny.Eloquent) 46 | - [Flathub repo](https://github.com/flathub/re.sonny.Eloquent) 47 | - [Flathub builds](https://flathub.org/builds/#/apps/re.sonny.Eloquent) 48 | - [Flathub stats](https://klausenbusk.github.io/flathub-stats/#ref=re.sonny.Eloquent) 49 | - [Flathub API](https://flathub.org/api/v1/apps/re.sonny.Eloquent) 50 |
53 |
54 |
76 |
77 | i18n
55 | 56 | ```sh 57 | # To update the pot file 58 | # xgettext -f po/POTFILES -o po/re.sonny.Eloquent.pot --no-wrap -cTRANSLATORS --from-code=UTF-8 59 | # sed -i "s/Project-Id-Version: PACKAGE VERSION/Project-Id-Version: re.sonny.Eloquent/" po/re.sonny.Eloquent.pot 60 | meson compile re.sonny.Eloquent-pot -C build 61 | 62 | 63 | # To create a translation 64 | # msginit -i po/re.sonny.Eloquent.pot -o po/fr.po -l fr_FR.UTF-8 65 | echo -n " fr" >> po/LINGUAS 66 | meson compile re.sonny.Eloquent-update-po -C build 67 | 68 | # To update translations 69 | # msgmerge -U po/*.po po/re.sonny.Eloquent.pot 70 | meson compile re.sonny.Eloquent-update-po -C build 71 | ``` 72 | 73 | See https://github.com/sonnyp/Commit/pull/14#issuecomment-894070878 74 | 75 |
78 |
79 |
89 |
90 | ## Copyright
91 |
92 | © 2025 [Sonny Piers](https://github.com/sonnyp)
93 |
94 | ## License
95 |
96 | GPLv3. Please see [COPYING](COPYING) file.
97 |
98 | ## Notes
99 |
100 | Grammer checker
101 |
102 | - https://github.com/btford/write-good (en)
103 | - https://grammalecte.net/ (fr)
104 | - https://github.com/languagetool-org/languagetool (multi)
105 | - https://1.6km.me/blog/2021/03/30/the-poor-mans-grammar-checker/
106 |
107 | NLP
108 |
109 | - https://web.archive.org/web/20230321055642/https://www.abisource.com/projects/link-grammar/
110 | - https://naturalnode.github.io/natural/
111 |
--------------------------------------------------------------------------------
/data/icons/re.sonny.Eloquent.svg:
--------------------------------------------------------------------------------
1 |
2 |
64 |
--------------------------------------------------------------------------------
/src/window.js:
--------------------------------------------------------------------------------
1 | import Gtk from "gi://Gtk";
2 | import Gio from "gi://Gio";
3 | import Gdk from "gi://Gdk";
4 | import Pango from "gi://Pango";
5 |
6 | import { build } from "troll";
7 |
8 | import { retry, unstack } from "./util.js";
9 | import { check } from "./languagetool.js";
10 | import DropdownLang from "./DropdownLang.js";
11 |
12 | import Interface from "./window.blp" assert { type: "uri" };
13 | import "./widgets/SuggestionPopover.js";
14 | import "./icons/check-round-outline-symbolic.svg" assert { type: "icon" };
15 |
16 | let diagnostics = [];
17 |
18 | export default function Window({ application }) {
19 | const {
20 | window,
21 | text_view,
22 | buffer,
23 | popover_suggestion,
24 | label_words,
25 | label_characters,
26 | label_status,
27 | spinner,
28 | image_ok,
29 | dropdown_langs,
30 | scrolled_window
31 | } = build(Interface);
32 |
33 | if (__DEV__) window.add_css_class("devel");
34 | window.set_application(application);
35 |
36 | popover_suggestion.buffer = buffer;
37 |
38 | // Hide the popover on scroll
39 | const vadjustment = scrolled_window.vadjustment;
40 | vadjustment.connect("value-changed", () => {
41 | popover_suggestion.popdown();
42 | });
43 |
44 | // Hide the popover on resize
45 | window.connect('notify::default-width', () => {
46 | popover_suggestion.popdown();
47 | });
48 | window.connect("notify::default-height", () => {
49 | popover_suggestion.popdown();
50 | });
51 |
52 | buffer.connect("notify::cursor-position", () => {
53 | const { cursor_position } = buffer;
54 |
55 | popover_suggestion.reset();
56 |
57 | const iter = buffer.get_iter_at_offset(cursor_position);
58 | const { tag, start, end } = getTag(iter);
59 | if (!tag) {
60 | popover_suggestion.popdown();
61 | return;
62 | }
63 |
64 | const match = getDiagnostic(start, end);
65 | if (!match) {
66 | popover_suggestion.popdown();
67 | return;
68 | }
69 |
70 | popover_suggestion.text_view = text_view;
71 | popover_suggestion.set_title(match.shortMessage || _("Grammar"));
72 | popover_suggestion.set_description(match.message);
73 | popover_suggestion.set_range([start, end]);
74 |
75 | // console.debug(JSON.stringify(match, null, 2));
76 |
77 | match.replacements?.slice(0, 3).forEach((replacement) => {
78 | popover_suggestion.add_suggestion({ value: replacement.value });
79 | });
80 |
81 | const iter_location = text_view.get_iter_location(iter);
82 | const [x, y] = text_view.buffer_to_window_coords(Gtk.TextWindowType.WIDGET, iter_location.x, iter_location.y)
83 | const rectangle = new Gdk.Rectangle({
84 | // FIXME: magic numbers
85 | x: x + 22,
86 | y: y + 48
87 | })
88 | popover_suggestion.set_pointing_to(rectangle);
89 | popover_suggestion.popup()
90 | });
91 |
92 | const tag_table = buffer.get_tag_table();
93 |
94 | // Error tag
95 | const color_error = new Gdk.RGBA();
96 | color_error.parse("#e01b24");
97 | const tag_error = new Gtk.TextTag({
98 | name: "error",
99 | underline: Pango.Underline.SINGLE,
100 | underline_rgba: color_error,
101 | });
102 | tag_table.add(tag_error);
103 |
104 | const color_warning = new Gdk.RGBA();
105 | color_warning.parse("#f5c211");
106 | const tag_warning = new Gtk.TextTag({
107 | name: "warning",
108 | underline: Pango.Underline.SINGLE,
109 | underline_rgba: color_warning,
110 | });
111 | tag_table.add(tag_warning);
112 |
113 | const color_hint = new Gdk.RGBA();
114 | color_hint.parse("#62a0ea");
115 | const tag_style = new Gtk.TextTag({
116 | name: "hint",
117 | underline: Pango.Underline.SINGLE,
118 | underline_rgba: color_hint,
119 | });
120 | tag_table.add(tag_style);
121 |
122 | function updateStatus(count) {
123 | spinner.visible = false;
124 |
125 | if (count === 0) {
126 | label_status.visible = false;
127 | image_ok.visible = true;
128 | return;
129 | }
130 |
131 | label_status.visible = true;
132 | label_status.label = count?.toString() || "";
133 | image_ok.visible = false;
134 | }
135 |
136 | function onReject(err) {
137 | updateStatus(null);
138 | if (err.code !== Gio.IOErrorEnum.CONNECTION_REFUSED) {
139 | logError(err);
140 | }
141 | }
142 |
143 | function onResolve(res) {
144 | // console.log(JSON.stringify(result, null, 2));
145 |
146 | const { matches } = res;
147 | updateStatus(matches.length);
148 | handleMatches(buffer, matches);
149 | }
150 |
151 | const dropown_lang = DropdownLang({ dropdown_langs });
152 |
153 | const scheduleCheck = unstack(
154 | () =>
155 | retry(
156 | () => check(buffer.text, dropown_lang.getLanguage()),
157 | 2000,
158 | onReject,
159 | ),
160 | onResolve,
161 | );
162 |
163 | // This isn't perfect but until we have Intl.Segmenter in GJS it will do
164 | // see https://cestoliv.com/blog/how-to-count-emojis-with-javascript/#4-the-best-solution-to-use-in-production
165 | // https://bugzilla.mozilla.org/show_bug.cgi?id=1423593
166 | // Int.Segmenter is also better at counting words
167 | function updateCounters() {
168 | let words_count = 0;
169 | let characters_count = 0;
170 |
171 | const words = buffer.text
172 | .replace(/[.,?!;()"'-]/g, " ")
173 | .replace(/\s+/g, " ")
174 | .split(" ")
175 | .filter(word => word !== "");
176 | words_count = words.length;
177 | const characters = words.join("");
178 | characters_count = [...characters].length;
179 |
180 | label_words.label = ` ${words_count}`;
181 | label_characters.label = ` ${characters_count}`;
182 | }
183 |
184 | function checkGrammar() {
185 | popover_suggestion.reset();
186 | popover_suggestion.popdown();
187 | scheduleCheck();
188 | }
189 |
190 | dropown_lang.onChange(checkGrammar);
191 |
192 | buffer.connect("changed", () => {
193 | checkGrammar();
194 | updateCounters();
195 | });
196 |
197 | // if (__DEV__) {
198 | buffer.text = `Write or paste your text here too have it checked continuously. Errors will be underlined in different colours: we will mark seplling errors with red underilnes. Furthermore grammar error's are highlighted in yellow. LanguageTool also marks style issues in a reliable manner by underlining them in blue. Its a impressively versatile tool especially if youd like to tell a colleague from over sea's about what happened at 5 PM in the afternoon on Monday, 27 May 2007.`;
199 | // }
200 |
201 | text_view.grab_focus();
202 |
203 | window.present();
204 |
205 | return { window };
206 | }
207 |
208 | function getTag(iter) {
209 | const tags = iter.get_tags();
210 |
211 | // Match the tag at cursor position after "a" in
212 | // to love a elephant
213 | const ended_tags = iter.get_toggled_tags(false);
214 | const tag = tags[0] || ended_tags[0];
215 | if (!tag) return {};
216 |
217 | const start = iter.copy();
218 | if (!start.starts_tag(tag)) {
219 | start.backward_to_tag_toggle(tag);
220 | }
221 | const end = iter.copy();
222 | if (!end.ends_tag(tag)) {
223 | end.forward_to_tag_toggle(tag);
224 | }
225 |
226 | return { tag, start, end };
227 | }
228 |
229 | function getDiagnostic(start, end) {
230 | const offset = start.get_offset();
231 | const length = end.get_offset() - offset;
232 |
233 | return diagnostics.find((diagnostic) => {
234 | return diagnostic.offset === offset && diagnostic.length === length;
235 | });
236 | }
237 |
238 | function clearDiagnostics(buffer) {
239 | diagnostics = [];
240 | buffer.remove_tag_by_name(
241 | "error",
242 | buffer.get_start_iter(),
243 | buffer.get_end_iter(),
244 | );
245 | buffer.remove_tag_by_name(
246 | "warning",
247 | buffer.get_start_iter(),
248 | buffer.get_end_iter(),
249 | );
250 | buffer.remove_tag_by_name(
251 | "hint",
252 | buffer.get_start_iter(),
253 | buffer.get_end_iter(),
254 | );
255 | }
256 |
257 | function handleMatches(buffer, matches) {
258 | clearDiagnostics(buffer);
259 |
260 | diagnostics = matches;
261 |
262 | for (const match of matches) {
263 | buffer.apply_tag_by_name(...getTagParams(buffer, match));
264 | }
265 | }
266 |
267 | function getTagParams(buffer, match) {
268 | const start_iter = buffer.get_iter_at_offset(match.offset);
269 | const end_iter = buffer.get_iter_at_offset(match.offset + match.length);
270 |
271 | let type = "error";
272 |
273 | if (match.type?.typeName === "Hint") {
274 | type = "hint";
275 | } else if (match.rule.issueType === "style") {
276 | type = "hint";
277 | } else if (match.type?.typeName === "Other") {
278 | type = "warning";
279 | } else if (match.rule.issueType === "inconsistency") {
280 | type = "warning";
281 | }
282 |
283 | return [type, start_iter, end_iter];
284 | }
285 |
--------------------------------------------------------------------------------
/data/icons/re.sonny.Eloquent.Devel.svg:
--------------------------------------------------------------------------------
1 |
2 |
144 |
--------------------------------------------------------------------------------
/data/icons/re.sonny.Eloquent.Source.svg:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
754 |
--------------------------------------------------------------------------------
/COPYING:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.