@keymanapp/kmc-generate 18.0.138-alpha

package/build/src/abstract-generator.d.ts

@@ -0,0 +1,167 @@
+import { CompilerCallbacks, CompilerLogLevel, KeymanCompilerArtifact, KeymanCompilerArtifacts, KeymanCompilerResult } from "@keymanapp/developer-utils";
+import { KeymanTargets } from "@keymanapp/common-types";
+/**
+ * @public
+ * Options for the Keyman Developer project generator
+ */
+export interface GeneratorOptions {
+    /**
+     * Reporting level to console, used by NodeCompilerCallbacks (not used in
+     * compiler modules; all messages are still reported to the internal log)
+     */
+    logLevel?: CompilerLogLevel;
+    /**
+     * identifier (basename) of the keyboard or model
+     */
+    id: string;
+    /**
+     * supported platforms, only used in Keyman keyboard project generator
+     */
+    targets?: KeymanTargets.KeymanTarget[];
+    /**
+     * output path where project folder will be created
+     */
+    outPath: string;
+    /**
+     * descriptive name of the keyboard or lexical model
+     */
+    name?: string;
+    /**
+     * name of the copyright holder for the keyboard or lexical model (do not
+     * include (c) symbol or date)
+     */
+    copyright?: string;
+    /**
+     * version of the keyboard or model, 1.0 default for Keyman keyboard, lexical
+     * model, 1.0.0 default for LDML keyboard
+     */
+    version?: string;
+    /**
+     * array of bcp 47 tags which are supported by the keyboard or lexical model
+     */
+    languageTags?: string[];
+    /**
+     * name of the author of the keyboard
+     */
+    author?: string;
+    /**
+     * set to true to generate an icon for a Keyman keyboard with the first
+     * characters of the first specified BCP 47 tag
+     */
+    icon?: boolean;
+    /**
+     * description of the keyboard, Markdown permissible
+     */
+    description?: string;
+    /**
+     * version of Keyman to reference in source files, defaults to KEYMAN_VERSION.VERSION
+     */
+    keymanVersion?: string;
+}
+/**
+ * @public
+ * Internal in-memory build artifacts from a successful generation
+ */
+export interface GeneratorArtifacts extends KeymanCompilerArtifacts {
+    /**
+     * The target path for the generation, equal to the normalized output path.
+     * This folder must not exist before `write()`. This pattern is used to avoid
+     * name collisions with other artifacts
+     */
+    ['kmc-generate:outputPath']: KeymanCompilerArtifact;
+    /**
+     * Generated project files to be written to disk
+     */
+    [name: string]: KeymanCompilerArtifact;
+}
+/**
+ * @public
+ * Result of a successful generation
+ */
+export interface GeneratorResult extends KeymanCompilerResult {
+    /**
+     * Internal in-memory build artifacts from a successful compilation. Caller
+     * can write these to disk with {@link AbstractGenerator.write}
+     */
+    artifacts: GeneratorArtifacts;
+}
+/**
+ * @public
+ * Common functionality for generating projects. Do not instantiate
+ * this class, rather instantiate a subclass
+ */
+export declare class AbstractGenerator {
+    /**
+     * id for the keyboard or model, aka the basename sans extension, foldername
+     * for the project
+     */
+    /**
+     * extension of options.copyright including copyright year
+     */
+    protected fullCopyright: string;
+    /**
+     * identifiers for lines to include when transforming template files, filled
+     * by child classes
+     */
+    protected get includedPrefixes(): string[];
+    private _includedPrefixes;
+    /**
+     * tokens to rewrite in output files
+     */
+    protected get tokenMap(): {
+        [index: string]: string;
+    };
+    private _tokenMap;
+    /**
+     * map of all files to be transformed, filled by this class and subclasses
+     */
+    protected get filenameMap(): {
+        [index: string]: string;
+    };
+    private _filenameMap;
+    /**
+     * base path for template files in this module
+     */
+    protected get templateBasePath(): string;
+    private _templateBasePath;
+    protected static readonly SPath_Source = "source/";
+    protected static readonly SFile_WelcomeHTM: string;
+    protected static readonly SFile_ReadmeHTM: string;
+    protected static readonly SFile_HistoryMD = "HISTORY.md";
+    protected static readonly SFile_LicenseMD = "LICENSE.md";
+    protected static readonly SFile_ReadmeMD = "README.md";
+    protected static readonly SFile_GitIgnore = ".gitignore";
+    protected get callbacks(): CompilerCallbacks;
+    private _callbacks;
+    protected get options(): GeneratorOptions;
+    private _options;
+    /**
+     * Initialize the generator. Copies options.
+     * @param callbacks - Callbacks for external interfaces, including message
+     *                    reporting and file io
+     * @param options   - Generator options
+     * @returns           false if initialization fails
+     */
+    init(callbacks: CompilerCallbacks, options: GeneratorOptions): Promise<boolean>;
+    /**
+     * Write artifacts from a successful compile to disk, via callbacks methods.
+     * The artifacts written will include all files from the project, across
+     * multiple folders. Folders will be created as needed
+     *
+     * @param artifacts - object containing artifact binary data to write out
+     * @returns true on success
+     */
+    write(artifacts: GeneratorArtifacts): Promise<boolean>;
+    /**
+     * Fills in the artifact outputPath used by all generators
+     * @returns
+     */
+    protected defaultArtifacts(): GeneratorArtifacts;
+    /**
+     * @internal
+     */
+    get test_tokenMap(): {
+        [index: string]: string;
+    };
+}
+//# sourceMappingURL=abstract-generator.d.ts.map

package/build/src/abstract-generator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"abstract-generator.d.ts","sourceRoot":"","sources":["../../src/abstract-generator.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,sBAAsB,EAAE,uBAAuB,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAExJ,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAGxD;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,QAAQ,CAAC,EAAE,gBAAgB,CAAC;IAC5B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,OAAO,CAAC,EAAE,aAAa,CAAC,YAAY,EAAE,CAAC;IACvC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IACf;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAmB,SAAQ,uBAAuB;IACjE;;;;OAIG;IACH,CAAC,yBAAyB,CAAC,EAAE,sBAAsB,CAAC;IACpD;;OAEG;IACH,CAAC,IAAI,EAAC,MAAM,GAAG,sBAAsB,CAAC;CACvC;AAED;;;GAGG;AACH,MAAM,WAAW,eAAgB,SAAQ,oBAAoB;IAC3D;;;OAGG;IACH,SAAS,EAAE,kBAAkB,CAAC;CAC/B;AAED;;;;GAIG;AACH,qBAAa,iBAAiB;IAC5B;;;OAGG;IAIH;;OAEG;IACH,SAAS,CAAC,aAAa,EAAE,MAAM,CAAM;IAErC;;;OAGG;IACH,SAAS,KAAK,gBAAgB,aAAqC;IACnE,OAAO,CAAC,iBAAiB,CAAW;IAEpC;;OAEG;IACH,SAAS,KAAK,QAAQ;;MAA6B;IACnD,OAAO,CAAC,SAAS,CAA2B;IAE5C;;OAEG;IACH,SAAS,KAAK,WAAW;;MAAgC;IACzD,OAAO,CAAC,YAAY,CAA2B;IAE/C;;OAEG;IACH,SAAS,KAAK,gBAAgB,WAAqC;IACnE,OAAO,CAAC,iBAAiB,CAAS;IAElC,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,YAAY,aAAa;IACnD,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,gBAAgB,SAAqC;IAC/E,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,eAAe,SAAoC;IAC7E,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,eAAe,gBAAgB;IACzD,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,eAAe,gBAAgB;IACzD,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,cAAc,eAAe;IACvD,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,eAAe,gBAAgB;IAEzD,SAAS,KAAK,SAAS,IAAI,iBAAiB,CAA4B;IACxE,OAAO,CAAC,UAAU,CAAoB;IACtC,SAAS,KAAK,OAAO,IAAI,gBAAgB,CAA0B;IACnE,OAAO,CAAC,QAAQ,CAAmB;IAEnC;;;;;;OAMG;IACU,IAAI,CAAC,SAAS,EAAE,iBAAiB,EAAE,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,OAAO,CAAC;IAwB5F;;;;;;;OAOG;IACU,KAAK,CAAC,SAAS,EAAE,kBAAkB,GAAG,OAAO,CAAC,OAAO,CAAC;IA8BnE;;;OAGG;IACH,SAAS,CAAC,gBAAgB,IAAI,kBAAkB;IAShD;;OAEG;IACH,IAAW,aAAa;;MAA6B;CACtD"}

package/build/src/abstract-generator.js

@@ -0,0 +1,137 @@
+/*
+ * Keyman is copyright (C) SIL International. MIT License.
+ *
+ * Base interfaces and classes for generating Keyman Developer source files
+ */
+import { GeneratorMessages } from './generator-messages.js';
+;
+;
+;
+/**
+ * @public
+ * Common functionality for generating projects. Do not instantiate
+ * this class, rather instantiate a subclass
+ */
+export class AbstractGenerator {
+    /**
+     * id for the keyboard or model, aka the basename sans extension, foldername
+     * for the project
+     */
+    // protected get id() { return this._id }
+    // private _id: string;
+    /**
+     * extension of options.copyright including copyright year
+     */
+    fullCopyright = '';
+    /**
+     * identifiers for lines to include when transforming template files, filled
+     * by child classes
+     */
+    get includedPrefixes() { return this._includedPrefixes; }
+    _includedPrefixes;
+    /**
+     * tokens to rewrite in output files
+     */
+    get tokenMap() { return this._tokenMap; }
+    _tokenMap;
+    /**
+     * map of all files to be transformed, filled by this class and subclasses
+     */
+    get filenameMap() { return this._filenameMap; }
+    _filenameMap;
+    /**
+     * base path for template files in this module
+     */
+    get templateBasePath() { return this._templateBasePath; }
+    _templateBasePath;
+    static SPath_Source = 'source/';
+    static SFile_WelcomeHTM = `${this.SPath_Source}welcome.htm`;
+    static SFile_ReadmeHTM = `${this.SPath_Source}readme.htm`;
+    static SFile_HistoryMD = 'HISTORY.md';
+    static SFile_LicenseMD = 'LICENSE.md';
+    static SFile_ReadmeMD = 'README.md';
+    static SFile_GitIgnore = '.gitignore';
+    get callbacks() { return this._callbacks; }
+    _callbacks;
+    get options() { return this._options; }
+    _options;
+    /**
+     * Initialize the generator. Copies options.
+     * @param callbacks - Callbacks for external interfaces, including message
+     *                    reporting and file io
+     * @param options   - Generator options
+     * @returns           false if initialization fails
+     */
+    async init(callbacks, options) {
+        this._callbacks = callbacks;
+        this._options = { ...options };
+        // this._id = options.id;
+        this._includedPrefixes = [];
+        this._filenameMap = {};
+        this._tokenMap = {};
+        this._templateBasePath = this.callbacks.path.join(this.callbacks.path.dirname(this.callbacks.fileURLToPath(import.meta.url)), 'template');
+        // These files are currently always included, for all project types
+        this.filenameMap[AbstractGenerator.SFile_WelcomeHTM] = AbstractGenerator.SFile_WelcomeHTM;
+        this.filenameMap[AbstractGenerator.SFile_ReadmeHTM] = AbstractGenerator.SFile_ReadmeHTM;
+        this.filenameMap[AbstractGenerator.SFile_HistoryMD] = AbstractGenerator.SFile_HistoryMD;
+        this.filenameMap[AbstractGenerator.SFile_LicenseMD] = AbstractGenerator.SFile_LicenseMD;
+        this.filenameMap[AbstractGenerator.SFile_ReadmeMD] = AbstractGenerator.SFile_ReadmeMD;
+        this.filenameMap[AbstractGenerator.SFile_GitIgnore] = AbstractGenerator.SFile_GitIgnore;
+        return true;
+    }
+    /**
+     * Write artifacts from a successful compile to disk, via callbacks methods.
+     * The artifacts written will include all files from the project, across
+     * multiple folders. Folders will be created as needed
+     *
+     * @param artifacts - object containing artifact binary data to write out
+     * @returns true on success
+     */
+    async write(artifacts) {
+        if (this.callbacks.fs.existsSync(artifacts["kmc-generate:outputPath"].filename)) {
+            this.callbacks.reportMessage(GeneratorMessages.Error_OutputPathAlreadyExists({ outPath: artifacts["kmc-generate:outputPath"].filename }));
+            return false;
+        }
+        for (const key of Object.keys(artifacts)) {
+            const a = artifacts[key];
+            if (key == "kmc-generate:outputPath") {
+                // metadata, skip this
+                continue;
+            }
+            const path = this.callbacks.path.dirname(a.filename);
+            try {
+                this.callbacks.fs.mkdirSync(path, { recursive: true });
+                /* c8 ignore next 4 */
+            }
+            catch (e) {
+                this.callbacks.reportMessage(GeneratorMessages.Error_CannotCreateFolder({ folderName: path, e }));
+                return false;
+            }
+            try {
+                this.callbacks.fs.writeFileSync(a.filename, a.data);
+            }
+            catch (e) {
+                this.callbacks.reportMessage(GeneratorMessages.Error_CannotWriteOutputFile({ filename: a.filename, e }));
+                return false;
+            }
+        }
+        return true;
+    }
+    /**
+     * Fills in the artifact outputPath used by all generators
+     * @returns
+     */
+    defaultArtifacts() {
+        return {
+            "kmc-generate:outputPath": {
+                data: null,
+                filename: this.callbacks.path.join(this.options.outPath, this.options.id)
+            }
+        };
+    }
+    /**
+     * @internal
+     */
+    get test_tokenMap() { return this._tokenMap; }
+}
+//# sourceMappingURL=abstract-generator.js.map

package/build/src/abstract-generator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"abstract-generator.js","sourceRoot":"","sources":["../../src/abstract-generator.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AA6D3D,CAAC;AAiBD,CAAC;AAYD,CAAC;AAEF;;;;GAIG;AACH,MAAM,OAAO,iBAAiB;IAC5B;;;OAGG;IACH,yCAAyC;IACzC,uBAAuB;IAEvB;;OAEG;IACO,aAAa,GAAW,EAAE,CAAC;IAErC;;;OAGG;IACH,IAAc,gBAAgB,KAAK,OAAO,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC;IAC3D,iBAAiB,CAAW;IAEpC;;OAEG;IACH,IAAc,QAAQ,KAAK,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAC3C,SAAS,CAA2B;IAE5C;;OAEG;IACH,IAAc,WAAW,KAAK,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;IACjD,YAAY,CAA2B;IAE/C;;OAEG;IACH,IAAc,gBAAgB,KAAK,OAAO,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC;IAC3D,iBAAiB,CAAS;IAExB,MAAM,CAAU,YAAY,GAAG,SAAS,CAAC;IACzC,MAAM,CAAU,gBAAgB,GAAG,GAAG,IAAI,CAAC,YAAY,aAAa,CAAC;IACrE,MAAM,CAAU,eAAe,GAAG,GAAG,IAAI,CAAC,YAAY,YAAY,CAAC;IACnE,MAAM,CAAU,eAAe,GAAG,YAAY,CAAC;IAC/C,MAAM,CAAU,eAAe,GAAG,YAAY,CAAC;IAC/C,MAAM,CAAU,cAAc,GAAG,WAAW,CAAC;IAC7C,MAAM,CAAU,eAAe,GAAG,YAAY,CAAC;IAEzD,IAAc,SAAS,KAAwB,OAAO,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;IAChE,UAAU,CAAoB;IACtC,IAAc,OAAO,KAAuB,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC3D,QAAQ,CAAmB;IAEnC;;;;;;OAMG;IACI,KAAK,CAAC,IAAI,CAAC,SAA4B,EAAE,OAAyB;QACvE,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,IAAI,CAAC,QAAQ,GAAG,EAAC,GAAG,OAAO,EAAC,CAAC;QAC7B,yBAAyB;QACzB,IAAI,CAAC,iBAAiB,GAAG,EAAE,CAAC;QAC5B,IAAI,CAAC,YAAY,GAAG,EAAE,CAAC;QACvB,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;QAEpB,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAC/C,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAC1E,UAAU,CACX,CAAC;QAEF,mEAAmE;QACnE,IAAI,CAAC,WAAW,CAAC,iBAAiB,CAAC,gBAAgB,CAAC,GAAG,iBAAiB,CAAC,gBAAgB,CAAC;QAC1F,IAAI,CAAC,WAAW,CAAC,iBAAiB,CAAC,eAAe,CAAC,GAAG,iBAAiB,CAAC,eAAe,CAAC;QACxF,IAAI,CAAC,WAAW,CAAC,iBAAiB,CAAC,eAAe,CAAC,GAAG,iBAAiB,CAAC,eAAe,CAAC;QACxF,IAAI,CAAC,WAAW,CAAC,iBAAiB,CAAC,eAAe,CAAC,GAAG,iBAAiB,CAAC,eAAe,CAAC;QACxF,IAAI,CAAC,WAAW,CAAC,iBAAiB,CAAC,cAAc,CAAC,GAAG,iBAAiB,CAAC,cAAc,CAAC;QACtF,IAAI,CAAC,WAAW,CAAC,iBAAiB,CAAC,eAAe,CAAC,GAAG,iBAAiB,CAAC,eAAe,CAAC;QAExF,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,KAAK,CAAC,SAA6B;QAC9C,IAAG,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,yBAAyB,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC/E,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,iBAAiB,CAAC,6BAA6B,CAAC,EAAC,OAAO,EAAE,SAAS,CAAC,yBAAyB,CAAC,CAAC,QAAQ,EAAC,CAAC,CAAC,CAAC;YACxI,OAAO,KAAK,CAAC;QACf,CAAC;QAED,KAAI,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;YACxC,MAAM,CAAC,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC;YACzB,IAAG,GAAG,IAAI,yBAAyB,EAAE,CAAC;gBACpC,sBAAsB;gBACtB,SAAS;YACX,CAAC;YACD,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;YACrD,IAAI,CAAC;gBACH,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,SAAS,CAAC,IAAI,EAAE,EAAC,SAAS,EAAE,IAAI,EAAC,CAAC,CAAC;gBACvD,sBAAsB;YACtB,CAAC;YAAC,OAAM,CAAC,EAAE,CAAC;gBACV,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,iBAAiB,CAAC,wBAAwB,CAAC,EAAC,UAAU,EAAC,IAAI,EAAE,CAAC,EAAC,CAAC,CAAC,CAAC;gBAC/F,OAAO,KAAK,CAAC;YACf,CAAC;YACD,IAAI,CAAC;gBACH,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC;YACtD,CAAC;YAAC,OAAM,CAAC,EAAE,CAAC;gBACV,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,iBAAiB,CAAC,2BAA2B,CAAC,EAAC,QAAQ,EAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,EAAC,CAAC,CAAC,CAAC;gBACtG,OAAO,KAAK,CAAC;YACf,CAAC;QACH,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACO,gBAAgB;QACxB,OAAO;YACL,yBAAyB,EAAE;gBACzB,IAAI,EAAE,IAAI;gBACV,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;aACzE;SACF,CAAA;IACH,CAAC;IAED;;OAEG;IACH,IAAW,aAAa,KAAK,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC"}

package/build/src/basic-generator.d.ts

@@ -0,0 +1,34 @@
+import { KeymanTargets } from "@keymanapp/common-types";
+import { AbstractGenerator, GeneratorArtifacts } from "./abstract-generator.js";
+/**
+ * @internal
+ * Common functionality for generating projects. Do not instantiate
+ * this class, rather instantiate a subclass
+ */
+export declare class BasicGenerator extends AbstractGenerator {
+    protected readonly DEFAULT_LOCALE = "en";
+    protected templatePath: string;
+    protected languageTags: string[];
+    protected resolvedTargets: KeymanTargets.KeymanTarget[];
+    protected preGenerate(): void;
+    protected generate(artifacts: GeneratorArtifacts): boolean;
+    private getLanguageName;
+    private generateLanguageListForPackage;
+    private getPlatformDotListForReadme;
+    private readonly transformAll;
+    private transform;
+    /**
+     * @internal
+     * these are exported only for unit tests, do not use
+     */
+    readonly test_templatePath: () => string;
+    readonly test_languageTags: () => string[];
+    readonly test_preGenerate: () => void;
+    readonly test_generate: (artifacts: GeneratorArtifacts) => boolean;
+    readonly test_getLanguageName: (tag: string) => string;
+    readonly test_generateLanguageListForPackage: () => string;
+    readonly test_getPlatformDotListForReadme: () => string;
+    readonly test_transformAll: (artifacts: GeneratorArtifacts) => boolean;
+    readonly test_transform: (sourceFile: string, destFile: string, artifacts: GeneratorArtifacts) => boolean;
+}
+//# sourceMappingURL=basic-generator.d.ts.map

package/build/src/basic-generator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"basic-generator.d.ts","sourceRoot":"","sources":["../../src/basic-generator.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAExD,OAAO,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAEhF;;;;GAIG;AACH,qBAAa,cAAe,SAAQ,iBAAiB;IAGnD,SAAS,CAAC,QAAQ,CAAC,cAAc,QAAQ;IAEzC,SAAS,CAAC,YAAY,EAAE,MAAM,CAAC;IAC/B,SAAS,CAAC,YAAY,EAAE,MAAM,EAAE,CAAC;IACjC,SAAS,CAAC,eAAe,EAAE,aAAa,CAAC,YAAY,EAAE,CAAC;IAExD,SAAS,CAAC,WAAW;IA8BrB,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,kBAAkB,GAAG,OAAO;IAI1D,OAAO,CAAC,eAAe;IAKvB,OAAO,CAAC,8BAA8B;IAWtC,OAAO,CAAC,2BAA2B;IAQnC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAE0C;IAEvE,OAAO,CAAC,SAAS;IAsCjB;;;OAGG;IACH,SAAgB,iBAAiB,eAA2B;IAC5D,SAAgB,iBAAiB,iBAA2B;IAE5D,SAAgB,gBAAgB,aAA4B;IAC5D,SAAgB,aAAa,cAAe,kBAAkB,aAA8B;IAC5F,SAAgB,oBAAoB,QAAS,MAAM,YAAgC;IACnF,SAAgB,mCAAmC,eAA+C;IAClG,SAAgB,gCAAgC,eAA4C;IAC5F,SAAgB,iBAAiB,cAAe,kBAAkB,aAAkC;IACpG,SAAgB,cAAc,eAAgB,MAAM,YAAY,MAAM,aAAa,kBAAkB,aACnD;CACnD"}

package/build/src/basic-generator.js

@@ -0,0 +1,119 @@
+/*
+ * Keyman is copyright (C) SIL International. MIT License.
+ *
+ * Basic generator -- common file generation functionality
+ */
+import { KeymanTargets } from "@keymanapp/common-types";
+import KEYMAN_VERSION from "@keymanapp/keyman-version";
+import { AbstractGenerator } from "./abstract-generator.js";
+/**
+ * @internal
+ * Common functionality for generating projects. Do not instantiate
+ * this class, rather instantiate a subclass
+ */
+export class BasicGenerator extends AbstractGenerator {
+    // We'll generate a keyboard with a default 'en' locale if none is passed in
+    DEFAULT_LOCALE = 'en';
+    templatePath;
+    languageTags;
+    resolvedTargets;
+    preGenerate() {
+        const dt = new Date();
+        this.languageTags = this.options.languageTags.length
+            ? this.options.languageTags.map(tag => new Intl.Locale(tag).minimize().toString())
+            : [this.DEFAULT_LOCALE];
+        //TODO-GENERATE: validate targets
+        if (this.options.targets.includes(KeymanTargets.KeymanTarget.any) || this.options.targets.length == 0) {
+            this.resolvedTargets = KeymanTargets.AllKeymanTargets.filter(target => target != KeymanTargets.KeymanTarget.any);
+        }
+        else {
+            this.resolvedTargets = [].concat(this.options.targets);
+        }
+        this.tokenMap['$NAME'] = this.options.name;
+        this.tokenMap['$ID'] = this.options.id;
+        this.tokenMap['$KEYMANVERSION'] = (this.options.keymanVersion || KEYMAN_VERSION.VERSION) + '.0';
+        this.tokenMap['$VERSION'] = this.options.version;
+        this.tokenMap['$COPYRIGHT'] = '© ' + this.options.copyright;
+        this.tokenMap['$FULLCOPYRIGHT'] = '© ' + dt.getFullYear().toString() + ' ' + this.options.copyright;
+        this.tokenMap['$AUTHOR'] = this.options.author || '';
+        this.tokenMap['$TARGETS'] = this.resolvedTargets.join(' ');
+        this.tokenMap['$DESCRIPTION'] = this.options.description || this.options.name;
+        this.tokenMap['$DATE'] =
+            dt.getFullYear().toString() + '-' +
+                (dt.getMonth() + 1).toString().padStart(2, '0') + '-' +
+                dt.getDate().toString().padStart(2, '0');
+        this.tokenMap['$PACKAGE_LANGUAGES'] = this.generateLanguageListForPackage();
+        this.tokenMap['$PLATFORMS_DOTLIST_README'] = this.getPlatformDotListForReadme();
+    }
+    generate(artifacts) {
+        return this.transformAll(artifacts);
+    }
+    getLanguageName(tag) {
+        // TODO-GENERATE: probably need to use langtags.json
+        return new Intl.Locale(tag).language;
+    }
+    generateLanguageListForPackage() {
+        // <Languages>
+        //   <Language ID="km">Central Khmer (Khmer, Cambodia)</Language>
+        // </Languages>
+        const result = `      <Languages>\n` +
+            this.languageTags.map(tag => `        <Language ID="${tag}">${this.getLanguageName(tag)}</Language>`).join('\n') +
+            `\n      </Languages>`;
+        return result;
+    }
+    getPlatformDotListForReadme() {
+        const result = KeymanTargets.AllKeymanTargets
+            .filter(target => this.resolvedTargets.includes(target))
+            .map(target => ` * ${KeymanTargets.SKeymanTargetNames[target]}`)
+            .join('\n');
+        return result;
+    }
+    transformAll = (artifacts) => Object
+        .keys(this.filenameMap)
+        .every(src => this.transform(src, this.filenameMap[src], artifacts));
+    transform(sourceFile, destFile, artifacts) {
+        destFile = this.callbacks.path.join(this.options.outPath, this.options.id, destFile == '' ? sourceFile : destFile);
+        sourceFile = this.callbacks.path.join(this.templateBasePath, this.templatePath, sourceFile);
+        const sourceData = this.callbacks.loadFile(sourceFile);
+        if (sourceData == null) {
+            // internal error -- source file should be readable
+            throw new Error(`source file ${sourceFile} does not exist`);
+        }
+        const template = new TextDecoder('utf-8').decode(sourceData).replace(/\r/g, '').split('\n');
+        const source = [];
+        // Filter out unused lines
+        for (const line of template) {
+            if (!line.match(/\$[A-Z0-9_-]+:/i)) {
+                source.push(line);
+            }
+            else {
+                const tokens = line.split(':', 2);
+                if (this.includedPrefixes.includes(tokens[0].substring(1))) {
+                    source.push(tokens[1]);
+                }
+            }
+        }
+        // Replace all tokens
+        let dest = source.join('\n');
+        Object.keys(this.tokenMap).forEach(token => dest = dest.replaceAll(token, this.tokenMap[token]));
+        artifacts[destFile] = {
+            filename: destFile,
+            data: new TextEncoder().encode(dest)
+        };
+        return true;
+    }
+    /**
+     * @internal
+     * these are exported only for unit tests, do not use
+     */
+    test_templatePath = () => this.templatePath;
+    test_languageTags = () => this.languageTags;
+    test_preGenerate = () => this.preGenerate();
+    test_generate = (artifacts) => this.generate(artifacts);
+    test_getLanguageName = (tag) => this.getLanguageName(tag);
+    test_generateLanguageListForPackage = () => this.generateLanguageListForPackage();
+    test_getPlatformDotListForReadme = () => this.getPlatformDotListForReadme();
+    test_transformAll = (artifacts) => this.transformAll(artifacts);
+    test_transform = (sourceFile, destFile, artifacts) => this.transform(sourceFile, destFile, artifacts);
+}
+//# sourceMappingURL=basic-generator.js.map

package/build/src/basic-generator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"basic-generator.js","sourceRoot":"","sources":["../../src/basic-generator.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,cAAc,MAAM,2BAA2B,CAAC;AACvD,OAAO,EAAE,iBAAiB,EAAsB,MAAM,yBAAyB,CAAC;AAEhF;;;;GAIG;AACH,MAAM,OAAO,cAAe,SAAQ,iBAAiB;IAEnD,4EAA4E;IACzD,cAAc,GAAG,IAAI,CAAC;IAE/B,YAAY,CAAS;IACrB,YAAY,CAAW;IACvB,eAAe,CAA+B;IAE9C,WAAW;QACnB,MAAM,EAAE,GAAG,IAAI,IAAI,EAAE,CAAC;QAEtB,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,MAAM;YAClD,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,CAAC;YAClF,CAAC,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAC1B,iCAAiC;QACjC,IAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;YACrG,IAAI,CAAC,eAAe,GAAG,aAAa,CAAC,gBAAgB,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,IAAI,aAAa,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;QACnH,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,eAAe,GAAG,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACzD,CAAC;QAED,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;QAC3C,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;QACvC,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,IAAI,cAAc,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC;QAChG,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;QACjD,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,GAAG,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC;QAC5D,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CAAC,GAAG,IAAI,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC,QAAQ,EAAE,GAAG,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC;QACpG,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,IAAI,EAAE,CAAC;QACrD,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC3D,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;QAC9E,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC;YACpB,EAAE,CAAC,WAAW,EAAE,CAAC,QAAQ,EAAE,GAAG,GAAG;gBACjC,CAAC,EAAE,CAAC,QAAQ,EAAE,GAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,GAAG,GAAG;gBACnD,EAAE,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;QAC3C,IAAI,CAAC,QAAQ,CAAC,oBAAoB,CAAC,GAAG,IAAI,CAAC,8BAA8B,EAAE,CAAC;QAC5E,IAAI,CAAC,QAAQ,CAAC,2BAA2B,CAAC,GAAG,IAAI,CAAC,2BAA2B,EAAE,CAAC;IAClF,CAAC;IAES,QAAQ,CAAC,SAA6B;QAC9C,OAAO,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;IACtC,CAAC;IAEO,eAAe,CAAC,GAAW;QACjC,oDAAoD;QACpD,OAAO,IAAI,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC;IACvC,CAAC;IAEO,8BAA8B;QACpC,cAAc;QACd,iEAAiE;QACjE,eAAe;QACf,MAAM,MAAM,GACV,qBAAqB;YACrB,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,yBAAyB,GAAG,KAAK,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;YAChH,sBAAsB,CAAC;QACzB,OAAO,MAAM,CAAC;IAChB,CAAC;IAEO,2BAA2B;QACjC,MAAM,MAAM,GAAG,aAAa,CAAC,gBAAgB;aAC1C,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;aACvD,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,aAAa,CAAC,kBAAkB,CAAC,MAAM,CAAC,EAAE,CAAC;aAC/D,IAAI,CAAC,IAAI,CAAC,CAAC;QACd,OAAO,MAAM,CAAC;IAChB,CAAC;IAEgB,YAAY,GAAG,CAAC,SAA6B,EAAE,EAAE,CAAC,MAAM;SACtE,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC;SACtB,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC;IAE/D,SAAS,CAAC,UAAkB,EAAE,QAAgB,EAAE,SAA6B;QACnF,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,QAAQ,IAAI,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;QACnH,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,IAAI,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;QAE5F,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;QACvD,IAAG,UAAU,IAAI,IAAI,EAAE,CAAC;YACtB,mDAAmD;YACnD,MAAM,IAAI,KAAK,CAAC,eAAe,UAAU,iBAAiB,CAAC,CAAC;QAC9D,CAAC;QACD,MAAM,QAAQ,GAAG,IAAI,WAAW,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAE5F,MAAM,MAAM,GAAa,EAAE,CAAC;QAE5B,0BAA0B;QAE1B,KAAI,MAAM,IAAI,IAAI,QAAQ,EAAE,CAAC;YAC3B,IAAG,CAAC,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,EAAE,CAAC;gBAClC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACpB,CAAC;iBAAM,CAAC;gBACN,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;gBAClC,IAAG,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;oBAC1D,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;gBACzB,CAAC;YACH,CAAC;QACH,CAAC;QAED,qBAAqB;QACrB,IAAI,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC7B,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAEjG,SAAS,CAAC,QAAQ,CAAC,GAAG;YACpB,QAAQ,EAAE,QAAQ;YAClB,IAAI,EAAE,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC;SACrC,CAAC;QAEF,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACa,iBAAiB,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC;IAC5C,iBAAiB,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC;IAE5C,gBAAgB,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;IAC5C,aAAa,GAAG,CAAC,SAA6B,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;IAC5E,oBAAoB,GAAG,CAAC,GAAW,EAAG,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;IACnE,mCAAmC,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,8BAA8B,EAAE,CAAC;IAClF,gCAAgC,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,2BAA2B,EAAE,CAAC;IAC5E,iBAAiB,GAAG,CAAC,SAA6B,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;IACpF,cAAc,GAAG,CAAC,UAAkB,EAAE,QAAgB,EAAE,SAA6B,EAAE,EAAE,CACvG,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;CACnD"}

package/build/src/generator-messages.d.ts

@@ -0,0 +1,33 @@
+/**
+ * @internal
+ */
+export declare class GeneratorMessages {
+    static Fatal_UnexpectedException: (o: {
+        e: any;
+    }) => import("@keymanapp/developer-utils").CompilerEvent;
+    static FATAL_UnexpectedException: number;
+    static Info_GeneratingProject: (o: {
+        type: string;
+        id: string;
+    }) => import("@keymanapp/developer-utils").CompilerEvent;
+    static INFO_GeneratingProject: number;
+    static ERROR_CannotCreateFolder: number;
+    static Error_CannotCreateFolder: (o: {
+        folderName: string;
+        e: any;
+    }) => import("@keymanapp/developer-utils").CompilerEvent;
+    static ERROR_OutputPathAlreadyExists: number;
+    static Error_OutputPathAlreadyExists: (o: {
+        outPath: string;
+    }) => import("@keymanapp/developer-utils").CompilerEvent;
+    static ERROR_CannotWriteOutputFile: number;
+    static Error_CannotWriteOutputFile: (o: {
+        filename: string;
+        e: any;
+    }) => import("@keymanapp/developer-utils").CompilerEvent;
+    static WARN_ModelIdDoesNotFollowLexicalModelConventions: number;
+    static Warn_ModelIdDoesNotFollowLexicalModelConventions: (o: {
+        id: string;
+    }) => import("@keymanapp/developer-utils").CompilerEvent;
+}
+//# sourceMappingURL=generator-messages.d.ts.map

package/build/src/generator-messages.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generator-messages.d.ts","sourceRoot":"","sources":["../../src/generator-messages.ts"],"names":[],"mappings":"AAeA;;GAEG;AACH,qBAAa,iBAAiB;IAC5B,MAAM,CAAC,yBAAyB,MAAM;QAAC,CAAC,EAAE,GAAG,CAAA;KAAC,wDAAqE;IACnH,MAAM,CAAC,yBAAyB,SAAqB;IAErD,MAAM,CAAC,sBAAsB,MAAM;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,EAAE,EAAE,MAAM,CAAA;KAAC,wDACO;IACpE,MAAM,CAAC,sBAAsB,SAAoB;IAEjD,MAAM,CAAC,wBAAwB,SAAqB;IACpD,MAAM,CAAC,wBAAwB,MAAM;QAAC,UAAU,EAAC,MAAM,CAAC;QAAC,CAAC,EAAE,GAAG,CAAA;KAAC,wDACa;IAE7E,MAAM,CAAC,6BAA6B,SAAqB;IACzD,MAAM,CAAC,6BAA6B,MAAM;QAAC,OAAO,EAAC,MAAM,CAAA;KAAC,wDAES;IAEnE,MAAM,CAAC,2BAA2B,SAAqB;IACvD,MAAM,CAAC,2BAA2B,MAAM;QAAC,QAAQ,EAAC,MAAM,CAAC;QAAC,CAAC,EAAE,GAAG,CAAA;KAAC,wDACO;IAGxE,MAAM,CAAC,gDAAgD,SAAoB;IAC3E,MAAM,CAAC,gDAAgD,MAAM;QAAC,EAAE,EAAE,MAAM,CAAA;KAAC,wDAG5C;CAC9B"}

package/build/src/generator-messages.js

@@ -0,0 +1,34 @@
+/*
+ * Keyman is copyright (C) SIL International. MIT License.
+ *
+ * Messages for kmc-generate
+ */
+import { CompilerErrorNamespace, CompilerErrorSeverity, CompilerMessageSpec as m, CompilerMessageDef as def, CompilerMessageSpecWithException } from "@keymanapp/developer-utils";
+const Namespace = CompilerErrorNamespace.Generator;
+const SevInfo = CompilerErrorSeverity.Info | Namespace;
+// const SevHint = CompilerErrorSeverity.Hint | Namespace;
+const SevWarn = CompilerErrorSeverity.Warn | Namespace;
+const SevError = CompilerErrorSeverity.Error | Namespace;
+const SevFatal = CompilerErrorSeverity.Fatal | Namespace;
+/**
+ * @internal
+ */
+export class GeneratorMessages {
+    static Fatal_UnexpectedException = (o) => m(this.FATAL_UnexpectedException, null, o.e ?? 'unknown error');
+    static FATAL_UnexpectedException = SevFatal | 0x0001;
+    static Info_GeneratingProject = (o) => m(this.INFO_GeneratingProject, `Generating project of type ${def(o.type)} with id ${def(o.id)}`);
+    static INFO_GeneratingProject = SevInfo | 0x0002;
+    static ERROR_CannotCreateFolder = SevError | 0x0003;
+    static Error_CannotCreateFolder = (o) => CompilerMessageSpecWithException(this.ERROR_CannotCreateFolder, null, `Unable to create folder ${def(o.folderName)}: ${o.e ?? 'unknown error'}`);
+    static ERROR_OutputPathAlreadyExists = SevError | 0x0004;
+    static Error_OutputPathAlreadyExists = (o) => m(this.ERROR_OutputPathAlreadyExists, `Output path ${def(o.outPath)} already exists, not overwriting`);
+    static ERROR_CannotWriteOutputFile = SevError | 0x0005;
+    static Error_CannotWriteOutputFile = (o) => CompilerMessageSpecWithException(this.ERROR_CannotWriteOutputFile, null, `Unable to write file ${def(o.filename)}: ${o.e ?? 'unknown error'}`);
+    // See also PackageCompilerMessages.WARN_PackageNameDoesNotFollowLexicalModelConventions
+    static WARN_ModelIdDoesNotFollowLexicalModelConventions = SevWarn | 0x0006;
+    static Warn_ModelIdDoesNotFollowLexicalModelConventions = (o) => m(this.WARN_ModelIdDoesNotFollowLexicalModelConventions, `The id ${def(o.id)} does not follow the recommended model id conventions. The id should be all lower case, ` +
+        `include only alphanumeric characters and underscore (_), not start with a digit, and should have the structure ` +
+        `<author>.<bcp47>.<uniq>`);
+}
+;
+//# sourceMappingURL=generator-messages.js.map

package/build/src/generator-messages.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generator-messages.js","sourceRoot":"","sources":["../../src/generator-messages.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,sBAAsB,EAAE,qBAAqB,EAAE,mBAAmB,IAAI,CAAC,EAAE,kBAAkB,IAAI,GAAG,EAAE,gCAAgC,EAAE,MAAM,4BAA4B,CAAC;AAElL,MAAM,SAAS,GAAG,sBAAsB,CAAC,SAAS,CAAC;AACnD,MAAM,OAAO,GAAG,qBAAqB,CAAC,IAAI,GAAG,SAAS,CAAC;AACvD,0DAA0D;AAC1D,MAAM,OAAO,GAAG,qBAAqB,CAAC,IAAI,GAAG,SAAS,CAAC;AACvD,MAAM,QAAQ,GAAG,qBAAqB,CAAC,KAAK,GAAG,SAAS,CAAC;AACzD,MAAM,QAAQ,GAAG,qBAAqB,CAAC,KAAK,GAAG,SAAS,CAAC;AAEzD;;GAEG;AACH,MAAM,OAAO,iBAAiB;IAC5B,MAAM,CAAC,yBAAyB,GAAG,CAAC,CAAU,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,yBAAyB,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,eAAe,CAAC,CAAC;IACnH,MAAM,CAAC,yBAAyB,GAAG,QAAQ,GAAG,MAAM,CAAC;IAErD,MAAM,CAAC,sBAAsB,GAAG,CAAC,CAA4B,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,sBAAsB,EAC7F,8BAA8B,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IACpE,MAAM,CAAC,sBAAsB,GAAG,OAAO,GAAG,MAAM,CAAC;IAEjD,MAAM,CAAC,wBAAwB,GAAG,QAAQ,GAAG,MAAM,CAAC;IACpD,MAAM,CAAC,wBAAwB,GAAG,CAAC,CAA6B,EAAE,EAAE,CAAC,gCAAgC,CAAC,IAAI,CAAC,wBAAwB,EAAE,IAAI,EACvI,2BAA2B,GAAG,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,eAAe,EAAE,CAAC,CAAC;IAE7E,MAAM,CAAC,6BAA6B,GAAG,QAAQ,GAAG,MAAM,CAAC;IACzD,MAAM,CAAC,6BAA6B,GAAG,CAAC,CAAkB,EAAE,EAAE,CAAC,CAAC,CAC9D,IAAI,CAAC,6BAA6B,EAClC,eAAe,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,kCAAkC,CAAC,CAAC;IAEnE,MAAM,CAAC,2BAA2B,GAAG,QAAQ,GAAG,MAAM,CAAC;IACvD,MAAM,CAAC,2BAA2B,GAAG,CAAC,CAA2B,EAAE,EAAE,CAAC,gCAAgC,CAAC,IAAI,CAAC,2BAA2B,EAAE,IAAI,EAC3I,wBAAwB,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,eAAe,EAAE,CAAC,CAAC;IAExE,wFAAwF;IACxF,MAAM,CAAC,gDAAgD,GAAG,OAAO,GAAG,MAAM,CAAC;IAC3E,MAAM,CAAC,gDAAgD,GAAG,CAAC,CAAc,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,gDAAgD,EACnI,UAAU,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,0FAA0F;QAC7G,iHAAiH;QACjH,yBAAyB,CAAC,CAAC;;AAC9B,CAAC"}

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

@@ -0,0 +1,32 @@
+import { KeymanCompiler } from '@keymanapp/developer-utils';
+import { GeneratorResult } from './abstract-generator.js';
+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 declare class KeymanKeyboardGenerator extends BasicGenerator implements KeymanCompiler {
+    static readonly SFile_Keyboard = "keyboard";
+    static readonly SFile_KeyboardKMN: string;
+    static readonly SFile_KeyboardKPS: string;
+    static readonly SFile_KeyboardKVKS: string;
+    static readonly SFile_TouchLayout: string;
+    static readonly SFile_Project: string;
+    /**
+     * 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.
+     */
+    run(): Promise<GeneratorResult>;
+    private readonly targetIncludes;
+    private readonly hasKVKS;
+    private readonly hasWeb;
+    private readonly hasKMX;
+    private readonly hasTouchLayout;
+    private readonly hasIcon;
+    private writeIcon;
+}
+//# sourceMappingURL=keyman-keyboard-generator.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"keyman-keyboard-generator.d.ts","sourceRoot":"","sources":["../../src/keyman-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,uBAAwB,SAAQ,cAAe,YAAW,cAAc;IAUnF,MAAM,CAAC,QAAQ,CAAC,cAAc,cAAc;IAC5C,MAAM,CAAC,QAAQ,CAAC,iBAAiB,SAAwF;IACzH,MAAM,CAAC,QAAQ,CAAC,iBAAiB,SAAiF;IAClH,MAAM,CAAC,QAAQ,CAAC,kBAAkB,SAAwF;IAC1H,MAAM,CAAC,QAAQ,CAAC,iBAAiB,SAAqF;IACtH,MAAM,CAAC,QAAQ,CAAC,aAAa,SAA6D;IAE1F;;;;;;OAMG;IACG,GAAG,IAAI,OAAO,CAAC,eAAe,CAAC;IAmDrC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAE9B;IAED,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAyE;IACjG,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqE;IAC5F,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqE;IAC5F,OAAO,CAAC,QAAQ,CAAC,cAAc,CAA+D;IAI9F,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAe;IAEvC,OAAO,CAAC,SAAS;CAKlB"}