spiegel-keyman/common/predictive-text
Marc Durdin 49eb062c65 feat(web): prediction casing follows current layer
Fixes #6455.

This involved adding an extra hint to the data passed into the lexical
model layer, being the CasingForm that the current layer wants to use.

Given there are several entry points to the lexical model layer, this
meant a few places where we needed to check the current layer.

I refactored the very long function `InputProcessor.processKeyEvent` to
extract out the `buildAlternates` function. There should be no
functional changes to the `buildAlternates` code. But it makes
`processKeyEvent` significantly easier to read.
2022-04-08 16:14:01 +10:00
..
docs docs(common/models): Update common/predictive-text/docs/worker-communication-protocol.md 2020-12-04 08:26:32 +07:00
polyfills fix(common/models): method name typo 2020-12-14 09:28:58 +07:00
testing chore(common): cleanup sh global color variables 2022-03-10 10:12:09 +11:00
unit_tests feat(web): prediction casing follows current layer 2022-04-08 16:14:01 +10:00
worker feat(web): prediction casing follows current layer 2022-04-08 16:14:01 +10:00
.gitignore fix(common): Actually adds polyfill (and fixes .gitignore) 2019-12-10 09:24:23 +07:00
browser.tsconfig.json refactor(common/lmlayer): Adapts to rework of base PR 2020-04-17 11:18:13 +07:00
build.sh chore(common/models): adds a naive... semi-fill?... for String.normalize for old devices 2020-12-14 09:26:36 +07:00
embedded_worker.d.ts Merge branch 'lmlayer-init' into lmlayer-build-reorg 2018-11-29 23:35:37 +07:00
index.d.ts Merge branch 'web-lmlayer-model-registration' into lmlayer-wordbreak-spec 2019-03-07 09:04:00 +07:00
index.ts fix(common/core/web): predictive context reset 2020-12-03 15:48:18 +07:00
message.d.ts feat(common/models): reversion in lm-layer 2020-10-08 15:15:55 +07:00
node-defaultWorker.ts refactor(common/lmlayer): Adapts to rework of base PR 2020-04-17 11:18:13 +07:00
package-lock.json auto: increment beta version to 15.0.230 2022-04-07 14:02:52 -04:00
package.json auto: increment beta version to 15.0.230 2022-04-07 14:02:52 -04:00
promise-store.ts change(android): gets API 23 working again, but not 19 or 21 (yet) 2019-12-02 07:55:37 +07:00
README.md feat(common): lerna now npm-installed locally 2020-04-21 15:55:43 +07:00
tsconfig.json refactor(common/lmlayer): Adapts to rework of base PR 2020-04-17 11:18:13 +07:00
virtualizedWorker.ts change(common/lmlayer): a bit more PR review polish 2020-04-20 23:18:22 +07:00
web-defaultWorker.ts refactor(common/lmlayer): Adapts to rework of base PR 2020-04-17 11:18:13 +07:00
worker-interface.d.ts change(common/lmlayer): a bit more PR review polish 2020-04-20 23:18:22 +07:00

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:

  1. Compile the inner worker code

    1. Compile the TypeScript sources for only the Worker code.
    2. Wrap the Worker code as embedded_worker.js
  2. Compile the top-level code

    1. Include embedded_worker.js verbatim using a TypeScript directive.
    2. Compile the top-level TypeScript code.
    3. 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, ./build.sh -tdd skips running the in-browser tests, and skips downloading/updating npm dependencies.