chore: use kmc instead of kmcomp to build test keyboards

Author: mcdurdin

common/test/keyboards/baseline/k_017___space_mnemonic_kbd.kmn

@@ -4,8 +4,7 @@ c keys: [K_A][K_B][K_SPACE][K_C][K_SPACE][K_D][K_SPACE][K_D][K_E]
 c expected: XYZ
 
 store(&VERSION) '9.0'
-NAME "Alt key tests"
-HOTKEY "[CTRL SHIFT K_A]"
+store(&HOTKEY) "[CTRL SHIFT K_A]"
 store(&mnemoniclayout) "1"
 
 begin Unicode > use(main)

common/test/keyboards/baseline/k_018___nul_testing.kmn

@@ -3,11 +3,10 @@ c Description: Tests the processing of nul in LHS of rules
 c keys: [K_A][K_A]
 c expected: OKa
 
-VERSION 9.0   
-NAME "Nul test"
-HOTKEY "[CTRL SHIFT K_N]"
+store(&VERSION) "9.0"
+store(&HOTKEY) "[CTRL SHIFT K_N]"
 
-begin unicode > use(main)                   
+begin unicode > use(main)
 
 group(Main) using keys
     nul + 'a' > 'OK'

common/test/keyboards/build.sh

@@ -1,24 +1,19 @@
 #!/usr/bin/env bash
-
-set -e
-set -u
-
+# TODO: builder script plz
 ## START STANDARD BUILD SCRIPT INCLUDE
 # adjust relative paths as necessary
 THIS_SCRIPT="$(readlink -f "${BASH_SOURCE[0]}")"
 . "${THIS_SCRIPT%/*}/../../../resources/build/build-utils.sh"
-. "$KEYMAN_ROOT/resources/shellHelperFunctions.sh"
 ## END STANDARD BUILD SCRIPT INCLUDE
+. "$KEYMAN_ROOT/resources/shellHelperFunctions.sh"
 THIS_DIR="$(dirname "$THIS_SCRIPT")"
 
 display_usage() {
   echo "usage: build.sh [build options] [targets]"
   echo
   echo "Build options:"
-  echo "  --clean, -c       Clean instead of build"
   echo "  --debug, -d       Debug build"
   echo "  --silent, -s      Suppress information messages"
-  echo "  --keyboard, -k    Build only keyboards (not packages)"
   echo "  --kmc path        Specify path to kmc, defaults"
   echo "                    to developer/src/kmc/build/"
   echo "  --zip-source      Create zip file for source of each"
@@ -29,7 +24,7 @@ display_usage() {
 
   for d in "$THIS_DIR/"*/; do
     d="$(basename "$d")"
-    if [ "$d" != "invalid" ]; then
+    if [ "$d" != "invalid" && "$d" != "issue"]; then
       echo "  $d"
     fi
   done
@@ -38,14 +33,12 @@ display_usage() {
   exit 0
 }
 
+readonly KMC_LAUNCHER=node
 QUIET=false
 DEBUG=false
-CLEAN=false
-KEYBOARDS_ONLY=false
-CUSTOM_KMCOMP=
 INDEX=false
 ZIPSOURCE=false
-KMCOMP="$KEYMAN_ROOT/developer/bin/kmcomp.exe"
+KMC="$KEYMAN_ROOT/developer/src/kmc/build/src/kmc.js"
 TARGETS=()
 
 # Parse args
@@ -57,69 +50,28 @@ while [[ $# -gt 0 ]] ; do
     --help|-h|-\?)
       display_usage
       ;;
-    --clean|-c)
-      CLEAN=true
-      ;;
     --debug|-d)
       DEBUG=true
       ;;
     --silent|-s)
       QUIET=true
       ;;
-    --keyboard|-k)
-      KEYBOARDS_ONLY=true
-      ;;
     --zip-source)
       ZIPSOURCE=true
       ;;
     --index)
       INDEX=true
       ;;
-    --kmcomp)
+    --kmc)
       shift
-      KMCOMP="$1"
-      CUSTOM_KMCOMP=true
+      KMC="$1"
       ;;
     *)
       TARGETS+=("$key")
   esac
   shift
 done
 
-# TODO: while this is intended to be cross platform, we
-# don't currently have a binary version of kmcomp available
-# during Linux and macOS builds, so that will need to be
-# manually sourced.
-KMCOMP_LAUNCHER=
-
-if ! $CUSTOM_KMCOMP; then
-  case "${OSTYPE}" in
-    "cygwin")
-      ;;
-    "msys")
-      ;;
-    "darwin"*)
-      # For Catalina (10.15) onwards, must use wine64
-      base_macos_ver=10.15
-      macos_ver=$(sw_vers -productVersion)
-      if verlt "$macos_ver" "$base_macos_ver"; then
-        KMCOMP_LAUNCHER=wine
-      else
-        # On Catalina, and later versions:
-        # wine-4.12.1 works; wine-5.0, wine-5.7 do not.
-        # retrieve these from:
-        # `brew tap gcenx/wine && brew install --cask --no-quarantine wine-crossover`
-        # may also need to `sudo spctl --master-disable`
-        KMCOMP_LAUNCHER=wine64
-        KMCOMP="$(dirname $KMCOMP)/kmcomp.x64.exe"
-      fi
-      ;;
-    *)
-      KMCOMP_LAUNCHER=wine
-      ;;
-  esac
-fi
-
 # Build list of available targets from subfolders, if none specified
 if [ ${#TARGETS[@]} == 0 ]; then
   for d in "$THIS_DIR/"*/; do
@@ -132,56 +84,14 @@ fi
 
 if ! $QUIET; then
   displayInfo "" \
-      "CLEAN: $CLEAN" \
       "DEBUG: $DEBUG" \
       "QUIET: $QUIET" \
-      "KEYBOARDS_ONLY: $KEYBOARDS_ONLY" \
       "TARGETS: ${TARGETS[@]}" \
       "ZIPSOURCE: $ZIPSOURCE" \
       "INDEX: $INDEX" \
       ""
 fi
 
-clean() {
-  local kpj="$1.kpj" ss= s=
-  if $QUIET; then
-    ss=-ss
-    s=-s
-  fi
-  pushd "$1" > /dev/null
-  if [ -f build.sh ]; then
-    ./build.sh -c $s
-  else
-    $KMCOMP_LAUNCHER "$KMCOMP" -c $ss "$kpj"
-  fi
-  popd > /dev/null
-}
-
-build() {
-  local kpj="$1.kpj" d= t= ss= target= s= k=
-  if $KEYBOARDS_ONLY; then
-    k=-k
-    t=-t
-    target="$1.kmn"
-  fi
-  if $DEBUG; then
-    d=-d
-  fi
-  if $QUIET; then
-    s=-s
-    ss=-ss
-  fi
-  # -w - treat warnings as errors, we'll force this
-  # -cfc - check filename conventions
-  pushd "$1" > /dev/null
-  if [ -f build.sh ]; then
-    ./build.sh $d $k $s
-  else
-    $KMCOMP_LAUNCHER "$KMCOMP" $d $ss -w -cfc "$kpj" $t "$target"
-  fi
-  popd > /dev/null
-}
-
 zipsource() {
   local target="$1"
   pushd "$1" > /dev/null
@@ -191,35 +101,26 @@ zipsource() {
 
 ###
 
-for TARGET in "${TARGETS[@]}"; do
-  if $CLEAN; then
-    if ! $QUIET; then
-      echo
-      builder_heading "Cleaning target $TARGET"
-      echo
-    fi
-    clean "$TARGET"
-  else
-    if ! $QUIET; then
-      echo
-      builder_heading "Building target $TARGET"
-      echo
-    fi
-    build "$TARGET"
+d=
+ss=
+if $DEBUG; then
+  d=-d
+fi
+if $QUIET; then
+  ss="--log-level silent"
+fi
+$KMC_LAUNCHER "$KMC" build $d $ss -w "${TARGETS[@]}"
 
-    if $ZIPSOURCE; then
-      zipsource "$TARGET"
-    fi
+for TARGET in "${TARGETS[@]}"; do
+  if $ZIPSOURCE; then
+    zipsource "$TARGET"
   fi
 done
 
 ###
 
 if $INDEX; then
-  if $CLEAN; then
-    rm -f "$THIS_DIR/index.html"
-  else
-    cat << EOF > "$THIS_DIR/index.html"
+  cat << EOF > "$THIS_DIR/index.html"
 <!DOCTYPE html>
 <html>
   <head>
@@ -231,19 +132,18 @@ if $INDEX; then
     <ul>
 EOF
 
-    for TARGET in "${TARGETS[@]}"; do
-      if $ZIPSOURCE; then
-        echo "      <li><a href='$TARGET/build/$TARGET.kmp'>$TARGET.kmp</a> (<a href='$TARGET/${TARGET}_source.zip'>source</a>)</li>" >> "$THIS_DIR/index.html"
-      else
-        echo "      <li><a href='$TARGET/build/$TARGET.kmp'>$TARGET.kmp</a></li>" >> "$THIS_DIR/index.html"
-      fi
-    done
+  for TARGET in "${TARGETS[@]}"; do
+    if $ZIPSOURCE; then
+      echo "      <li><a href='$TARGET/build/$TARGET.kmp'>$TARGET.kmp</a> (<a href='$TARGET/${TARGET}_source.zip'>source</a>)</li>" >> "$THIS_DIR/index.html"
+    else
+      echo "      <li><a href='$TARGET/build/$TARGET.kmp'>$TARGET.kmp</a></li>" >> "$THIS_DIR/index.html"
+    fi
+  done
 
-    cat << 'EOF' >> "$THIS_DIR/index.html"
+  cat << 'EOF' >> "$THIS_DIR/index.html"
     </ul>
   </body>
 </html>
 EOF
-  fi
+
 fi
-exit 0

common/test/keyboards/obolo_chwerty_6347/source/obolo_chwerty_6347.kps

@@ -113,7 +113,7 @@
       <ID>obolo_chwerty_6347</ID>
       <Version>1.2.1</Version>
       <Languages>
-        <Language ID="ann-Latn">Obolo (Andoni)</Language>
+        <Language ID="ann">Obolo (Andoni)</Language>
       </Languages>
     </Keyboard>
   </Keyboards>

common/test/keyboards/obolo_chwerty_6351/source/obolo_chwerty_6351.kps

@@ -113,7 +113,7 @@
       <ID>obolo_chwerty_6351</ID>
       <Version>1.2.1</Version>
       <Languages>
-        <Language ID="ann-Latn">Obolo (Andoni)</Language>
+        <Language ID="ann">Obolo (Andoni)</Language>
       </Languages>
     </Keyboard>
   </Keyboards>

developer/src/kmcmplib/tests/fixtures/valid-keyboards/compile_legacy.bat

@@ -2,4 +2,6 @@
 echo Compiles the keyboards using the legacy kmcomp.exe
 echo to use as baseline comparisons for kmcmplib
 rem TODO: we'll need a binary download for kmcomp.exe
+rem       We can use the last version available on downloads.keyman.com
+rem       see keyboards repo for example of best way to download+extract
 for %%d in (*.kmn) do ..\..\..\..\..\bin\kmcomp -no-compiler-version -d %%d

developer/src/test/auto/compile-supplementary-support/Makefile

@@ -2,16 +2,16 @@
 # test if KS=1 is in the right files, both in debug and non-debug versions
 #
 
-KMCOMP="..\..\..\..\bin\kmc.cmd" build
-KMCOMPD=$(KMCOMP) -d
+KMC="..\..\..\..\bin\kmc.cmd" build
+KMC_DEBUG=$(KMC) -d
 
 test: test-nodebug test-debug
 
 KMN=i3317_nosupp.kmn i3317_withsupp.kmn i3317_withsupp_incontext.kmn i3317_withsupp_inmatch.kmn i3317_withsupp_innomatch.kmn i3317_withsupp_instore.kmn
 
 # TODO: replace with build.sh script
 test-nodebug:
-	$(KMCOMP) $(KMN)
+	$(KMC) $(KMN)
 	findstr /v /m "KS=1" i3317_nosupp.js
 	findstr /m "KS=1" i3317_withsupp.js
 	findstr /m "KS=1" i3317_withsupp_incontext.js
@@ -20,7 +20,7 @@ test-nodebug:
 	findstr /m "KS=1" i3317_withsupp_instore.js
 
 test-debug:
-	$(KMCOMPD) $(KMN)
+	$(KMC_DEBUG) $(KMN)
 	findstr /v /m "KS=1" i3317_nosupp.js
 	findstr /m "KS=1" i3317_withsupp.js
 	findstr /m "KS=1" i3317_withsupp_incontext.js