Merge pull request #77 from ilo-token/master

0.5.3

Author: neverRare

.github/workflows/build_and_deploy.yml

@@ -28,6 +28,8 @@ jobs:
         uses: denoland/setup-deno@v2
         with:
           deno-version: v2.x
+      - name: Install Dependencies
+        run: deno install --frozen
       - name: Build
         run: deno task build
       - name: Setup Pages

.github/workflows/deno.yml

@@ -14,11 +14,13 @@ jobs:
         uses: denoland/setup-deno@v2
         with:
           deno-version: v2.x
+      - name: Install Dependencies
+        run: deno install --frozen
       - name: Build Dictionary
         run: deno task build-dictionary
       - name: Check formatting
         run: deno fmt --check
       - name: Lint
         run: deno lint
       - name: Test
-        run: deno test
+        run: deno test --parallel

.gitignore

@@ -1,4 +1,4 @@
-.vscode/
-dictionary/dictionary.ts
-dist/main.js
-dist/main.js.map
+/.vscode/
+/dictionary/dictionary.ts
+/dist/main.js
+/dist/main.js.map

CHANGELOG.md

@@ -15,6 +15,14 @@ On this on-development version, things can be broken.
 </details>
 -->
 
+## 0.5.3
+
+Released 2 April 2025
+
+- Fix adverbs not showing along with verbs.
+- Fix UCSUR translation. Previously, some UCSUR words are translated into wrong
+  words in latin script.
+
 ## 0.5.2
 
 Released 14 March 2025
@@ -212,7 +220,7 @@ Inside update (intended for developers):
 - Rewritten whole code to use TypeScript, module, and functional programming.
 - Rewritten parser to use parser combinator.
 - Add language codes to html.
-- New wiki for contributors and thinkerers.
+- New wiki for contributors and tinkerers.
 - Overhaul `README.md`, only including build instruction. Information about the
   translator is now moved to wiki.
 

CONTRIBUTING.md

@@ -26,6 +26,15 @@ Also check the [changelog](./CHANGELOG.md) and open the on-development
 changelog, it might be already fixed but hasn't published yet! Duplicate issues
 are unnecessary.
 
+Note to maintainer/contributor: When there's a bug discovered, make a test for
+it if possible. Use Deno's own testing tools:
+[examples](https://github.com/ilo-token/ilo-token.github.io/blob/master/src/translator/test.ts).
+Then edit the issue to link the test in following format:
+
+```md
+Test: [src/translator/test.ts "verb with adverb"](permalink including the lines)
+```
+
 ## [Discussion](https://github.com/ilo-token/ilo-token.github.io/discussions)
 
 This GitHub repository have discussion, a dedicated forum page and shall serve
@@ -42,8 +51,10 @@ Please search first before opening a new page! Duplicate pages are unnecessary.
 Before forking and editing, please claim an issue first or open an issue then
 claim it. After that, you can start away. This is necessary to avoid wasted
 duplicate efforts.
+[The wiki](https://github.com/ilo-token/ilo-token.github.io/wiki) contains
+useful information for contributors.
 
-You **don't** have to do this if:
+You **don't** have to open a new issue this if:
 
 - It is a contribution to the dictionary
 - It is a minor edit e.g. a typo fix
@@ -52,11 +63,22 @@ Please don't do the following, we can do this ourselves.
 
 - Updating dependencies
 
-Additionally, please format the code when you make changes. We use Deno's
-built-in formatter.
+More things to remember:
 
-[The wiki](https://github.com/ilo-token/ilo-token.github.io/wiki) contains
-useful for contributors.
+- Keep the source code as runtime agnostic as possible. We target the browser
+  and Deno. This is necessary because we use `deno test`. If a module is
+  exclusive to one runtime, add a note above the code:
+  `// This code is browser/Deno only`.
+
+(The following aren't strict rules. It's perfectly fine to not follow any of
+these, we can adapt.)
+
+- Ensure all the files are formatted: Run `deno fmt`.
+- Make sure you don't accidentally make more tests fail: Run
+  `deno test --parallel` before and after making changes to the code. Some tests
+  may already be failing.
+- Make use of linter: Run `deno lint`. If a lint rule is deemed unnecessary and
+  more of an annoyance, open an [issue](#issue). We can remove lint rules.
 
 As a thank you for contributing, you'll get a shout out in the changelog!
 
@@ -86,6 +108,6 @@ themselves serves as a space for broader topics, not just ilo Token.
   programming language, it uses similar techniques found in programming language
   development e.g. parsing.
 
-These are unnoficial spaces and are not subject to the
+These are unofficial spaces and are not subject to the
 [Contributor Covenant Code of Conduct](https://github.com/ilo-token/ilo-token.github.io/blob/master/CODE_OF_CONDUCT.md).
 Instead, each have its own rules and different moderators.

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 neverRare
+Copyright (c) 2025 neverRare
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -9,48 +9,14 @@ interpretation of the text. No machine learning involved.
 **It is work in progress!**
 [We welcome contributors however!](./CONTRIBUTING.md)
 
-## Dependencies
+## Starting development server
 
-You'll need the following in order to run commands:
+After using `git clone`, you'll need [Deno](https://deno.com/) for this project.
+Then you'll need to install the dependencies before running any command:
+`deno install`.
 
-- [Deno](https://deno.com/)
+After this, you can start away by running `deno task start` then open the link
+provided by the stdout to open a local copy of ilo Token. The server will
+auto-reload the webpage whenever there are changes on the code.
 
-## Building
-
-This builds the distribution code at `./dist/main.js` as minified file ready for
-production use, it also builds the source map so contributors can directly debug
-the production code.
-
-```
-deno task build
-```
-
-Before building the distribution code, it builds the dictionary first by
-transforming the dictionary into a code at `./dictionary/dictionary.ts`. This
-enables faster code startup without dealing with file access or network access.
-
-## Watching
-
-This is similar to [building](#building) but it doesn't minify the code. This
-command also watches the codes in `./src/` and `./dictionary/` including the
-dictionary and rebuilds whenever there are changes. To stop this command, simply
-press Ctrl + C.
-
-```
-deno task watch
-```
-
-## Running locally with browser
-
-After building or watching, you can directly run `./dist/index.html` with your
-browser to test ilo Token. If you wish to start a local server, run
-`deno task start`. The stdout will tell you the URL to use.
-
-## Running locally with Deno
-
-This will run a REPL that you can use to test ilo Token. To stop this command,
-simply press Ctrl + D or Ctrl + C.
-
-```
-deno task repl
-```
+Run `deno task` to see more useful command lines.

build/build.ts

@@ -0,0 +1,16 @@
+// This code is Deno only
+
+import * as ESBuild from "esbuild";
+import { OPTIONS } from "./config.ts";
+import * as Dictionary from "../dictionary/build.ts";
+
+const BUILD_OPTIONS: ESBuild.BuildOptions = {
+  ...OPTIONS,
+  minify: true,
+  define: { LIVE_RELOAD: "false" },
+};
+
+if (import.meta.main) {
+  await Dictionary.build();
+  await ESBuild.build(BUILD_OPTIONS);
+}

build/config.ts

@@ -0,0 +1,14 @@
+// This code is Deno only
+
+import { denoPlugins } from "@luca/esbuild-deno-loader";
+import { BuildOptions } from "esbuild";
+
+export const OPTIONS: BuildOptions = {
+  entryPoints: ["./src/main.ts"],
+  outfile: "./dist/main.js",
+  bundle: true,
+  sourcemap: "linked",
+  target: [`es${new Date().getFullYear() - 3}`],
+  plugins: [...denoPlugins()],
+  logLevel: "info",
+};

build/dev.ts

@@ -0,0 +1,59 @@
+// This code is Deno only
+
+import { assert } from "@std/assert/assert";
+import { exists } from "@std/fs/exists";
+import { BuildOptions, context } from "esbuild";
+import { AsyncDisposableStack } from "../misc/async_disposable_stack.ts";
+import { OPTIONS } from "./config.ts";
+
+const BUILD_OPTIONS: BuildOptions = {
+  ...OPTIONS,
+  minify: false,
+  define: { LIVE_RELOAD: "true" },
+};
+async function watchMain(): Promise<AsyncDisposable> {
+  await using stack = new AsyncDisposableStack();
+  const buildContext = await context(BUILD_OPTIONS);
+  stack.defer(async () => await buildContext.dispose());
+  buildContext.watch();
+  buildContext.serve({ servedir: "./dist/" });
+  return stack.move();
+}
+async function watchDictionary(): Promise<number> {
+  const command = new Deno.Command(Deno.execPath(), {
+    args: [
+      "run",
+      "-R=./dictionary/dictionary",
+      "-W=./dictionary/dictionary.ts",
+      "--no-prompt",
+      "--frozen",
+      "--cached-only",
+      "--watch",
+      "--no-clear-screen",
+      "./dictionary/watch.ts",
+    ],
+    cwd: new URL("../", import.meta.url),
+    stdout: "inherit",
+    stderr: "inherit",
+    stdin: "null",
+  });
+  const process = command.spawn();
+  const status = await process.status;
+  assert(!status.success);
+  return status.code;
+}
+if (import.meta.main) {
+  let statusCode: number;
+  {
+    if (
+      !await exists(new URL("../dictionary/dictionary.ts", import.meta.url))
+    ) {
+      const Dictionary = await import("../dictionary/build.ts");
+      await Dictionary.build();
+    }
+    const statusCodePromise = watchDictionary();
+    await using _ = await watchMain();
+    statusCode = await statusCodePromise;
+  }
+  Deno.exit(statusCode);
+}