Merge pull request #19 from neverRare/master

0.2.1

Author: neverRare

.github/workflows/deno.yml

@@ -1,22 +1,16 @@
-# Simple workflow for deploying static content to GitHub Pages
 name: Build and Deploy
 
 on:
-  # Runs on pushes targeting the default branch
   push:
     branches: ["release"]
 
-  # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
 
-# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
 permissions:
   contents: read
   pages: write
   id-token: write
 
-# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
-# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
 concurrency:
   group: "pages"
   cancel-in-progress: false
@@ -30,19 +24,17 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
-        
       - name: Setup Deno
         uses: denoland/setup-deno@v1
         with:
           deno-version: v1.x
-      - name: Run a one-line script
+      - name: Build
         run: deno task build
       - name: Setup Pages
         uses: actions/configure-pages@v4
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
         with:
-          # Upload entire repository
           path: "."
       - name: Deploy to GitHub Pages
         id: deployment

.vscode/settings.json

@@ -1,9 +1,9 @@
 {
   "cSpell.customDictionaries": {
-    "ku-suli": {
+    "nimi-ku-suli": {
       "name": "ku-suli",
       "path": "${workspaceRoot}/nimi-ku-suli.txt",
-      "description": "Ku Suli words of Toki Pona",
+      "description": "nimi ku sili",
       "addWords": true
     }
   },

CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+You may need to force restart the page in order to use the latest version: shift + click the restart button; or ctrl + shift + R.
+
+## 0.2.1
+
+The project has been renamed to ilo Token. The definition list has been given a huge overhaul.
+
+- Change name to ilo Token.
+- Remove unintended commas, these were found when translating "en" with more than 3 phrases.
+- Remove copyright and license footer.
+- Update definition list:
+  - It now uses latest Linku definition as the base.
+  - Include verbs for later use.
+  - Include interjection for later use.
+
 ## 0.2.0
 
 For this version. The whole code has been rewritten. The translator can now translate few more things! Although it's still not capable of translating full sentences.
@@ -9,6 +23,7 @@ For this version. The whole code has been rewritten. The translator can now tran
   - Reduplication
   - _nanpa_ particle
   - _en_ and _anu_
+  - _o_ vocative like "jan Koko o"
 - Add button for translating, replacing auto-translate when typing.
 - (Downgrade) Drop support for "a" particle.
 - (Downgrade) Error messages are now very unreliable.

README.md

@@ -1,19 +1,33 @@
-# Toki Pona Translator
+# ilo Token
 
-An imperfect Toki Pona to English translator that translates into multiple sentences. This emphasizes how broad Toki Pona can be. Everything is hardcoded, no machine learning involved.
+> The repository and the website uses to old name, it will be renamed on the next update.
+
+A rule-based Toki Pona to English translator that translates into multiple sentences. This emphasizes how broad Toki Pona can be. Everything is hardcoded, no machine learning involved.
 
 [Try it](https://neverrare.github.io/toki-pona-translator/)
 
 ## Building
 
+This builds `./main.js` as a minified file ready for production use.
+
 You'll need [Deno](https://deno.com/). Run the following command.
 
 ```
-git clone https://github.com/neverRare/toki-pona-translator.git
-cd toki-pona-translator
 deno task build
 ```
 
-Then open `./index.html` using your favorite browser.
+## Watching
+
+This builds `./main.js` as a non-minified file with source mapping, intended for testing and debugging. This command also watches the source codes in `./src/` path and rebuilds `./main.js` whenever there are changes.
+
+You'll need [Deno](https://deno.com/). Run the following command.
+
+```
+deno task watch
+```
+
+To stop this command, simply press Ctrl + C.
+
+## About the source codes
 
-Whenever you made changes to `./src/*.ts`, you'll need to run `deno task build` again and refresh the browser. Later I'll make a script to automate this.
+With exception to `./src/main.ts`, every source codes in `./src/` are environment agnostic. Meaning it can be run on Deno as well. This makes it convenient to directly test codes by using `deno run`.

bundle.ts

@@ -1,10 +1,29 @@
-import { bundle } from "https://deno.land/x/[email protected]/mod.ts";
+import { emit } from "./dev-deps.ts";
+import { debounce } from "./dev-deps.ts";
 
 const SOURCE = "./src/main.ts";
 const DESTINATION = "./main.js";
 
 const url = new URL(SOURCE, import.meta.url);
-const result = await bundle(url);
 
-const { code } = result;
-await Deno.writeTextFile(DESTINATION, code);
+async function build(options: emit.BundleOptions): Promise<void> {
+  const result = await emit.bundle(url, options);
+  const { code } = result;
+  await Deno.writeTextFile(DESTINATION, code);
+}
+if (Deno.args[0] === "build") {
+  await build({ minify: true });
+} else if (Deno.args[0] === "watch") {
+  const builder = debounce.debounce(async () => {
+    console.log("Starting to build...");
+    await build({ compilerOptions: { inlineSourceMap: true } });
+    console.log("Building done!");
+  }, 500);
+  const watcher = Deno.watchFs("./src/");
+  builder();
+  for await (const _ of watcher) {
+    builder();
+  }
+} else {
+  throw new Error(`Unrecognized build option, ${Deno.args[0]}`);
+}

deno.json

@@ -5,7 +5,8 @@
     "lib": ["dom", "dom.iterable", "dom.asynciterable", "deno.ns"]
   },
   "tasks": {
-    "build": "deno run --allow-read --allow-write --allow-env --allow-net ./bundle.ts"
+    "build": "deno run --allow-read --allow-write --allow-env --allow-net ./bundle.ts build",
+    "watch": "deno run --allow-read --allow-write --allow-env --allow-net ./bundle.ts watch"
   },
   "fmt": {
     "include": ["./src/**/*.ts", "./bundle.ts", "./test-parser.ts"]

dev-deps.ts

@@ -0,0 +1,2 @@
+export * as emit from "https://deno.land/x/[email protected]/mod.ts";
+export * as debounce  from "https://deno.land/[email protected]/async/debounce.ts";

index.html

@@ -5,25 +5,24 @@
     <meta name="author" content="neverRare" />
     <meta
       name="description"
-      content="Toki Pona sentence to multi English sentence translator"
+      content="A rule-based Toki Pona to English translator"
     />
     <link
       rel="stylesheet"
       href="https://necolas.github.io/normalize.css/8.0.1/normalize.css"
     />
     <link rel="stylesheet" href="./style.css" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Toki Pona Translator</title>
+    <title lang="tok">ilo Token</title>
   </head>
   <body>
-    <h1>Toki Pona Translator</h1>
+    <h1 lang="tok">ilo Token</h1>
     <p>
       <strong>⚠ WARNING:</strong> Work in progress; Some things may not work
       properly.
     </p>
     <p>
-      An imperfect Toki Pona to English translator that translates into multiple
-      sentences.
+      A rule-based Toki Pona to English translator.
       <a
         href="https://github.com/neverRare/toki-pona-translator/wiki/Limitations"
         >Limitations</a
@@ -32,6 +31,7 @@ <h1>Toki Pona Translator</h1>
     <textarea id="input" placeholder="o toki tawa ni" lang="tok"></textarea>
     <div>
       <button id="translate-button">Translate</button>
+      <button id="settings-button">Settings</button>
     </div>
     <ul id="output"></ul>
     <p id="error"></p>
@@ -47,7 +47,7 @@ <h1>Toki Pona Translator</h1>
         <li>
           Join
           <a href="https://discord.gg/Byqn5z9"
-            ><i>ma pona pi toki pona</i> Discord Server</a
+            ><i lang="tok">ma pona pi toki pona</i> Discord Server</a
           >
           and ping me (never_rare) at dedicated forum channel:
           <a
@@ -67,13 +67,8 @@ <h1>Toki Pona Translator</h1>
       <p>
         <a
           href="https://github.com/neverRare/toki-pona-translator/blob/master/CHANGELOG.md"
-          >v0.2.0</a
-        >
-        - &copy; 2024 neverRare -
-        <a
-          href="https://github.com/neverRare/toki-pona-translator/blob/master/LICENSE"
-          >MIT License</a
-        >
+          id="version"
+        ></a>
       </p>
     </footer>
   </body>