@keymanapp/kmc-generate 18.0.138-alpha

package/build/src/keyman-keyboard-generator.js

@@ -0,0 +1,89 @@
+/*
+ * Keyman is copyright (C) SIL International. MIT License.
+ *
+ * Generate a Keyman keyboard project (.kmn source)
+ */
+import { KeymanTargets } from '@keymanapp/common-types';
+import { BasicGenerator } from './basic-generator.js';
+/**
+ * @public
+ * Generate a Keyman keyboard project. The generator does not read or write from
+ * filesystem or network directly, but relies on callbacks for all external IO.
+ */
+export class KeymanKeyboardGenerator extends BasicGenerator {
+    //  Future: we probably want to have a more abstract implementation so that we
+    //  can use this for both generate and clone keyboard?
+    //
+    //  So we have a structure of an entire project passed into to a writer. Even if
+    //  we can't cleanly reuse at least we can copy the code more easily and it will
+    //  be more maintainable.
+    //
+    //  But for now we are working with plain text approach
+    static SFile_Keyboard = 'keyboard';
+    static SFile_KeyboardKMN = `${this.SPath_Source}${this.SFile_Keyboard}${".kmn" /* KeymanFileTypes.Source.KeymanKeyboard */}`;
+    static SFile_KeyboardKPS = `${this.SPath_Source}${this.SFile_Keyboard}${".kps" /* KeymanFileTypes.Source.Package */}`;
+    static SFile_KeyboardKVKS = `${this.SPath_Source}${this.SFile_Keyboard}${".kvks" /* KeymanFileTypes.Source.VisualKeyboard */}`;
+    static SFile_TouchLayout = `${this.SPath_Source}${this.SFile_Keyboard}${".keyman-touch-layout" /* KeymanFileTypes.Source.TouchLayout */}`;
+    static SFile_Project = `${this.SFile_Keyboard}${".kpj" /* KeymanFileTypes.Source.Project */}`;
+    /**
+     * Generate a Keyman Keyboard project. Returns an object containing binary
+     * artifacts on success. The files are passed in by name, and the compiler
+     * will use callbacks as passed to the {@link AbstractGenerator.init}
+     * function to read any input files by disk.
+     * @returns         Binary artifacts on success, null on failure.
+     */
+    async run() {
+        this.preGenerate();
+        const artifacts = this.defaultArtifacts();
+        this.templatePath = 'kmn-keyboard';
+        this.filenameMap[KeymanKeyboardGenerator.SFile_Project] = this.options.id + ".kpj" /* KeymanFileTypes.Source.Project */;
+        if (this.hasKVKS()) {
+            this.includedPrefixes.push('KVKS');
+            this.filenameMap[KeymanKeyboardGenerator.SFile_KeyboardKVKS] =
+                KeymanKeyboardGenerator.SPath_Source + this.options.id + ".kvks" /* KeymanFileTypes.Source.VisualKeyboard */;
+        }
+        if (this.hasWeb()) {
+            this.includedPrefixes.push('Web');
+        }
+        if (this.hasTouchLayout()) {
+            this.includedPrefixes.push('TouchLayout');
+            this.filenameMap[KeymanKeyboardGenerator.SFile_TouchLayout] =
+                KeymanKeyboardGenerator.SPath_Source + this.options.id + ".keyman-touch-layout" /* KeymanFileTypes.Source.TouchLayout */;
+        }
+        if (this.hasIcon()) {
+            this.includedPrefixes.push('Icon');
+        }
+        if (this.hasKMX()) {
+            this.includedPrefixes.push('KMX');
+        }
+        this.filenameMap[KeymanKeyboardGenerator.SFile_KeyboardKMN] =
+            KeymanKeyboardGenerator.SPath_Source + this.options.id + ".kmn" /* KeymanFileTypes.Source.KeymanKeyboard */;
+        this.filenameMap[KeymanKeyboardGenerator.SFile_KeyboardKPS] =
+            KeymanKeyboardGenerator.SPath_Source + this.options.id + ".kps" /* KeymanFileTypes.Source.Package */;
+        if (!this.generate(artifacts)) {
+            return null;
+        }
+        // Special case for creating icon, run after successful creation of other
+        // project bits and pieces
+        if (this.hasIcon()) {
+            this.writeIcon(artifacts);
+        }
+        return { artifacts };
+    }
+    targetIncludes = (targets) => {
+        return this.resolvedTargets.some(t => targets.includes(t));
+    };
+    hasKVKS = () => this.targetIncludes(KeymanTargets.KeymanTargetsUsingKVK);
+    hasWeb = () => this.targetIncludes(KeymanTargets.KMWKeymanTargets);
+    hasKMX = () => this.targetIncludes(KeymanTargets.KMXKeymanTargets);
+    hasTouchLayout = () => this.targetIncludes(KeymanTargets.TouchKeymanTargets);
+    // TODO-GENERATE, once writeIcon is implemented:
+    // hasIcon = () => this.options.icon && this.targetIncludes(KeymanTargets.KMXKeymanTargets);
+    hasIcon = () => false;
+    writeIcon(artifacts) {
+        // TODO-GENERATE: this will require some effort
+        // proposal: generate 16x16 icon with 2-3 letters. Following TKeyboardIconGenerator.GenerateIcon
+        // research for .ico writer in node
+    }
+}
+//# sourceMappingURL=keyman-keyboard-generator.js.map

package/build/src/keyman-keyboard-generator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"keyman-keyboard-generator.js","sourceRoot":"","sources":["../../src/keyman-keyboard-generator.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAmB,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAGzE,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAEtD;;;;GAIG;AACH,MAAM,OAAO,uBAAwB,SAAQ,cAAc;IACzD,8EAA8E;IAC9E,sDAAsD;IACtD,EAAE;IACF,gFAAgF;IAChF,gFAAgF;IAChF,yBAAyB;IACzB,EAAE;IACF,uDAAuD;IAEvD,MAAM,CAAU,cAAc,GAAG,UAAU,CAAC;IAC5C,MAAM,CAAU,iBAAiB,GAAG,GAAG,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,cAAc,GAAG,kDAAqC,EAAE,CAAC;IACzH,MAAM,CAAU,iBAAiB,GAAG,GAAG,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,cAAc,GAAG,2CAA8B,EAAE,CAAC;IAClH,MAAM,CAAU,kBAAkB,GAAG,GAAG,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,cAAc,GAAG,mDAAqC,EAAE,CAAC;IAC1H,MAAM,CAAU,iBAAiB,GAAG,GAAG,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,cAAc,GAAG,+DAAkC,EAAE,CAAC;IACtH,MAAM,CAAU,aAAa,GAAG,GAAG,IAAI,CAAC,cAAc,GAAG,2CAA8B,EAAE,CAAC;IAE1F;;;;;;OAMG;IACH,KAAK,CAAC,GAAG;QACP,IAAI,CAAC,WAAW,EAAE,CAAC;QAEnB,MAAM,SAAS,GAAuB,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAE9D,IAAI,CAAC,YAAY,GAAG,cAAc,CAAC;QAEnC,IAAI,CAAC,WAAW,CAAC,uBAAuB,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,EAAE,8CAA+B,CAAC;QAEzG,IAAG,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC;YAClB,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACnC,IAAI,CAAC,WAAW,CAAC,uBAAuB,CAAC,kBAAkB,CAAC;gBAC1D,uBAAuB,CAAC,YAAY,GAAC,IAAI,CAAC,OAAO,CAAC,EAAE,sDAAsC,CAAC;QAC/F,CAAC;QAED,IAAG,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC;YACjB,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACpC,CAAC;QAED,IAAG,IAAI,CAAC,cAAc,EAAE,EAAE,CAAC;YACzB,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;YAC1C,IAAI,CAAC,WAAW,CAAC,uBAAuB,CAAC,iBAAiB,CAAC;gBACzD,uBAAuB,CAAC,YAAY,GAAC,IAAI,CAAC,OAAO,CAAC,EAAE,kEAAmC,CAAC;QAC5F,CAAC;QAED,IAAG,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC;YAClB,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACrC,CAAC;QAED,IAAG,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC;YACjB,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACpC,CAAC;QAED,IAAI,CAAC,WAAW,CAAC,uBAAuB,CAAC,iBAAiB,CAAC;YACzD,uBAAuB,CAAC,YAAY,GAAC,IAAI,CAAC,OAAO,CAAC,EAAE,qDAAsC,CAAC;QAC7F,IAAI,CAAC,WAAW,CAAC,uBAAuB,CAAC,iBAAiB,CAAC;YACzD,uBAAuB,CAAC,YAAY,GAAC,IAAI,CAAC,OAAO,CAAC,EAAE,8CAA+B,CAAC;QAEtF,IAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;YAC7B,OAAO,IAAI,CAAC;QACd,CAAC;QAED,yEAAyE;QACzE,0BAA0B;QAC1B,IAAG,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC;YAClB,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QAC5B,CAAC;QAED,OAAO,EAAC,SAAS,EAAC,CAAC;IACrB,CAAC;IAEgB,cAAc,GAAG,CAAC,OAAqC,EAAE,EAAE;QAC1E,OAAO,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IAC7D,CAAC,CAAA;IAEgB,OAAO,GAAU,GAAG,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,qBAAqB,CAAC,CAAC;IAChF,MAAM,GAAW,GAAG,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,gBAAgB,CAAC,CAAC;IAC3E,MAAM,GAAW,GAAG,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,gBAAgB,CAAC,CAAC;IAC3E,cAAc,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,kBAAkB,CAAC,CAAC;IAE9F,gDAAgD;IAChD,4FAA4F;IAC3E,OAAO,GAAG,GAAG,EAAE,CAAC,KAAK,CAAC;IAE/B,SAAS,CAAC,SAA6B;QAC7C,+CAA+C;QAC/C,gGAAgG;QAChG,mCAAmC;IACrC,CAAC"}

package/build/src/ldml-keyboard-generator.d.ts

@@ -0,0 +1,25 @@
+import { KeymanCompiler } from '@keymanapp/developer-utils';
+import { GeneratorResult } from './abstract-generator.js';
+import { BasicGenerator } from './basic-generator.js';
+/**
+ * @public
+ * Generate a LDML keyboard project. The generator does not read or write from
+ * filesystem or network directly, but relies on callbacks for all external IO.
+ */
+export declare class LdmlKeyboardGenerator extends BasicGenerator implements KeymanCompiler {
+    protected static readonly SFile_Keyboard = "keyboard";
+    static readonly SFile_KeyboardXML: string;
+    static readonly SFile_Package: string;
+    static readonly SFile_Project: string;
+    /**
+     * Generate a LDML Keyboard project. Returns an object containing binary
+     * artifacts on success. The files are passed in by name, and the compiler
+     * will use callbacks as passed to the {@link AbstractGenerator.init}
+     * function to read any input files by disk.
+     * @returns         Binary artifacts on success, null on failure.
+     */
+    run(): Promise<GeneratorResult>;
+    private readonly generateFirstLangTag;
+    private readonly generateAlternateLangTags;
+}
+//# sourceMappingURL=ldml-keyboard-generator.d.ts.map

package/build/src/ldml-keyboard-generator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ldml-keyboard-generator.d.ts","sourceRoot":"","sources":["../../src/ldml-keyboard-generator.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,cAAc,EAAG,MAAM,4BAA4B,CAAC;AAC7D,OAAO,EAAsB,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAC9E,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAEtD;;;;GAIG;AACH,qBAAa,qBAAsB,SAAQ,cAAe,YAAW,cAAc;IACjF,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,cAAc,cAAc;IACtD,MAAM,CAAC,QAAQ,CAAC,iBAAiB,SAAsF;IACvH,MAAM,CAAC,QAAQ,CAAC,aAAa,SAAiF;IAC9G,MAAM,CAAC,QAAQ,CAAC,aAAa,SAA6D;IAE1F;;;;;;OAMG;IACG,GAAG,IAAI,OAAO,CAAC,eAAe,CAAC;IAsBrC,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAuD;IAC5F,OAAO,CAAC,QAAQ,CAAC,yBAAyB,CAWzC;CACF"}

package/build/src/ldml-keyboard-generator.js

@@ -0,0 +1,52 @@
+/*
+ * Keyman is copyright (C) SIL International. MIT License.
+ *
+ * Generate a Keyman LDML keyboard project (.xml source)
+ */
+import { BasicGenerator } from './basic-generator.js';
+/**
+ * @public
+ * Generate a LDML keyboard project. The generator does not read or write from
+ * filesystem or network directly, but relies on callbacks for all external IO.
+ */
+export class LdmlKeyboardGenerator extends BasicGenerator {
+    static SFile_Keyboard = 'keyboard';
+    static SFile_KeyboardXML = `${this.SPath_Source}${this.SFile_Keyboard}${".xml" /* KeymanFileTypes.Source.LdmlKeyboard */}`;
+    static SFile_Package = `${this.SPath_Source}${this.SFile_Keyboard}${".kps" /* KeymanFileTypes.Source.Package */}`;
+    static SFile_Project = `${this.SFile_Keyboard}${".kpj" /* KeymanFileTypes.Source.Project */}`;
+    /**
+     * Generate a LDML Keyboard project. Returns an object containing binary
+     * artifacts on success. The files are passed in by name, and the compiler
+     * will use callbacks as passed to the {@link AbstractGenerator.init}
+     * function to read any input files by disk.
+     * @returns         Binary artifacts on success, null on failure.
+     */
+    async run() {
+        this.preGenerate();
+        const artifacts = this.defaultArtifacts();
+        this.templatePath = 'ldml-keyboard';
+        this.filenameMap[LdmlKeyboardGenerator.SFile_Project] =
+            this.options.id + ".kpj" /* KeymanFileTypes.Source.Project */;
+        this.filenameMap[LdmlKeyboardGenerator.SFile_KeyboardXML] =
+            LdmlKeyboardGenerator.SPath_Source + this.options.id + ".xml" /* KeymanFileTypes.Source.LdmlKeyboard */;
+        this.filenameMap[LdmlKeyboardGenerator.SFile_Package] =
+            LdmlKeyboardGenerator.SPath_Source + this.options.id + ".kps" /* KeymanFileTypes.Source.Package */;
+        this.tokenMap['$LANG_TAG'] = this.generateFirstLangTag();
+        this.tokenMap['$ADDITIONAL_LANG_TAGS'] = this.generateAlternateLangTags();
+        if (!this.generate(artifacts)) {
+            return null;
+        }
+        return { artifacts };
+    }
+    generateFirstLangTag = () => this.languageTags?.[0] ?? this.DEFAULT_LOCALE;
+    generateAlternateLangTags = () => {
+        if (this.languageTags.length < 2) {
+            return '';
+        }
+        const result = `  <locales>\n` +
+            this.languageTags.slice(1).map(tag => `    <locale id="${tag}" />`).join('\n') +
+            `\n  </locales>`;
+        return result;
+    };
+}
+//# sourceMappingURL=ldml-keyboard-generator.js.map

package/build/src/ldml-keyboard-generator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ldml-keyboard-generator.js","sourceRoot":"","sources":["../../src/ldml-keyboard-generator.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAKH,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAEtD;;;;GAIG;AACH,MAAM,OAAO,qBAAsB,SAAQ,cAAc;IAC7C,MAAM,CAAU,cAAc,GAAG,UAAU,CAAC;IACtD,MAAM,CAAU,iBAAiB,GAAG,GAAG,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,cAAc,GAAG,gDAAmC,EAAE,CAAC;IACvH,MAAM,CAAU,aAAa,GAAG,GAAG,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,cAAc,GAAG,2CAA8B,EAAE,CAAC;IAC9G,MAAM,CAAU,aAAa,GAAG,GAAG,IAAI,CAAC,cAAc,GAAG,2CAA8B,EAAE,CAAC;IAE1F;;;;;;OAMG;IACH,KAAK,CAAC,GAAG;QACP,IAAI,CAAC,WAAW,EAAE,CAAC;QAEnB,MAAM,SAAS,GAAuB,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAC9D,IAAI,CAAC,YAAY,GAAG,eAAe,CAAC;QACpC,IAAI,CAAC,WAAW,CAAC,qBAAqB,CAAC,aAAa,CAAC;YACnD,IAAI,CAAC,OAAO,CAAC,EAAE,8CAA+B,CAAC;QACjD,IAAI,CAAC,WAAW,CAAC,qBAAqB,CAAC,iBAAiB,CAAC;YACvD,qBAAqB,CAAC,YAAY,GAAC,IAAI,CAAC,OAAO,CAAC,EAAE,mDAAoC,CAAC;QACzF,IAAI,CAAC,WAAW,CAAC,qBAAqB,CAAC,aAAa,CAAC;YACnD,qBAAqB,CAAC,YAAY,GAAC,IAAI,CAAC,OAAO,CAAC,EAAE,8CAA+B,CAAC;QAEpF,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,oBAAoB,EAAE,CAAC;QACzD,IAAI,CAAC,QAAQ,CAAC,uBAAuB,CAAC,GAAG,IAAI,CAAC,yBAAyB,EAAE,CAAC;QAE1E,IAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;YAC7B,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO,EAAC,SAAS,EAAC,CAAC;IACrB,CAAC;IAEgB,oBAAoB,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,cAAc,CAAC;IAC3E,yBAAyB,GAAG,GAAG,EAAE;QAChD,IAAG,IAAI,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAChC,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,MAAM,MAAM,GACV,eAAe;YACf,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,mBAAmB,GAAG,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;YAC9E,gBAAgB,CAAC;QAEnB,OAAO,MAAM,CAAC;IAChB,CAAC,CAAA"}

package/build/src/lexical-model-generator.d.ts

@@ -0,0 +1,25 @@
+import { KeymanCompiler } from '@keymanapp/developer-utils';
+import { GeneratorResult } from './abstract-generator.js';
+import { BasicGenerator } from './basic-generator.js';
+/**
+ * @public
+ * Generate a Keyman lexical model project. The generator does not read or write
+ * from filesystem or network directly, but relies on callbacks for all external
+ * IO.
+ */
+export declare class LexicalModelGenerator extends BasicGenerator implements KeymanCompiler {
+    static readonly SFile_Model = "model";
+    static readonly SFile_ModelTs: string;
+    static readonly SFile_WordlistTsv: string;
+    static readonly SFile_Project: string;
+    static readonly SFile_Package: string;
+    /**
+     * Generate a Lexical Model project. Returns an object containing binary
+     * artifacts on success. The files are passed in by name, and the compiler
+     * will use callbacks as passed to the {@link AbstractGenerator.init}
+     * function to read any input files by disk.
+     * @returns         Binary artifacts on success, null on failure.
+     */
+    run(): Promise<GeneratorResult>;
+}
+//# sourceMappingURL=lexical-model-generator.d.ts.map

package/build/src/lexical-model-generator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"lexical-model-generator.d.ts","sourceRoot":"","sources":["../../src/lexical-model-generator.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,cAAc,EAA0B,MAAM,4BAA4B,CAAC;AACpF,OAAO,EAAsB,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAC9E,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAGtD;;;;;GAKG;AACH,qBAAa,qBAAsB,SAAQ,cAAe,YAAW,cAAc;IACjF,MAAM,CAAC,QAAQ,CAAC,WAAW,WAAW;IACtC,MAAM,CAAC,QAAQ,CAAC,aAAa,SAAgD;IAC7E,MAAM,CAAC,QAAQ,CAAC,iBAAiB,SAAsC;IACvE,MAAM,CAAC,QAAQ,CAAC,aAAa,SAA0D;IACvF,MAAM,CAAC,QAAQ,CAAC,aAAa,SAA8E;IAE3G;;;;;;OAMG;IACG,GAAG,IAAI,OAAO,CAAC,eAAe,CAAC;CA2BtC"}

package/build/src/lexical-model-generator.js

@@ -0,0 +1,50 @@
+/*
+ * Keyman is copyright (C) SIL International. MIT License.
+ *
+ * Generate a Keyman lexical model project
+ */
+import { SourceFilenamePatterns } from '@keymanapp/developer-utils';
+import { BasicGenerator } from './basic-generator.js';
+import { GeneratorMessages } from './generator-messages.js';
+/**
+ * @public
+ * Generate a Keyman lexical model project. The generator does not read or write
+ * from filesystem or network directly, but relies on callbacks for all external
+ * IO.
+ */
+export class LexicalModelGenerator extends BasicGenerator {
+    static SFile_Model = 'model';
+    static SFile_ModelTs = `${this.SPath_Source}${this.SFile_Model}.ts`;
+    static SFile_WordlistTsv = `${this.SPath_Source}wordlist.tsv`;
+    static SFile_Project = `${this.SFile_Model}${".kpj" /* KeymanFileTypes.Source.Project */}`;
+    static SFile_Package = `${this.SPath_Source}${this.SFile_Model}${".kps" /* KeymanFileTypes.Source.Package */}`;
+    /**
+     * Generate a Lexical Model project. Returns an object containing binary
+     * artifacts on success. The files are passed in by name, and the compiler
+     * will use callbacks as passed to the {@link AbstractGenerator.init}
+     * function to read any input files by disk.
+     * @returns         Binary artifacts on success, null on failure.
+     */
+    async run() {
+        this.preGenerate();
+        const artifacts = this.defaultArtifacts();
+        this.templatePath = 'wordlist-lexical-model';
+        this.filenameMap[LexicalModelGenerator.SFile_Project] =
+            this.options.id + ".kpj" /* KeymanFileTypes.Source.Project */;
+        this.filenameMap[LexicalModelGenerator.SFile_ModelTs] =
+            LexicalModelGenerator.SPath_Source + this.options.id + ".model.ts" /* KeymanFileTypes.Source.Model */;
+        this.filenameMap[LexicalModelGenerator.SFile_WordlistTsv] =
+            LexicalModelGenerator.SFile_WordlistTsv;
+        // Note: lexical models use .model.kps for package extension
+        const packageFilename = this.options.id + '.model' + ".kps" /* KeymanFileTypes.Source.Package */;
+        if (!SourceFilenamePatterns.MODEL_ID_PATTERN_PACKAGE.test(packageFilename)) {
+            this.callbacks.reportMessage(GeneratorMessages.Warn_ModelIdDoesNotFollowLexicalModelConventions({ id: this.options.id }));
+        }
+        this.filenameMap[LexicalModelGenerator.SFile_Package] = LexicalModelGenerator.SPath_Source + packageFilename;
+        if (!this.generate(artifacts)) {
+            return null;
+        }
+        return { artifacts };
+    }
+}
+//# sourceMappingURL=lexical-model-generator.js.map

package/build/src/lexical-model-generator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lexical-model-generator.js","sourceRoot":"","sources":["../../src/lexical-model-generator.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,EAAkB,sBAAsB,EAAE,MAAM,4BAA4B,CAAC;AAEpF,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACtD,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAE5D;;;;;GAKG;AACH,MAAM,OAAO,qBAAsB,SAAQ,cAAc;IACvD,MAAM,CAAU,WAAW,GAAG,OAAO,CAAC;IACtC,MAAM,CAAU,aAAa,GAAG,GAAG,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,WAAW,KAAK,CAAC;IAC7E,MAAM,CAAU,iBAAiB,GAAG,GAAG,IAAI,CAAC,YAAY,cAAc,CAAC;IACvE,MAAM,CAAU,aAAa,GAAG,GAAG,IAAI,CAAC,WAAW,GAAG,2CAA8B,EAAE,CAAC;IACvF,MAAM,CAAU,aAAa,GAAG,GAAG,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,WAAW,GAAG,2CAA8B,EAAE,CAAC;IAE3G;;;;;;OAMG;IACH,KAAK,CAAC,GAAG;QACP,IAAI,CAAC,WAAW,EAAE,CAAC;QAEnB,MAAM,SAAS,GAAuB,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAE9D,IAAI,CAAC,YAAY,GAAG,wBAAwB,CAAC;QAC7C,IAAI,CAAC,WAAW,CAAC,qBAAqB,CAAC,aAAa,CAAC;YACnD,IAAI,CAAC,OAAO,CAAC,EAAE,8CAA+B,CAAC;QACjD,IAAI,CAAC,WAAW,CAAC,qBAAqB,CAAC,aAAa,CAAC;YACnD,qBAAqB,CAAC,YAAY,GAAC,IAAI,CAAC,OAAO,CAAC,EAAE,iDAA6B,CAAC;QAClF,IAAI,CAAC,WAAW,CAAC,qBAAqB,CAAC,iBAAiB,CAAC;YACvD,qBAAqB,CAAC,iBAAiB,CAAC;QAE1C,4DAA4D;QAC5D,MAAM,eAAe,GAAG,IAAI,CAAC,OAAO,CAAC,EAAE,GAAC,QAAQ,8CAA+B,CAAC;QAChF,IAAG,CAAC,sBAAsB,CAAC,wBAAwB,CAAC,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC;YAC1E,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,iBAAiB,CAAC,gDAAgD,CAAC,EAAC,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,EAAE,EAAC,CAAC,CAAC,CAAC;QAC1H,CAAC;QAED,IAAI,CAAC,WAAW,CAAC,qBAAqB,CAAC,aAAa,CAAC,GAAG,qBAAqB,CAAC,YAAY,GAAC,eAAe,CAAC;QAE3G,IAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;YAC7B,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO,EAAC,SAAS,EAAC,CAAC;IACrB,CAAC"}

package/build/src/main.d.ts

@@ -0,0 +1,6 @@
+export { AbstractGenerator, GeneratorOptions } from "./abstract-generator.js";
+export { KeymanKeyboardGenerator } from "./keyman-keyboard-generator.js";
+export { LexicalModelGenerator } from "./lexical-model-generator.js";
+export { LdmlKeyboardGenerator } from "./ldml-keyboard-generator.js";
+export { GeneratorMessages } from "./generator-messages.js";
+//# sourceMappingURL=main.d.ts.map

package/build/src/main.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../../src/main.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC9E,OAAO,EAAE,uBAAuB,EAAE,MAAM,gCAAgC,CAAC;AACzE,OAAO,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AACrE,OAAO,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AACrE,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC"}

package/build/src/main.js

@@ -0,0 +1,10 @@
+/*
+ * Keyman is copyright (C) SIL International. MIT License.
+ */
+/* c8 ignore start */
+export { AbstractGenerator } from "./abstract-generator.js";
+export { KeymanKeyboardGenerator } from "./keyman-keyboard-generator.js";
+export { LexicalModelGenerator } from "./lexical-model-generator.js";
+export { LdmlKeyboardGenerator } from "./ldml-keyboard-generator.js";
+export { GeneratorMessages } from "./generator-messages.js";
+//# sourceMappingURL=main.js.map

package/build/src/main.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"main.js","sourceRoot":"","sources":["../../src/main.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,qBAAqB;AACrB,OAAO,EAAE,iBAAiB,EAAoB,MAAM,yBAAyB,CAAC;AAC9E,OAAO,EAAE,uBAAuB,EAAE,MAAM,gCAAgC,CAAC;AACzE,OAAO,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AACrE,OAAO,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AACrE,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC"}

package/build/src/template/kmn-keyboard/HISTORY.md

@@ -0,0 +1,6 @@
+$NAME Change History
+====================
+
+$VERSION ($DATE)
+----------------
+* Created by $AUTHOR

package/build/src/template/kmn-keyboard/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+$FULLCOPYRIGHT
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/build/src/template/kmn-keyboard/README.md

@@ -0,0 +1,18 @@
+$NAME keyboard
+==============
+
+Description
+-----------
+$DESCRIPTION
+
+Links
+-----
+Keyboard Homepage: https://keyman.com/keyboards/$ID
+
+Copyright
+---------
+See [LICENSE.md](LICENSE.md)
+
+Supported Platforms
+-------------------
+$PLATFORMS_DOTLIST_README

package/build/src/template/kmn-keyboard/keyboard.kpj

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="utf-8"?>
+<KeymanDeveloperProject>
+  <Options>
+    <Version>2.0</Version>
+    <CompilerWarningsAsErrors>True</CompilerWarningsAsErrors>
+    <CheckFilenameConventions>True</CheckFilenameConventions>
+  </Options>
+</KeymanDeveloperProject>