2f2d3c72c9
This starts the reorg required for splitting the lm worker into its own module. Tests are still not working. But builds are going. Some decisions to be made around the final path for wrapping of the code. I think it may be possible to do something a whole lot more elegant by moving the wrapping process into the KMW build and leaving the LM Worker output as a pure tsc output -- given only KMW wants the wrapped worker anyway (tests aside). The actual wrapping code could still be in the lm-worker folder. |
||
|---|---|---|
| .. | ||
| docs | ||
| testing | ||
| unit_tests | ||
| .gitignore | ||
| browser.tsconfig.json | ||
| build.sh | ||
| embedded_worker.d.ts | ||
| index.d.ts | ||
| index.ts | ||
| node-defaultWorker.ts | ||
| package-lock.json | ||
| package.json | ||
| promise-store.ts | ||
| README.md | ||
| tsconfig.json | ||
| virtualizedWorker.ts | ||
| web-defaultWorker.ts | ||
| worker-interface.d.ts | ||
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 >= 10.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, build.sh compiles the
LMLayer in two stages:
-
Compile the inner worker code
- Compile the TypeScript sources for only the Worker code.
- Wrap the Worker code as
embedded_worker.js
-
Compile the top-level code
- Include
embedded_worker.jsverbatim using a TypeScript directive. - Compile the top-level TypeScript code.
- Unwrap the Worker code at runtime.
- Include
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, ./build.sh -tdd skips running the in-browser tests, and skips
downloading/updating npm dependencies.