Merge pull request #4 from dunosaurs/cleanup

chore: add test + cleanup readme

Author: lino-levan

mod_test.ts

@@ -1,5 +1,5 @@
 import { assertEquals } from "std/testing/asserts.ts";
-import { longestCommonSubsequence } from "./mod.ts";
+import { diffCharacters, longestCommonSubsequence } from "./mod.ts";
 
 Deno.test("Longest Common Subsequence", () => {
   assertEquals(longestCommonSubsequence("abc", "abc"), "abc");
@@ -22,3 +22,25 @@ Deno.test("Longest Common Subsequence", () => {
     "AbCD",
   );
 });
+
+Deno.test("DiffCharacters", () => {
+  const result = [
+    { character: "b", wasAdded: false, wasRemoved: false },
+    { character: "o", wasAdded: false, wasRemoved: false },
+    { character: "o", wasAdded: false, wasRemoved: false },
+    { character: "p", wasAdded: false, wasRemoved: false },
+    { character: "a", wasAdded: false, wasRemoved: true },
+    { character: " ", wasAdded: true, wasRemoved: false },
+    { character: "b", wasAdded: true, wasRemoved: false },
+    { character: "e", wasAdded: true, wasRemoved: false },
+    { character: "e", wasAdded: true, wasRemoved: false },
+    { character: "p", wasAdded: true, wasRemoved: false },
+    { character: " ", wasAdded: true, wasRemoved: false },
+    { character: "b", wasAdded: true, wasRemoved: false },
+    { character: "o", wasAdded: true, wasRemoved: false },
+    { character: "p", wasAdded: true, wasRemoved: false },
+    { character: "p", wasAdded: true, wasRemoved: false },
+    { character: "y", wasAdded: true, wasRemoved: false },
+  ];
+  assertEquals(diffCharacters("boopa", "boop beep boppy"), result);
+});

readme.md

@@ -47,8 +47,8 @@ The object contains the character and whether that character was removed, added,
 or neither. Here is example usage
 
 ```typescript
+let finalString = "";
 for (const character of diffCharacters("boopa", "boop beep boppy")) {
-  let finalString = "";
   if (character.wasRemoved) {
     // print red if removed without newline
     finalString += `\x1b[31m${character.character}\x1b[0m`;
@@ -59,8 +59,8 @@ for (const character of diffCharacters("boopa", "boop beep boppy")) {
     // print white if unchanged
     finalString += `\x1b[37m${character.character}\x1b[0m`;
   }
-  console.log(finalString);
 }
+console.log(finalString);
 ```
 
-![image](https://user-images.githubusercontent.com/36348190/167757003-aef6e4c7-6c83-444e-ba04-7bb6c6681133.png)
+![image](https://user-images.githubusercontent.com/11367844/200397905-1885fdb1-b765-4871-a66d-7f2bbe453bea.png)