Merge pull request #1695 from keymanapp/auto/developer-help-18.0.138-…

…alpha/TC-18.0.138

auto: Keyman for developer help deployment

developer/18.0/guides/test/keyboard-touch-and-desktop.md

@@ -70,9 +70,7 @@ able to select your keyboard from the list and start using it.
 To start testing on your mobile device, your device needs to be on the
 same network as your PC. Then open your web browser on the device. Which
 browser? On iOS, use Safari.  On Android devices, we recommend using
-Chrome. We don't recommend the Android Browser, because its capabilities
-vary dramatically depending on the Android version and the brand of your
-device.
+Chrome.
 
 Then you will need to pick an address from the debug host list in Keyman
 Developer that your device can find. An IP address on the same network

developer/18.0/reference/api/index.md

@@ -9,6 +9,8 @@
 |  Package | Description |
 |  --- | --- |
 |  [@keymanapp/kmc-analyze](./kmc-analyze.md) | kmc-analyze - keyboard analysis classes, including tools for <code>&amp;displayMap</code>. |
+|  [@keymanapp/kmc-copy](./kmc-copy.md) |  |
+|  [@keymanapp/kmc-generate](./kmc-generate.md) |  |
 |  [@keymanapp/kmc-keyboard-info](./kmc-keyboard-info.md) |  |
 |  [@keymanapp/kmc-kmn](./kmc-kmn.md) | kmc-kmn - Keyman keyboard compiler |
 |  [@keymanapp/kmc-ldml](./kmc-ldml.md) |  |

developer/18.0/reference/api/kmc-copy.copieroptions.dryrun.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@keymanapp/kmc-copy](./kmc-copy.md) &gt; [CopierOptions](./kmc-copy.copieroptions.md) &gt; [dryRun](./kmc-copy.copieroptions.dryrun.md)
+
+## CopierOptions.dryRun property
+
+dryRun: show what would happen
+
+**Signature:**
+
+```typescript
+dryRun: boolean;
+```

developer/18.0/reference/api/kmc-copy.copieroptions.loglevel.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@keymanapp/kmc-copy](./kmc-copy.md) &gt; [CopierOptions](./kmc-copy.copieroptions.md) &gt; [logLevel](./kmc-copy.copieroptions.loglevel.md)
+
+## CopierOptions.logLevel property
+
+Reporting level to console, used by NodeCompilerCallbacks (not used in compiler modules; all messages are still reported to the internal log)
+
+**Signature:**
+
+```typescript
+logLevel?: CompilerLogLevel;
+```

developer/18.0/reference/api/kmc-copy.copieroptions.md

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@keymanapp/kmc-copy](./kmc-copy.md) &gt; [CopierOptions](./kmc-copy.copieroptions.md)
+
+## CopierOptions interface
+
+Options for the Keyman Developer project copier
+
+**Signature:**
+
+```typescript
+export interface CopierOptions 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [dryRun](./kmc-copy.copieroptions.dryrun.md) |  | boolean | dryRun: show what would happen |
+|  [logLevel?](./kmc-copy.copieroptions.loglevel.md) |  | CompilerLogLevel | _(Optional)_ Reporting level to console, used by NodeCompilerCallbacks (not used in compiler modules; all messages are still reported to the internal log) |
+|  [outPath](./kmc-copy.copieroptions.outpath.md) |  | string | output path where project folder will be created |
+

developer/18.0/reference/api/kmc-copy.copieroptions.outpath.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@keymanapp/kmc-copy](./kmc-copy.md) &gt; [CopierOptions](./kmc-copy.copieroptions.md) &gt; [outPath](./kmc-copy.copieroptions.outpath.md)
+
+## CopierOptions.outPath property
+
+output path where project folder will be created
+
+**Signature:**
+
+```typescript
+outPath: string;
+```

developer/18.0/reference/api/kmc-copy.keymanprojectcopier.asynccallbacks.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@keymanapp/kmc-copy](./kmc-copy.md) &gt; [KeymanProjectCopier](./kmc-copy.keymanprojectcopier.md) &gt; [asyncCallbacks](./kmc-copy.keymanprojectcopier.asynccallbacks.md)
+
+## KeymanProjectCopier.asyncCallbacks property
+
+**Signature:**
+
+```typescript
+asyncCallbacks: CopierAsyncCallbacks;
+```

developer/18.0/reference/api/kmc-copy.keymanprojectcopier.callbacks.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@keymanapp/kmc-copy](./kmc-copy.md) &gt; [KeymanProjectCopier](./kmc-copy.keymanprojectcopier.md) &gt; [callbacks](./kmc-copy.keymanprojectcopier.callbacks.md)
+
+## KeymanProjectCopier.callbacks property
+
+**Signature:**
+
+```typescript
+callbacks: CompilerCallbacks;
+```

developer/18.0/reference/api/kmc-copy.keymanprojectcopier.cloudsource.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@keymanapp/kmc-copy](./kmc-copy.md) &gt; [KeymanProjectCopier](./kmc-copy.keymanprojectcopier.md) &gt; [cloudSource](./kmc-copy.keymanprojectcopier.cloudsource.md)
+
+## KeymanProjectCopier.cloudSource property
+
+**Signature:**
+
+```typescript
+cloudSource: KeymanCloudSource;
+```

developer/18.0/reference/api/kmc-copy.keymanprojectcopier.githubref.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@keymanapp/kmc-copy](./kmc-copy.md) &gt; [KeymanProjectCopier](./kmc-copy.keymanprojectcopier.md) &gt; [githubRef](./kmc-copy.keymanprojectcopier.githubref.md)
+
+## KeymanProjectCopier.githubRef property
+
+**Signature:**
+
+```typescript
+githubRef: GitHubRef;
+```

developer/18.0/reference/api/kmc-copy.keymanprojectcopier.init.md

@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@keymanapp/kmc-copy](./kmc-copy.md) &gt; [KeymanProjectCopier](./kmc-copy.keymanprojectcopier.md) &gt; [init](./kmc-copy.keymanprojectcopier.init.md)
+
+## KeymanProjectCopier.init() method
+
+**Signature:**
+
+```typescript
+init(callbacks: CompilerCallbacks, options: CopierOptions): Promise<boolean>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  callbacks | CompilerCallbacks |  |
+|  options | [CopierOptions](./kmc-copy.copieroptions.md) |  |
+
+**Returns:**
+
+Promise&lt;boolean&gt;
+

developer/18.0/reference/api/kmc-copy.keymanprojectcopier.islocalorigin.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@keymanapp/kmc-copy](./kmc-copy.md) &gt; [KeymanProjectCopier](./kmc-copy.keymanprojectcopier.md) &gt; [isLocalOrigin](./kmc-copy.keymanprojectcopier.islocalorigin.md)
+
+## KeymanProjectCopier.isLocalOrigin() method
+
+**Signature:**
+
+```typescript
+isLocalOrigin(): boolean;
+```
+**Returns:**
+
+boolean
+

developer/18.0/reference/api/kmc-copy.keymanprojectcopier.md

@@ -0,0 +1,36 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@keymanapp/kmc-copy](./kmc-copy.md) &gt; [KeymanProjectCopier](./kmc-copy.keymanprojectcopier.md)
+
+## KeymanProjectCopier class
+
+**Signature:**
+
+```typescript
+export declare class KeymanProjectCopier implements KeymanCompiler 
+```
+**Implements:** KeymanCompiler
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [asyncCallbacks](./kmc-copy.keymanprojectcopier.asynccallbacks.md) |  | CopierAsyncCallbacks |  |
+|  [callbacks](./kmc-copy.keymanprojectcopier.callbacks.md) |  | CompilerCallbacks |  |
+|  [cloudSource](./kmc-copy.keymanprojectcopier.cloudsource.md) |  | KeymanCloudSource |  |
+|  [githubRef](./kmc-copy.keymanprojectcopier.githubref.md) |  | GitHubRef |  |
+|  [options](./kmc-copy.keymanprojectcopier.options.md) |  | [CopierOptions](./kmc-copy.copieroptions.md) |  |
+|  [outPath](./kmc-copy.keymanprojectcopier.outpath.md) |  | string |  |
+|  [outputId](./kmc-copy.keymanprojectcopier.outputid.md) |  | string |  |
+|  [relocateExternalFiles](./kmc-copy.keymanprojectcopier.relocateexternalfiles.md) |  | boolean |  |
+|  [sourceId](./kmc-copy.keymanprojectcopier.sourceid.md) |  | string |  |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [init(callbacks, options)](./kmc-copy.keymanprojectcopier.init.md) |  |  |
+|  [isLocalOrigin()](./kmc-copy.keymanprojectcopier.islocalorigin.md) |  |  |
+|  [run(source)](./kmc-copy.keymanprojectcopier.run.md) |  | Copy a Keyman 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 [KeymanProjectCopier.init()](./kmc-copy.keymanprojectcopier.init.md) function to read any input files by disk. |
+|  [write(artifacts)](./kmc-copy.keymanprojectcopier.write.md) |  | 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 |
+

developer/18.0/reference/api/kmc-copy.keymanprojectcopier.options.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@keymanapp/kmc-copy](./kmc-copy.md) &gt; [KeymanProjectCopier](./kmc-copy.keymanprojectcopier.md) &gt; [options](./kmc-copy.keymanprojectcopier.options.md)
+
+## KeymanProjectCopier.options property
+
+**Signature:**
+
+```typescript
+options: CopierOptions;
+```

developer/18.0/reference/api/kmc-copy.keymanprojectcopier.outpath.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@keymanapp/kmc-copy](./kmc-copy.md) &gt; [KeymanProjectCopier](./kmc-copy.keymanprojectcopier.md) &gt; [outPath](./kmc-copy.keymanprojectcopier.outpath.md)
+
+## KeymanProjectCopier.outPath property
+
+**Signature:**
+
+```typescript
+outPath: string;
+```

developer/18.0/reference/api/kmc-copy.keymanprojectcopier.outputid.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@keymanapp/kmc-copy](./kmc-copy.md) &gt; [KeymanProjectCopier](./kmc-copy.keymanprojectcopier.md) &gt; [outputId](./kmc-copy.keymanprojectcopier.outputid.md)
+
+## KeymanProjectCopier.outputId property
+
+**Signature:**
+
+```typescript
+outputId: string;
+```

developer/18.0/reference/api/kmc-copy.keymanprojectcopier.relocateexternalfiles.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@keymanapp/kmc-copy](./kmc-copy.md) &gt; [KeymanProjectCopier](./kmc-copy.keymanprojectcopier.md) &gt; [relocateExternalFiles](./kmc-copy.keymanprojectcopier.relocateexternalfiles.md)
+
+## KeymanProjectCopier.relocateExternalFiles property
+
+**Signature:**
+
+```typescript
+relocateExternalFiles: boolean;
+```

developer/18.0/reference/api/kmc-copy.keymanprojectcopier.run.md

@@ -0,0 +1,26 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@keymanapp/kmc-copy](./kmc-copy.md) &gt; [KeymanProjectCopier](./kmc-copy.keymanprojectcopier.md) &gt; [run](./kmc-copy.keymanprojectcopier.run.md)
+
+## KeymanProjectCopier.run() method
+
+Copy a Keyman 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 [KeymanProjectCopier.init()](./kmc-copy.keymanprojectcopier.init.md) function to read any input files by disk.
+
+**Signature:**
+
+```typescript
+run(source: string): Promise<CopierResult>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  source | string | Source file or folder to copy. Can be a local file or folder, github:repo\[:path\], or cloud:id |
+
+**Returns:**
+
+Promise&lt;CopierResult&gt;
+
+Binary artifacts on success, null on failure.
+

developer/18.0/reference/api/kmc-copy.keymanprojectcopier.sourceid.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@keymanapp/kmc-copy](./kmc-copy.md) &gt; [KeymanProjectCopier](./kmc-copy.keymanprojectcopier.md) &gt; [sourceId](./kmc-copy.keymanprojectcopier.sourceid.md)
+
+## KeymanProjectCopier.sourceId property
+
+**Signature:**
+
+```typescript
+sourceId: string;
+```

developer/18.0/reference/api/kmc-copy.keymanprojectcopier.write.md

@@ -0,0 +1,26 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@keymanapp/kmc-copy](./kmc-copy.md) &gt; [KeymanProjectCopier](./kmc-copy.keymanprojectcopier.md) &gt; [write](./kmc-copy.keymanprojectcopier.write.md)
+
+## KeymanProjectCopier.write() method
+
+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
+
+**Signature:**
+
+```typescript
+write(artifacts: CopierArtifacts): Promise<boolean>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  artifacts | CopierArtifacts | object containing artifact binary data to write out |
+
+**Returns:**
+
+Promise&lt;boolean&gt;
+
+true on success
+

developer/18.0/reference/api/kmc-copy.md

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@keymanapp/kmc-copy](./kmc-copy.md)
+
+## kmc-copy package
+
+## Classes
+
+|  Class | Description |
+|  --- | --- |
+|  [KeymanProjectCopier](./kmc-copy.keymanprojectcopier.md) |  |
+
+## Interfaces
+
+|  Interface | Description |
+|  --- | --- |
+|  [CopierOptions](./kmc-copy.copieroptions.md) | Options for the Keyman Developer project copier |
+

developer/18.0/reference/api/kmc-generate.abstractgenerator.callbacks.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@keymanapp/kmc-generate](./kmc-generate.md) &gt; [AbstractGenerator](./kmc-generate.abstractgenerator.md) &gt; [callbacks](./kmc-generate.abstractgenerator.callbacks.md)
+
+## AbstractGenerator.callbacks property
+
+**Signature:**
+
+```typescript
+protected get callbacks(): CompilerCallbacks;
+```

developer/18.0/reference/api/kmc-generate.abstractgenerator.defaultartifacts.md

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@keymanapp/kmc-generate](./kmc-generate.md) &gt; [AbstractGenerator](./kmc-generate.abstractgenerator.md) &gt; [defaultArtifacts](./kmc-generate.abstractgenerator.defaultartifacts.md)
+
+## AbstractGenerator.defaultArtifacts() method
+
+Fills in the artifact outputPath used by all generators
+
+**Signature:**
+
+```typescript
+protected defaultArtifacts(): GeneratorArtifacts;
+```
+**Returns:**
+
+GeneratorArtifacts
+
+

developer/18.0/reference/api/kmc-generate.abstractgenerator.filenamemap.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@keymanapp/kmc-generate](./kmc-generate.md) &gt; [AbstractGenerator](./kmc-generate.abstractgenerator.md) &gt; [filenameMap](./kmc-generate.abstractgenerator.filenamemap.md)
+
+## AbstractGenerator.filenameMap property
+
+map of all files to be transformed, filled by this class and subclasses
+
+**Signature:**
+
+```typescript
+protected get filenameMap(): {
+        [index: string]: string;
+    };
+```