| .. | ||
| docs | ||
| testing | ||
| unit_tests | ||
| worker | ||
| .gitignore | ||
| build.sh | ||
| embedded_worker.d.ts | ||
| history.md | ||
| index.ts | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| tsconfig.json | ||
Language Modelling Layer (LMLayer)
Provide predictions and corrections while you type!
See Worker Communication Protocol for a semi-formal specification on how the Worker and the main thread communicate.
System dependencies
You will need Bash and Node.js >= 6.0.
Build
Run build.sh. This will also automatically install dependencies with npm.
./build.sh
Two-stage compilation process
Since the primary LMLayer code runs within a Web Worker, the LMLayer must be compiled in two stages:
-
Compile the inner worker code a. Compile the TypeScript sources for only the Worker code. b. Wrap the Worker code as
embedded_worker.js -
Compile the top-level code a. Include
embedded_worker.jsverbatim using a TypeScript directive. b. Compile the top-level TypeScript code. c. Unwrap the Worker code at runtime.
Test
This will run both headless unit tests, and in-browser unit tests and integration tests:
./build.sh -test
Test-Driven Development
I like to use entr to automatically build and re-run the unit tests anytime I change a source code file. Here's the command I run in separate window:
git ls-files | entr -c ./build.sh -tdd
Importantly, this ./build.sh -tdd skips running the in-browser tests, and skips
downloading/updating npm dependencies.