feat(*): add option to output Markdown as plain-text (#470)

TheOpenDictionary · Sep 28, 2023 · 71ca0d5 · 71ca0d5
1 parent 5686f95
commit 71ca0d5
Show file tree

Hide file tree

Showing 20 changed files with 258 additions and 71 deletions.
diff --git a/cli/app.go b/cli/app.go
@@ -133,12 +133,17 @@ var App = &cli.App{
 					Usage:   "If a definition cannot be found, attempt to split the query into words of at least length S and look up each word separately. Can be relatively slow.",
 					Value:   0,
 				},
-				&cli.BoolFlag{
-					Name:  "no-process",
-					Usage: "Skip converting Markdown to HTML",
-					Value: false,
-					Action: func(c *cli.Context, value bool) error {
-						types.SetMarkdownProcessingEnabled(!value)
+				&cli.StringFlag{
+					Name:  "markdown",
+					Usage: "strategy for rendering Markdown strings",
+					Value: "html",
+					Action: func(c *cli.Context, value string) error {
+						if value != "text" && value != "html" && value != "disable" {
+							return fmt.Errorf("Invalid markdown strategy: %s. Must be one of: text, html, disable", value)
+						}
+
+						types.SetMarkdownProcessingStrategy(types.MarkdownStrategy(value))
+
 						return nil
 					},
 				},

diff --git a/cli/service.go b/cli/service.go
@@ -131,10 +131,15 @@ func service(c *cli.Context) error {
 				queries := make([]string, payload.QueriesLength())
 				follow := payload.Follow()
 				split := int(payload.Split())
-				noProcess := payload.NoProcess()
-
-				if noProcess {
-					types.SetMarkdownProcessingEnabled(false)
+				markdown := payload.Markdown()
+
+				switch markdown {
+				case MarkdownStrategyHTML:
+					types.SetMarkdownProcessingStrategy(types.MarkdownStrategyHTML)
+				case MarkdownStrategyText:
+					types.SetMarkdownProcessingStrategy(types.MarkdownStrategyText)
+				case MarkdownStrategyDisable:
+					types.SetMarkdownProcessingStrategy(types.MarkdownStrategyDisable)
 				}
 
 				for i := 0; i < payload.QueriesLength(); i++ {

diff --git a/cli/service_generated.go b/cli/service_generated.go
diff --git a/flatbuffers/service.fbs b/flatbuffers/service.fbs
@@ -9,11 +9,16 @@ enum ODictMethod:byte {
   Ready = 8
 }
 
+enum MarkdownStrategy:short {
+  Disable = 0,
+  Text = 1,
+  HTML = 2
+}
 
 table LookupPayload {
   follow:bool;
   split:int;
-  no_process:bool;
+  markdown:MarkdownStrategy;
   queries:[string];
 }
 

diff --git a/js/src/__generated__/lookup-payload.ts b/js/src/__generated__/lookup-payload.ts
diff --git a/js/src/__generated__/markdown-strategy.ts b/js/src/__generated__/markdown-strategy.ts
diff --git a/js/src/__generated__/service.ts b/js/src/__generated__/service.ts
diff --git a/js/src/dictionary.ts b/js/src/dictionary.ts
@@ -3,6 +3,7 @@ import { Builder } from "flatbuffers";
 import { CompilePayload } from "./__generated__/compile-payload.js";
 import {
   LookupPayload,
+  MarkdownStrategy,
   SearchPayload,
   SplitPayload,
   WritePayload,
@@ -163,11 +164,28 @@ class Dictionary {
 
     const queriesV = LookupPayload.createQueriesVector(builder, queriesS);
 
+    let markdown: MarkdownStrategy | undefined;
+
+    if (options.markdownStrategy === "html") {
+      markdown = MarkdownStrategy.HTML;
+    }
+
+    if (options.markdownStrategy === "disable") {
+      markdown = MarkdownStrategy.Disable;
+    }
+
+    if (options.markdownStrategy === "text") {
+      markdown = MarkdownStrategy.Text;
+    }
+
     LookupPayload.startLookupPayload(builder);
     LookupPayload.addQueries(builder, queriesV);
     LookupPayload.addFollow(builder, follow ?? false);
     LookupPayload.addSplit(builder, split ?? 0);
-    LookupPayload.addNoProcess(builder, options.skipProcessing ?? false);
+
+    if (markdown) {
+      LookupPayload.addMarkdown(builder, markdown);
+    }
 
     const payload = LookupPayload.endLookupPayload(builder);
 

diff --git a/js/src/types.ts b/js/src/types.ts
@@ -2,13 +2,15 @@ import { POS } from "./__generated__";
 
 export type Query = { word: string; fallback: string } | string;
 
+type MarkdownStrategy = "disable" | "html" | "text";
+
 export interface DictionaryOptions {
   defaultSplitThreshold?: number;
 }
 
 export interface LookupOptions {
   split?: number;
-  skipProcessing?: boolean;
+  markdownStrategy?: MarkdownStrategy;
   follow?: boolean;
 }
 

diff --git a/js/test/__snapshots__/dictionary.spec.ts.snap b/js/test/__snapshots__/dictionary.spec.ts.snap
@@ -183,42 +183,31 @@ exports[`Dictionary lookup can split terms 1`] = `
 ]
 `;
 
-exports[`Dictionary lookup looks up terms properly 1`] = `
+exports[`Dictionary lookup considers markdown strategies correctly 1`] = `
 [
   [
     {
       "etymologies": [
         {
           "description": "Latin root",
           "senses": {
-            "n": {
+            "v": {
               "definitions": [
                 {
-                  "examples": [
-                    "There goes a cat!",
-                  ],
-                  "notes": [
-                    {
-                      "examples": [
-                        "Some example",
-                      ],
-                      "value": "Some definition note",
-                    },
-                  ],
-                  "value": "a cat",
+                  "value": "This **is** a _markdown_ test",
                 },
               ],
             },
           },
         },
       ],
-      "term": "cat",
+      "term": "markdown",
     },
   ],
 ]
 `;
 
-exports[`Dictionary lookup skips markdown processing if specified 1`] = `
+exports[`Dictionary lookup considers markdown strategies correctly 2`] = `
 [
   [
     {
@@ -229,7 +218,7 @@ exports[`Dictionary lookup skips markdown processing if specified 1`] = `
             "v": {
               "definitions": [
                 {
-                  "value": "This <strong>is</strong> a <em>markdown</em> test",
+                  "value": "This is a markdown test",
                 },
               ],
             },
@@ -242,7 +231,7 @@ exports[`Dictionary lookup skips markdown processing if specified 1`] = `
 ]
 `;
 
-exports[`Dictionary lookup skips markdown processing if specified 2`] = `
+exports[`Dictionary lookup considers markdown strategies correctly 3`] = `
 [
   [
     {
@@ -253,7 +242,7 @@ exports[`Dictionary lookup skips markdown processing if specified 2`] = `
             "v": {
               "definitions": [
                 {
-                  "value": "This **is** a _markdown_ test",
+                  "value": "This <strong>is</strong> a <em>markdown</em> test",
                 },
               ],
             },
@@ -266,6 +255,41 @@ exports[`Dictionary lookup skips markdown processing if specified 2`] = `
 ]
 `;
 
+exports[`Dictionary lookup looks up terms properly 1`] = `
+[
+  [
+    {
+      "etymologies": [
+        {
+          "description": "Latin root",
+          "senses": {
+            "n": {
+              "definitions": [
+                {
+                  "examples": [
+                    "There goes a cat!",
+                  ],
+                  "notes": [
+                    {
+                      "examples": [
+                        "Some example",
+                      ],
+                      "value": "Some definition note",
+                    },
+                  ],
+                  "value": "a cat",
+                },
+              ],
+            },
+          },
+        },
+      ],
+      "term": "cat",
+    },
+  ],
+]
+`;
+
 exports[`Dictionary restarts if the process was killed 1`] = `
 [
   [

diff --git a/js/test/dictionary.spec.ts b/js/test/dictionary.spec.ts
@@ -77,11 +77,22 @@ describe("Dictionary", () => {
       expect(result).toMatchSnapshot();
     });
 
-    it("skips markdown processing if specified", async () => {
-      const result1 = await dict2.lookup("markdown", { skipProcessing: false });
-      const result2 = await dict2.lookup("markdown", { skipProcessing: true });
+    it("considers markdown strategies correctly", async () => {
+      const result1 = await dict2.lookup("markdown", {
+        markdownStrategy: "disable",
+      });
+
+      const result2 = await dict2.lookup("markdown", {
+        markdownStrategy: "text",
+      });
+
+      const result3 = await dict2.lookup("markdown", {
+        markdownStrategy: "html",
+      });
+
       expect(result1).toMatchSnapshot();
       expect(result2).toMatchSnapshot();
+      expect(result3).toMatchSnapshot();
     });
   });