Merge pull request #36 from kWeglinski/develop

0.14.3

Author: kWeglinski

.env.sample

@@ -6,4 +6,6 @@ OLLAMA_MODEL=model_name
 # pick one of: 'pole' | 'light' | 'dark' 
 THEME='dark'
 LIBRETRANSLATE_LANGUAGES=["pl","en"]
-LANGUAGE_TOOL_LANGUAGES=["pl-PL","en-GB"]
+LANGUAGE_TOOL_LANGUAGES=["pl-PL","en-GB"]
+LANGUAGE_TOOL_PICKY=true
+DEBUG=false

README.md

@@ -43,6 +43,8 @@ services:
     restart: unless-stopped
     environment:
       LANGUAGE_TOOL: https://your.languagetool.instance
+      # if you want to enable picky mode in languagetool
+      LANGUAGE_TOOL_PICKY: true
       LIBRETRANSLATE: https://your.libretranslate.instance
       LIBRETRANSLATE_API_KEY: 'your_API_key' # use if your instance requires API key
       OLLAMA: https://your.ollama.instance
@@ -52,9 +54,10 @@ services:
       # To limit language options for translations provide an array of ISO 639 language codes
       LIBRETRANSLATE_LANGUAGES: ["pl","en"] # optional
       # To limit language options for text check provide an array of long tags (ISO 639/ISO-3166) also known as language-Region code.
-      LANGUAGE_TOOL_LANGUAGES=["pl-PL","en-GB"] # optional
+      LANGUAGE_TOOL_LANGUAGES: ["pl-PL","en-GB"] # optional
       # To disable "add word" to dicationary
-      DISABLE_DICTIONARY=true # optional
+      DISABLE_DICTIONARY: true # optional
+      DEBUG: false # set to true to log text sent to tools and it's raw responses
     ports:
       - 80:80
     image: kweg/omnipoly:latest

changelog.md

@@ -1,3 +1,9 @@
+### 0.14.3
+
+- Fix: during the creation of improved fix tooltip I've introduced a bug that completely broke position where text is fixed. This is fixed now. 
+- Feat: added picky level in language tool (use an ENV to enable it)
+- Feat: added DEBUG mode to log all requests
+
 ### 0.14.2
 
 - Chore: suggest different backend for languagetool. Apparently the one in readme wasn't the best.

index.js

@@ -23,20 +23,22 @@ const getLanguages = (langs) => {
   }
 };
 
-const DEV = process.env.DEV
+const DEV = process.env.DEV;
 const LANGUAGE_TOOL = process.env.LANGUAGE_TOOL;
+const LANGUAGE_TOOL_PICKY = process.env.LANGUAGE_TOOL_PICKY;
 const LIBRETRANSLATE = process.env.LIBRETRANSLATE;
 const OLLAMA = process.env.OLLAMA;
 const OLLAMA_MODEL = process.env.OLLAMA_MODEL;
 const THEME = process.env.THEME;
+const DEBUG = process.env.DEBUG;
 const LIBRETRANSLATE_API_KEY = process.env.LIBRETRANSLATE_API_KEY;
 const LIBRETRANSLATE_LANGUAGES = getLanguages(
   process.env.LIBRETRANSLATE_LANGUAGES
 );
 const LANGUAGE_TOOL_LANGUAGES = getLanguages(
   process.env.LANGUAGE_TOOL_LANGUAGES
 );
-const DISABLE_DICTIONARY = process.env.DISABLE_DICTIONARY === 'true'
+const DISABLE_DICTIONARY = process.env.DISABLE_DICTIONARY === "true";
 
 const maskString = (str) => {
   if (!str || str.length <= 3) {
@@ -60,23 +62,35 @@ LANGUAGE_TOOL_LANGUAGES: ${JSON.stringify(LANGUAGE_TOOL_LANGUAGES)}
 LIBRETRANSLATE_LANGUAGES: ${JSON.stringify(LIBRETRANSLATE_LANGUAGES)}
 DICTIONARY_DISABLED: ${!!DISABLE_DICTIONARY}
 DEV_MODE: ${!!DEV}
+DEBUG_MODE: ${!!DEBUG} 
 ========================
 `);
 
 app.use(bodyParser.urlencoded({ extended: false }));
 app.use(bodyParser.json());
 
 const handleProxyGET = (url, res, filter) => {
+  if (DEBUG) {
+    console.log(`Calling: ${url}`);
+  }
   fetch(url)
     .then((data) => data.json())
-    .then((data) => res.send(filter ? filter(data) : data))
+    .then((data) => {
+      if (DEBUG) {
+        console.log(data);
+      }
+      return res.send(filter ? filter(data) : data);
+    })
     .catch((error) => {
       console.error("[PROXY GET ERROR]", error);
-      res.status(500).send('Internal server error');
+      res.status(500).send("Internal server error");
     });
 };
 
 const handleProxyPost = (url, req, res) => {
+  if (DEBUG) {
+    console.log(`Calling: ${url}`);
+  }
   fetch(url, {
     method: "POST",
     body: JSON.stringify(req.body),
@@ -86,15 +100,18 @@ const handleProxyPost = (url, req, res) => {
       return data.json();
     })
     .then((data) => {
+      if (DEBUG) {
+        console.log(data);
+      }
       res.send(data);
     })
     .catch((error) => {
       console.log({ error, url });
-      res.status(500).send('Internal server error');
+      res.status(500).send("Internal server error");
     });
 };
 
-const handleFormDataPost = (url, req, res, filter) => {
+const handleFormDataPost = (url, req, res, filter, additionalData) => {
   const headers = {
     "Content-Type": "application/x-www-form-urlencoded",
     Accept: "application/json",
@@ -105,18 +122,30 @@ const handleFormDataPost = (url, req, res, filter) => {
   keys.forEach((key) => {
     formData.append(key, req.body[key]);
   });
+  if (additionalData) {
+    Object.keys(additionalData).forEach((key) => {
+      formData.append(key, additionalData[key]);
+    });
+  }
+  if (DEBUG) {
+    console.log(`Calling: ${url}`);
+    console.log({ formData });
+  }
   return fetch(url, {
     method: "POST",
     headers: headers,
     body: formData.toString(),
   })
     .then((data) => data.json())
     .then((data) => {
+      if (DEBUG) {
+        console.log(data);
+      }
       res.send(filter ? filter(data) : data);
     })
     .catch((error) => {
       console.log({ error: error.message, url });
-      res.status(500).send('Internal server error');
+      res.status(500).send("Internal server error");
     });
 };
 
@@ -127,7 +156,7 @@ app.get("/api/status", (req, res) => {
     OLLAMA,
     OLLAMA_MODEL,
     THEME,
-    DISABLE_DICTIONARY
+    DISABLE_DICTIONARY,
   });
 });
 
@@ -183,14 +212,24 @@ app.post("/api/languagetool/check", (req, res) => {
   };
 
   const targetFilter = DISABLE_DICTIONARY ? filter : false;
-  handleFormDataPost(`${LANGUAGE_TOOL}/v2/check`, req, res, targetFilter);
+  handleFormDataPost(
+    `${LANGUAGE_TOOL}/v2/check`,
+    req,
+    res,
+    targetFilter,
+    LANGUAGE_TOOL_PICKY
+      ? {
+          level: "picky",
+        }
+      : {}
+  );
 });
 
 app.post("/api/languagetool/add", (req, res) => {
   if (DISABLE_DICTIONARY) {
-    res.status(403).send()
+    res.status(403).send();
     return;
-  } 
+  }
   try {
     addWord(`${req.body.word}`.toLowerCase());
     console.log("added:", `${req.body.word}`.toLowerCase());

package.json

@@ -1,7 +1,7 @@
 {
   "name": "sth-libretranslate",
   "private": true,
-  "version": "0.14.2",
+  "version": "0.14.3",
   "type": "module",
   "scripts": {
     "dev": "concurrently \"npm run node\" \"vite\"",

src/languagecheck/App.tsx

@@ -72,7 +72,6 @@ function App() {
       >
         <div>
           <Content />
-          {/* <TextBox /> */}
         </div>
         <Divider orientation="vertical" flexItem />
         <div style={{ position: "relative" }}>

src/languagecheck/Resolution.tsx

@@ -18,26 +18,21 @@ import { API, Match } from "./API";
 import { actions, useGrammar } from "../store/grammar";
 import { useSystemStatus } from "../store/status";
 
-type Fix = (start: number, length: number, value: string, idx: number) => void;
-
 const DisplayMatch = ({
   message,
   context,
   replacements,
   shortMessage,
-  fix,
   selected,
   setSelection,
   idx,
   rule,
 }: Match & {
-  fix: Fix;
   selected: boolean;
   setSelection: () => void;
   idx: number;
 }) => {
   const { disableDictionary } = useSystemStatus();
-  const { question, answer, selection } = useGrammar();
 
   return (
     <Accordion expanded={selected}>
@@ -68,25 +63,7 @@ const DisplayMatch = ({
             size="small"
             label={repl.value}
             onClick={() => {
-              if (!answer || selection === null) {
-                return;
-              }
-              
-              const match = answer.matches[selection];
-              if (!match) {
-                return;
-              }
-              
-              // Count newline-like characters (\n, \t, etc.) before the offset
-              const nCount = match.context.text.substring(0, match.context.offset).match(/\\[ntrvf]/g)?.length ?? 0;
-              const adjustedStart = match.context.offset + nCount;
-              
-              // Apply the fix to the question text
-              const fixedQuestion = `${question.substring(0, adjustedStart)}${repl.value}${question.substring(adjustedStart + match.context.length)}`;
-              
-              // Update the state
-              actions.setQuestion(fixedQuestion);
-              actions.popAnswer(selection);
+              actions.fixPos(repl.value, idx)
             }}
             sx={{ marginRight: 1, marginBottom: 0.5, marginTop: 0.5 }}
           />
@@ -101,7 +78,6 @@ const DisplayMatch = ({
                 variant="outlined"
                 sx={{ margin: "auto" }}
                 onClick={() => {
-                  fix(0, 0, "", idx);
                   API().addWord(
                     context.text.substr(context.offset, context.length)
                   );
@@ -119,7 +95,6 @@ const DisplayMatch = ({
 
 export const Resolution = () => {
   const {
-    question: original,
     loading,
     error,
     selection,
@@ -140,13 +115,6 @@ export const Resolution = () => {
       </div>
     );
   }
-  const fix: Fix = (start, length, value, idx) => {
-    const fixed = `${original.substring(0, start)}${value}${original.substring(
-      start + length
-    )}`;
-    actions.setQuestion(fixed);
-    actions.popAnswer(idx);
-  };
   return (
     <div style={{ paddingTop: "20px" }}>
       {error?.length > 0 && (
@@ -163,7 +131,6 @@ export const Resolution = () => {
         <DisplayMatch
           key={i}
           {...data}
-          fix={fix}
           selected={selection === i}
           setSelection={() => actions.setSelection(i)}
           idx={i}

src/store/grammar.tsx

@@ -87,32 +87,17 @@ export const actions = {
     };
     useGrammar.setState({ answer: newAnswer });
   },
-  fixPos: (value: string, index?: number) => {
-    const { question, answer, selection } = useGrammar.getState();
-    const target = index ?? selection;
-    if (!answer || target === null) {
-      return;
-    }
-
-    const match = answer.matches[target];
-    if (!match) {
-      return;
-    }
-
-    // Count newline-like characters (\n, \t, \r, \v, \f) before the offset
+  fixPos: (value: string, index: number) => {
+    const { question, answer } = useGrammar.getState();
+    const match = answer?.matches[index];
+    const offset = match?.offset || 0;
     const nCount =
-      question.substring(0, match.context.offset).match(/\\[ntrvf]/g)?.length ??
-      0;
-    const adjustedStart = match.context.offset + nCount;
-
-    // Apply the fix to the question text
-    const fixedQuestion = `${question.substring(
-      0,
-      adjustedStart
-    )}${value}${question.substring(adjustedStart + match.context.length)}`;
-
-    // Update the state
-    actions.setQuestion(fixedQuestion);
-    actions.popAnswer(target);
+      question.substring(0, offset).match(/\\[ntrvf]/g)?.length ?? 0;
+    const start = offset + nCount;
+    const fixed = `${question.substring(0, start)}${value}${question.substring(
+      start + (match?.length || 0)
+    )}`;
+    actions.setQuestion(fixed);
+    actions.popAnswer(index);
   },
 };