refactor(web): move common/models to web/src/engine/predictive-text

Fixes: #12133

.github/labeler.yml

@@ -20,9 +20,8 @@ common/:
   - common/**
   - resources/**
 
-common/models/: common/models/**
 common/models/templates/: web/src/engine/predictive-text/templates/**
-common/models/wordbreakers/: common/models/wordbreakers/**
+common/models/wordbreakers/: web/src/engine/predictive-text/wordbreakers/**
 
 common/resources/: resources/**
 common/web/: common/web/**

docs/CODEOWNERS

@@ -8,7 +8,6 @@
 /common/                          @mcdurdin     @rc-swag
 /core/                            @mcdurdin     @rc-swag
 /common/lexical-model-types/      @jahorton     @mcdurdin
-/common/models/                   @jahorton     @mcdurdin
 /common/schemas/                  @mcdurdin     @jahorton
 /common/test/                     @mcdurdin     @ermshiperete
 /common/web/                      @jahorton     @mcdurdin

package.json

@@ -46,7 +46,6 @@
     "developer/src/kmc-package",
     "developer/src/kmc",
     "developer/src/server",
-    "common/models/*",
     "common/test/resources",
     "common/tools/*",
     "common/web/*",

resources/standards-data/unicode-character-database/download.sh

@@ -26,7 +26,7 @@ BLOCKS_SRC_LOCAL="./Blocks.txt"
 UNICODE_DATA_SRC_HREF="https://www.unicode.org/Public/$KEYMAN_VERSION_UNICODE/ucd/UnicodeData.txt"
 UNICODE_DATA_SRC_LOCAL="./UnicodeData.txt"
 
-# Used by common/models/wordbreakers for the default Unicode wordbreaker.
+# Used by web/src/engine/predictive-text/wordbreakers for the default Unicode wordbreaker.
 WORDBREAK_PROP_SRC_HREF="https://www.unicode.org/Public/$KEYMAN_VERSION_UNICODE/ucd/auxiliary/WordBreakProperty.txt"
 WORDBREAK_PROP_SRC_LOCAL="./WordBreakProperty.txt"
 
@@ -55,4 +55,4 @@ do_download() {
   downloadPropertyFile "${EMOJI_DATA_SRC_HREF}"      "${EMOJI_DATA_SRC_LOCAL}"
 }
 
-builder_run_action download  do_download
+builder_run_action download  do_download

resources/stats/stats.sh

@@ -13,7 +13,7 @@ THIS_SCRIPT="$(readlink -f "${BASH_SOURCE[0]}")"
 
 cd "$THIS_SCRIPT_PATH"
 
-platforms=(android/ ios/ linux/ mac/ web/ windows/ developer/ core/ common/models/)
+platforms=(android/ ios/ linux/ mac/ web/ windows/ developer/ core/)
 
 builder_describe "Stats collector for Keyman PRs and issues
 

tsconfig.base.json

@@ -28,7 +28,7 @@
       "@keymanapp/common-types": ["./common/web/types/src/main"],
       "@keymanapp/keyman": ["./web" ],
       "@keymanapp/models-templates": ["./web/src/engine/predictive-text/templates/"],
-      "@keymanapp/models-wordbreakers": ["./common/models/wordbreakers"],
+      "@keymanapp/models-wordbreakers": ["./web/src/engine/predictive-text/wordbreakers"],
       "@keymanapp/web-utils": ["./common/web/utils"],
       "@keymanapp/lm-message-types": ["./web/src/engine/predictive-text/types"],
       "@keymanapp/keyman-version": ["./common/web/keyman-version"],

tsconfig.json

@@ -2,8 +2,6 @@
   "references": [
     { "path": "./core/include/ldml/tsconfig.json" },
 
-    { "path": "./cweb/src/engine/predictive-text/templates/tsconfig.json" },
-    { "path": "./common/models/wordbreakers/tsconfig.json" },
     { "path": "./common/tools/hextobin/" },
 
     { "path": "./common/web/keyman-version" },
@@ -38,6 +36,8 @@
 
     { "path": "./web/src/tsconfig.all.json" },
     { "path": "./web/src/engine/predictive-text/types/" },
+    { "path": "./web/src/engine/predictive-text/templates" },
+    { "path": "./web/src/engine/predictive-text/wordbreakers" },
     { "path": "./web/src/engine/predictive-text/worker-main/tsconfig.all.json" },
     { "path": "./web/src/engine/predictive-text/worker-thread" },
     { "path": "./web/src/engine/osk/gesture-processor/tsconfig.json" },

web/README.md

@@ -86,7 +86,7 @@ graph TD;
     OSK-->KeyboardSpec;
     WebUtils["@keymanapp/web-utils<br>(/common/web/utils)"];
     KeyboardSpec---->WebUtils;
-    Wordbreakers["@keymanapp/models-wordbreakers<br>(/common/models/wordbreakers)"];
+    Wordbreakers["@keymanapp/models-wordbreakers<br>(/web/src/engine/predictive-text/wordbreakers)"];
     Models["@keymanapp/models-templates<br>(/web/src/engine/predictive-text/templates/)"];
     Models-->WebUtils;
     LMWorker["@keymanapp/lm-worker<br>(/web/src/engine/predictive-text/worker-thread)"];

web/src/engine/predictive-text/templates/build.sh

@@ -15,7 +15,7 @@ THIS_SCRIPT="$(readlink -f "${BASH_SOURCE[0]}")"
 builder_describe "Builds the predictive-text model template implementation module" \
   "@/common/web/keyman-version" \
   "@/common/web/es-bundling" \
-  "@/common/models/wordbreakers" \
+  "@../wordbreakers" \
   "clean" \
   "configure" \
   "build" \

web/src/engine/predictive-text/templates/tsconfig.json

@@ -10,7 +10,7 @@
   "references": [
     { "path": "../../../../../common/web/types" },
     { "path": "../../../../../common/web/utils" },
-    { "path": "../../../../../common/models/wordbreakers" }
+    { "path": "../wordbreakers" }
   ],
   "include": [
 	"src/**/*.ts"

common/models/wordbreakers/README.md → web/src/engine/predictive-text/wordbreakers/README.md

@@ -4,13 +4,13 @@ The word breakers bundled in Keyman's modeling layer (common/models).
 
 Includes:
 
- - `default` — a word breaker based on the Unicode default word boundary specification
- - _deprecated_ `ascii` — an example word breaker
- - _deprecated_ `placeholder` — an example word breaker
+- `default` — a word breaker based on the Unicode default word boundary specification
+- _deprecated_ `ascii` — an example word breaker
+- _deprecated_ `placeholder` — an example word breaker
 
 ## Usage
 
-```
+```typescript
 import {wordBreakers} from '@keymanapp/models-wordbreakers';
 const breakWords = wordBreakers['default'];
 

common/models/wordbreakers/build.sh → web/src/engine/predictive-text/wordbreakers/build.sh

@@ -5,7 +5,7 @@
 ## START STANDARD BUILD SCRIPT INCLUDE
 # adjust relative paths as necessary
 THIS_SCRIPT="$(readlink -f "${BASH_SOURCE[0]}")"
-. "$(dirname "$THIS_SCRIPT")/../../../resources/build/builder.inc.sh"
+. "$(dirname "$THIS_SCRIPT")/../../../../../resources/build/builder.inc.sh"
 ## END STANDARD BUILD SCRIPT INCLUDE
 
 . "$KEYMAN_ROOT/resources/shellHelperFunctions.sh"

common/models/wordbreakers/tools/data-compiler/index.ts → web/src/engine/predictive-text/wordbreakers/tools/data-compiler/index.ts

@@ -144,7 +144,7 @@ function escape(codedChar: string) {
 
 // Generate the file!
 stream.write(`// Automatically generated file. DO NOT MODIFY.
-// The generator script is defined at /common/models/wordbreakers/src/data-compiler/index.ts.
+// The generator script is defined at /web/src/engine/predictive-text/wordbreakers/src/data-compiler/index.ts.
 
 /**
  * Valid values for a word break property.

common/models/wordbreakers/tsconfig.json → web/src/engine/predictive-text/wordbreakers/tsconfig.json

@@ -1,6 +1,5 @@
 {
-  "extends": "../tsconfig.kmw-worker-base.json",
-
+  "extends": "../../../../tsconfig.base.json",
   "compilerOptions": {
     "baseUrl": "./",
     "outDir": "./build/main/obj",

web/src/engine/predictive-text/worker-main/unit_tests/test.sh

@@ -48,8 +48,8 @@ if builder_start_action test:libraries; then
   # So, for now, we add a text header to clarify what is running at each stage, in
   # addition to fair bit of `pushd` and `popd`.
   echo
-  echo "### Running $(builder_term common/models/wordbreakers) tests"
-  "$KEYMAN_ROOT/common/models/wordbreakers/build.sh" test $TEST_OPTS
+  echo "### Running $(builder_term web/src/engine/predictive-text/wordbreakers) tests"
+  "$KEYMAN_ROOT/web/src/engine/predictive-text/wordbreakers/build.sh" test $TEST_OPTS
 
   pushd "$KEYMAN_ROOT/web/src/engine/predictive-text/templates/"
   echo

web/src/engine/predictive-text/worker-thread/build.sh

@@ -28,8 +28,8 @@ builder_describe \
   "@/web/src/tools/building/sourcemap-root" \
   "@/common/web/keyman-version" \
   "@/common/web/es-bundling" \
-  "@/common/models/wordbreakers" \
-  "@/web/src/engine/predictive-text/templates/" \
+  "@../wordbreakers" \
+  "@../templates/" \
   configure clean build test --ci
 
 builder_describe_outputs \

web/src/engine/predictive-text/worker-thread/tsconfig.json

@@ -24,7 +24,7 @@
     { "path": "../../../../../common/web/keyman-version" },
     { "path": "../../../../../common/web/utils" },
     { "path": "../templates" },
-    { "path": "../../../../../common/models/wordbreakers" },
+    { "path": "../wordbreakers" },
   ],
   "include": [
     "src/main/**/*.ts"