Merge pull request #9535 from keymanapp/feat/developer/eliminate-source-info-files

feat(developer): eliminate source .model_info and .keyboard_info files 🎺

Author: mcdurdin

common/web/types/src/kpj/keyman-developer-project.ts

@@ -1,5 +1,5 @@
 //
-// Version 1.0 of Keyman Developer Project .kpj file
+// Version 1.0 and 2.0 of Keyman Developer Project .kpj file
 //
 
 import { KeymanFileTypes } from '../main.js';
@@ -9,11 +9,17 @@ export class KeymanDeveloperProject {
   options: KeymanDeveloperProjectOptions;
   files: KeymanDeveloperProjectFile[];
   projectPath: string = '';
+  readonly projectFile: KeymanDeveloperProjectFile;
 
-  constructor(private projectFilename: string, version: KeymanDeveloperProjectVersion, private callbacks: CompilerCallbacks) {
-    this.projectPath = this.callbacks.path.dirname(this.projectFilename);
+  get projectFilename() {
+    return this._projectFilename;
+  }
+
+  constructor(private _projectFilename: string, version: KeymanDeveloperProjectVersion, private callbacks: CompilerCallbacks) {
+    this.projectPath = this.callbacks.path.dirname(this._projectFilename);
     this.options = new KeymanDeveloperProjectOptions(version);
     this.files = [];
+    this.projectFile = new KeymanDeveloperProjectFile20(_projectFilename, callbacks);
   }
   /**
    * Adds .kmn, .xml, .kps to project based on options.sourcePath
@@ -38,8 +44,6 @@ export class KeymanDeveloperProject {
         this.files.push(file);
       }
     }
-
-    this.addMetadataFile();
   }
 
   public isKeyboardProject() {
@@ -50,26 +54,32 @@ export class KeymanDeveloperProject {
     return !!this.files.find(file => file.fileType == KeymanFileTypes.Source.Model);
   }
 
-  public addMetadataFile() {
-    const ext = this.isLexicalModelProject() ? KeymanFileTypes.Source.ModelInfo : KeymanFileTypes.Source.KeyboardInfo;
+  private resolveProjectPath(p: string): string {
+    // Replace placeholders in the target path
+    return p.replace('$PROJECTPATH', this.projectPath);
+  }
+
+  getOutputFilePath(type: KeymanFileTypes.Binary) {
+    // Roughly corresponds to Delphi TProject.GetTargetFileName
+    let p = this.options.version == '1.0' ?
+      this.options.buildPath || '$SOURCEPATH' :
+      this.options.buildPath;
 
-    if(this.files.find(file => KeymanFileTypes.filenameIs(file.filename, ext))) {
-      return;
+    // Replace placeholders in the target path
+    if(this.options.version == '1.0') {
+      // TODO: do we need to support $VERSION?
+      // $SOURCEPATH only supported in 1.0 projects
+      p = p.replace('$SOURCEPATH', this.callbacks.path.dirname(this._projectFilename));
     }
 
-    const infoFile =
-      this.callbacks.path.join(this.projectPath,
-      this.callbacks.path.basename(this.projectFilename, KeymanFileTypes.Source.Project) + ext);
-    this.files.push(new KeymanDeveloperProjectFile20(infoFile, this.callbacks));
-  }
+    p = this.resolveProjectPath(p);
 
-  private resolveProjectPath(p: string): string {
-    // Replace placeholders in the target path
-    return p.replace('$PROJECTPATH', this.projectPath);
+    const f = this.callbacks.path.basename(this._projectFilename, KeymanFileTypes.Source.Project) + type;
+    return this.callbacks.path.normalize(this.callbacks.path.join(p, f));
   }
 
   resolveInputFilePath(file: KeymanDeveloperProjectFile): string {
-    return this.callbacks.resolveFilename(this.projectFilename, file.filePath);
+    return this.callbacks.resolveFilename(this._projectFilename, file.filePath);
   }
 
   resolveOutputFilePath(file: KeymanDeveloperProjectFile, sourceExt: string, targetExt: string): string {

common/web/types/src/kpj/kpj-file-reader.ts

@@ -77,7 +77,6 @@ export class KPJFileReader {
 
     if(result.options.version == '1.0') {
       this.transformFilesVersion10(project, result);
-      result.addMetadataFile();
     } else {
       result.populateFiles();
     }

common/web/types/src/util/file-types.ts

@@ -10,9 +10,7 @@ export const enum Source {
   LdmlKeyboard = '.xml',  // Warning, also other possible uses
   Package = '.kps',
   VisualKeyboard = '.kvks',
-  TouchLayout = '.keyman-touch-layout',
-  KeyboardInfo = '.keyboard_info',
-  ModelInfo = '.model_info',
+  TouchLayout = '.keyman-touch-layout'
 };
 
 /**
@@ -26,9 +24,7 @@ export const ALL_SOURCE: ReadonlyArray<Source> = [
   Source.LdmlKeyboard,
   Source.Package,
   Source.VisualKeyboard,
-  Source.TouchLayout,
-  Source.KeyboardInfo,
-  Source.ModelInfo,
+  Source.TouchLayout
 ] as const;
 
 /**
@@ -146,16 +142,6 @@ export function filenameIs(filename: string, fileType: Source | Binary) {
   return filename.toLowerCase().endsWith(fileType);
 }
 
-/**
- * Returns true if the file is either a .keyboard_info file or a .model_info
- * file
- * @param filename
- * @returns
- */
-export function filenameIsMetadata(filename: string) {
-  return filenameIs(filename, Source.KeyboardInfo) || filenameIs(filename, Source.ModelInfo);
-}
-
 /**
  * Replaces a filename extension with the new extension. Returns `null` if the
  * filename does not end with oldExtension.

common/web/types/test/kpj/test-kpj-file-reader.ts

@@ -77,7 +77,7 @@ describe('kpj-file-reader', function () {
     assert.isTrue(project.options.skipMetadataFiles);
     assert.equal(project.options.version, '1.0');
 
-    assert.lengthOf(project.files, 3);
+    assert.lengthOf(project.files, 2);
 
     let f: KeymanDeveloperProjectFile10 = <KeymanDeveloperProjectFile10>project.files[0];
     assert.equal(f.id, 'id_f347675c33d2e6b1c705c787fad4941a');

developer/build.sh

@@ -27,6 +27,7 @@ builder_describe \
   configure \
   build \
   test \
+  ":utils=src/common/web/utils              Developer utils" \
   ":kmcmplib=src/kmcmplib                   Compiler - .kmn compiler" \
   ":kmc-analyze=src/kmc-analyze             Compiler - Analysis Tools" \
   ":kmc-keyboard-info=src/kmc-keyboard-info Compiler - .keyboard_info Module" \

developer/src/README.md

@@ -70,31 +70,40 @@ details.
 
 ## src/kmc
 
-node-based next generation compiler, hosts kmc, kmlmi, kmlmc, kmlmp
+node-based next generation compiler, hosts kmc, (and legacy kmlmc, kmlmp)
+
+### src/kmc-analyze - Analysis tools
+
+File analysis tools for Keyman files.
+
+### src/kmc-keyboard-info - Keyboard Info Compiler
+
+Builds .keyboard_info files for use on the Keyman Cloud keyboard repository
+at https://github.com/keymanapp/keyboards. Command line access through kmc.
+
+### src/kmc-kmn - Keyboard Compiler
+
+Builds .kmx files from .kmn. Command line access through kmc.
 
 ### src/kmc-ldml - LDML Keyboard Compiler
 
-Next Generation keyboard compiler package - LDML keyboards only at present.
-Command line access through kmc.
+Next Generation keyboard compiler - LDML keyboards. Command line access through
+kmc.
 
 ### src/kmc-model - Lexical Model Compiler
 
-The Lexical Model Compiler, kmlmc, runs on nodeJS on all supported desktop
-platforms. Command line access through kmc/kmlmc.
+The Lexical Model Compiler, runs on nodeJS on all supported desktop platforms.
+Command line access through kmc.
 
-### src/kmc-package - Package Compiler
+### src/kmc-model-info - Model Info Compiler
 
-The package compiler is broadly compatible with the kmcomp .kps package
-compiler. However at this stage it is only tested with lexical models, and use
-with keyboards (either .js or .kmx) is not tested or supported. It is likely in
-the future that the kmcomp .kps compiler will be deprecated in favour of this
-one. Command line access through kmc/kmlmp.
+Builds .model_info files for use on the Keyman Cloud lexical model repository at
+https://github.com/keymanapp/lexical-models. Command line access through kmc.
 
-### src/kmc-model-info - Model Info Compiler
+### src/kmc-package - Package Compiler
 
-Merges .model_info files for use on the Keyman Cloud lexical model repository at
-https://github.com/keymanapp/lexical-models. Command line access through
-kmc/kmlmi.
+Compiles .kps packages into .kmp files. Works with both lexical model packages
+and keyboard packages. Command line access through kmc.
 
 ## src/samples
 

developer/src/common/web/utils/.gitignore

@@ -0,0 +1 @@
+build/

developer/src/common/web/utils/build.sh

@@ -0,0 +1,36 @@
+#!/usr/bin/env bash
+## START STANDARD BUILD SCRIPT INCLUDE
+# adjust relative paths as necessary
+THIS_SCRIPT="$(readlink -f "${BASH_SOURCE[0]}")"
+. "${THIS_SCRIPT%/*}/../../../../../resources/build/build-utils.sh"
+## END STANDARD BUILD SCRIPT INCLUDE
+
+cd "$THIS_SCRIPT_PATH"
+
+. "$KEYMAN_ROOT/resources/shellHelperFunctions.sh"
+
+builder_describe "Build Keyman Developer web utility module" \
+  "@/common/web/types" \
+  "clean" \
+  "configure" \
+  "build" \
+  "test"
+
+builder_describe_outputs \
+  configure     /node_modules \
+  build         /developer/src/common/web/utils/build/index.js
+
+builder_parse "$@"
+
+#-------------------------------------------------------------------------------------------------------------------
+
+builder_run_action clean       rm -rf ./build/
+builder_run_action configure   verify_npm_setup
+builder_run_action build       tsc --build
+
+if builder_start_action test; then
+  eslint .
+  tsc --build test
+  c8 --reporter=lcov --reporter=text --exclude-after-remap mocha
+  builder_finish_action success test
+fi

developer/src/common/web/utils/index.ts

@@ -0,0 +1 @@
+export { validateMITLicense } from './src/validate-mit-license.js';

developer/src/common/web/utils/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@keymanapp/developer-utils",
+  "private": true,
+  "description": "Keyman Developer utilities",
+  "type": "module",
+  "exports": {
+    ".": "./build/index.js"
+  },
+  "files": [
+    "/build/"
+  ],
+  "devDependencies": {
+    "@types/node": "^20.4.1",
+    "ts-node": "^9.1.1",
+    "typescript": "^4.9.5",
+    "c8": "^7.12.0",
+    "chai": "^4.3.4",
+    "mocha": "^8.4.0"
+  },
+  "scripts": {
+    "build": "tsc -b"
+  },
+  "dependencies": {
+    "@keymanapp/common-types": "*"
+  },
+  "mocha": {
+    "spec": "build/test/**/test-*.js",
+    "require": [
+      "source-map-support/register"
+    ]
+  }
+}