@m2c2kit/cli 0.1.3 → 0.1.7

package/dist/.env

@@ -1 +1 @@
-CLI_VERSION=0.1.3
+CLI_VERSION=0.1.7

package/dist/cli.js

@@ -63,6 +63,11 @@ await yarg
     });
 }, (argv) => {
     const appName = argv["name"];
+    if (!isValidAppName(appName)) {
+        console.error(`${chalk.red("ERROR")}: the name ${appName} is not valid. The name must be a valid JavaScript identifer (e.g., begin with a letter, $ or _; not contain spaces; not be a reserved word, etc.).`);
+        yarg.exit(1, new Error("invalid name"));
+    }
+    const className = appName.charAt(0).toUpperCase() + appName.slice(1);
     const newFolderPath = path.join(path.resolve(), appName);
     if (fs.existsSync(newFolderPath)) {
         console.error(`${chalk.red("ERROR")}: folder ${newFolderPath} already exists. Please remove this folder and try again.`);
@@ -114,6 +119,7 @@ await yarg
         try {
             const contents = applyValuesToTemplate(t.templateFilePath, {
                 appName: appName,
+                className: className,
                 cliVersion: cliVersion,
                 studyCode: generateStudyCode(),
             });
@@ -389,4 +395,105 @@ await yarg
 })
     .demandCommand()
     .strict()
+    // seems to have problems getting version automatically; thus I explicity
+    // provide
+    .version(cliVersion)
     .showHelpOnFail(true).argv;
+function isValidAppName(name) {
+    const reserved = [
+        "abstract",
+        "arguments",
+        "await",
+        "boolean",
+        "break",
+        "byte",
+        "case",
+        "catch",
+        "char",
+        "class",
+        "const",
+        "continue",
+        "debugger",
+        "default",
+        "delete",
+        "do",
+        "double",
+        "else",
+        "enum",
+        "eval",
+        "export",
+        "extends",
+        "false",
+        "final",
+        "finally",
+        "float",
+        "for",
+        "function",
+        "goto",
+        "if",
+        "implements",
+        "import",
+        "in",
+        "instanceof",
+        "int",
+        "interface",
+        "let",
+        "long",
+        "native",
+        "new",
+        "null",
+        "package",
+        "private",
+        "protected",
+        "public",
+        "return",
+        "short",
+        "static",
+        "super",
+        "switch",
+        "synchronized",
+        "this",
+        "throw",
+        "throws",
+        "transient",
+        "true",
+        "try",
+        "typeof",
+        "var",
+        "void",
+        "volatile",
+        "while",
+        "with",
+        "yield",
+    ];
+    const builtin = [
+        "Array",
+        "Date",
+        "eval",
+        "function",
+        "hasOwnProperty",
+        "Infinity",
+        "isFinite",
+        "isNaN",
+        "isPrototypeOf",
+        "length",
+        "Math",
+        "name",
+        "NaN",
+        "Number",
+        "Object",
+        "prototype",
+        "String",
+        "toString",
+        "undefined",
+        "valueOf",
+    ];
+    if (reserved.includes(name) || builtin.includes(name)) {
+        return false;
+    }
+    const re = /^[_$a-zA-Z\xA0-\uFFFF][_$a-zA-Z0-9\xA0-\uFFFF]*$/;
+    if (!re.test(name)) {
+        return false;
+    }
+    return true;
+}

package/dist/fonts/roboto/LICENSE.txt

@@ -1,202 +1,202 @@
-
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright [yyyy] [name of copyright owner]
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/dist/templates/README.md.handlebars

@@ -1,15 +1,17 @@
-# {{appName}}
-
-This project was generated with the m2c2kit CLI version {{cliVersion}}.
-
-## Development server
-
-Run `npm run serve` from the command line for a development server. Browse to `http://localhost:3000/`. The app will automatically compile and reload when you change source files.
-
-## Debugging
-
-With the file `.vscode/launch.json`, the project has been configured for debugging with Visual Studio Code and Chrome. If the development server is running, debugging in Visual Studio Code is available by pressing `F5` or selecting Run --> Start Debugging
-
-## Build
-
-Run `npm run build` from the command line to build the project. Build artifacts will be stored in the `dist/` directory.
+# {{appName}}
+
+This project was generated with the m2c2kit CLI version {{cliVersion}}.
+
+## Development server
+
+Run `npm run serve` from the command line for a development server. Browse to `http://localhost:3000/`. The app will automatically compile and reload when you change source files. If you get an error on the reload, edit `rollup.config.js` and increase the delay parameter (unit is milliseconds) in this line:
+
+    livereload({ watch: "build", delay: 0 })
+
+## Debugging
+
+With the file `.vscode/launch.json`, the project has been configured for debugging with Visual Studio Code and Chrome. If the development server is running, debugging in Visual Studio Code is available by pressing `F5` or selecting Run --> Start Debugging
+
+## Build
+
+Run `npm run build` from the command line to build the project. Build artifacts will be stored in the `dist/` directory.

package/dist/templates/index.html.handlebars

@@ -21,15 +21,15 @@
         width: 100vw;
       ">
     <canvas style="height: 100vh; width: 100vw"></canvas>
-    <!-- If you don't want the game to start immediately, remove game.start()
-           from the code and call game.start() somehow else, such as with
+      <!-- If you don't want the game to start immediately, remove session.start()
+           from the code and call session.start() somehow else, such as with
            the button shown below or a programmatic call -->
-    <!-- <button
+      <!-- <button
         style="position: absolute; bottom: 8px; left: 8px"
         id="startButton"
         onclick="{
           document.getElementById('startButton').disabled = true;
-          window.game.start();
+          window.session.start();
         }"
       >
         Start

package/dist/templates/launch.json.handlebars

@@ -1,15 +1,15 @@
-{
-  // Use IntelliSense to learn about possible attributes.
-  // Hover to view descriptions of existing attributes.
-  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
-  "version": "0.2.0",
-  "configurations": [
-    {
-      "type": "pwa-chrome",
-      "request": "launch",
-      "name": "Launch Chrome against localhost",
-      "url": "http://localhost:3000",
-      "webRoot": "${workspaceFolder}/build"
-    }
-  ]
-}
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "pwa-chrome",
+      "request": "launch",
+      "name": "Launch Chrome against localhost",
+      "url": "http://localhost:3000",
+      "webRoot": "${workspaceFolder}/build"
+    }
+  ]
+}

package/dist/templates/m2c2kit.json.handlebars

@@ -1,5 +1,5 @@
-{
-  "server": {
-    "studyCode": "{{studyCode}}"
-  }
+{
+  "server": {
+    "studyCode": "{{studyCode}}"
+  }
 }

package/dist/templates/package.json.handlebars

@@ -1,24 +1,24 @@
-{
-  "name": "{{appName}}",
-  "version": "1.0.0",
-  "scripts": {
-    "serve": "rollup -c --watch --configServe",
-    "build": "rollup -c --configProd"
-  },
-  "private": true,
-  "dependencies": {
-    "@m2c2kit/core": "0.1.1",
-    "@m2c2kit/addons": "0.1.1"
-  },
-  "devDependencies": {
-    "rollup": "2.61.1",
-    "@rollup/plugin-typescript": "8.3.0",
-    "@rollup/plugin-node-resolve": "13.1.1",
-    "@rollup/plugin-commonjs": "21.0.1",
-    "rollup-plugin-shim": "1.0.0",
-    "rollup-plugin-copy": "3.4.0",
-    "rollup-plugin-delete": "2.0.0",
-    "rollup-plugin-serve": "1.1.0",
-    "rollup-plugin-livereload": "2.0.5"
-  }
+{
+  "name": "{{appName}}",
+  "version": "1.0.0",
+  "scripts": {
+    "serve": "rollup -c --watch --configServe",
+    "build": "rollup -c --configProd"
+  },
+  "private": true,
+  "dependencies": {
+    "@m2c2kit/core": "0.1.5",
+    "@m2c2kit/addons": "0.1.5"
+  },
+  "devDependencies": {
+    "rollup": "2.63.0",
+    "@rollup/plugin-typescript": "8.3.0",
+    "@rollup/plugin-node-resolve": "13.1.3",
+    "@rollup/plugin-commonjs": "21.0.1",
+    "rollup-plugin-shim": "1.0.0",
+    "rollup-plugin-copy": "3.4.0",
+    "rollup-plugin-delete": "2.0.0",
+    "rollup-plugin-serve": "1.1.0",
+    "rollup-plugin-livereload": "2.0.5"
+  }
 }

package/dist/templates/rollup.config.js.handlebars

@@ -38,7 +38,7 @@ export default (commandLineArgs) => {
         },
       ],
       plugins: [
-        del({ targets: [`${outputFolder}/*`] }),
+        commandLineArgs.configProd && del({ targets: [outputFolder] }),
         ...sharedPlugins,
         typescript({
           inlineSourceMap: commandLineArgs.configServe && true,
@@ -85,7 +85,7 @@ export default (commandLineArgs) => {
           port: 3000,
         }),
         commandLineArgs.configServe &&
-        livereload(),
+        livereload({ watch: "build", delay: 0 }),
       ],
     },
   ];

package/dist/templates/starter.ts.handlebars

@@ -1,96 +1,377 @@
-import {
-  WebColors,
-  Action,
-  Game,
-  Scene,
-  Sprite,
-  Point,
-  Label,
-} from "@m2c2kit/core";
-
-import {
-  Button
-} from "@m2c2kit/addons";
-
-const game = new Game();
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-(window as unknown as any).game = game;
-
-game
-  .init({
-    showFps: true,
-    // set this color so we can see the boundaries of the game
-    bodyBackgroundColor: WebColors.Wheat,
-    // note: using 2:1 aspect ratio, because that is closer to modern phones
-    width: 400,
-    height: 800,
-    // set stretch to true if you want to fill the screen
-    stretch: false,
-    fontUrls: [
-      "./fonts/roboto/Roboto-Regular.ttf",
-    ],
-    // each svgImage below, you specify either a tag of an svg in the property "svgString" (as I do below)
-    // or you specify a URL to an svg in the property "url", such as url: 'https://dev.w3.org/SVG/tools/svgweb/samples/svg-files/android.svg'
-    svgImages: [
-      {
-        name: "star",
-        height: 60,
-        width: 60,
-        svgString:
-          '<svg xmlns="http://www.w3.org/2000/svg" width="304" height="290"> <path d="M2,111 h300 l-242.7,176.3 92.7,-285.3 92.7,285.3 z" style="fill:#00FF00;stroke:#0000FF;stroke-width:15;stroke-linejoin:round"/></svg>',
-      },
-    ],
-  })
-  .then(() => {
-    const s = new Scene({
-      backgroundColor: WebColors.SlateBlue,
-      name: "firstScene",
-    });
-    game.addScene(s);
-
-    const greeting = new Label({
-      text: "Hello, {{appName}}",
-      fontColor: WebColors.WhiteSmoke,
-      position: new Point(200, 200),
-    });
-    s.addChild(greeting);
-
-    const starImage = new Sprite({
-      imageName: "star",
-      position: new Point(200, 400),
-    });
-    s.addChild(starImage);
-
-    const messageLabel = new Label({
-      text: "you clicked the button!",
-      fontColor: WebColors.Yellow,
-      position: new Point(200, 600),
-    });
-    s.addChild(messageLabel);
-    messageLabel.hidden = true;
-
-    const button = new Button( { text: "Click me!", position: new Point(200, 700) });
-    button.isUserInteractionEnabled = true;
-    button.onTap(() => {
-      console.log("you tapped it!");
-      button.run(
-        Action.Sequence([
-          Action.Custom({
-            callback: () => {
-              messageLabel.hidden = false;
-            },
-          }),
-          Action.Wait({ duration: 500 }),
-          Action.Custom({
-            callback: () => {
-              messageLabel.hidden = true;
-            },
-          }),
-        ])
-      );
-    });
-
-    s.addChild(button);
-
-    game.start("firstScene");
-  });
+import {
+  WebColors,
+  Action,
+  Game,
+  Scene,
+  Sprite,
+  Point,
+  Label,
+  LabelHorizontalAlignmentMode,
+  Shape,
+  Rect,
+  GameOptions,
+  GameParameters,
+  TrialSchema,
+  Session,
+  GameTrialEvent,
+  GameLifecycleEvent,
+} from "@m2c2kit/core";
+import { Button, Instructions } from "@m2c2kit/addons";
+
+class {{className}} extends Game {
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  constructor(specifiedParameters?: any) {
+    const defaultParameters: GameParameters = {
+      ReadyTime: {
+        value: 1000,
+        description:
+          "How long the 'get ready' message scene is shown, milliseconds",
+      },
+      TrialNum: { value: 3, description: "How many trials to run" },
+    };
+
+    const demoTrialSchema: TrialSchema = {
+      colorChosen: { type: "string", description: "the color that was picked" },
+      correct: { type: "boolean", description: "was the answer correct?" },
+    };
+
+    const options: GameOptions = {
+      name: "{{appName}}",
+      version: "1.0.0",
+      uri: "https://your-repo-or-webpage-here",
+      shortDescription: "A brief couple sentence description.",
+      longDescription: "An extended, many-sentence description.",
+      showFps: true,
+      trialSchema: demoTrialSchema,
+      parameters: defaultParameters,
+      // set this color so we can see the boundaries of the game during development,
+      // but typically we would not set this
+      bodyBackgroundColor: WebColors.Wheat,
+      // note: using 2:1 aspect ratio, because that is closer to modern phones
+      width: 400,
+      height: 800,
+      // set stretch to true if you want to fill the screen on large windows
+      // (e.g., iPad, desktop browser)
+      stretch: false,
+      // Roboto is included by default. Leave fontUrls unchanged, unless you want to use different font
+      fontUrls: ["./fonts/roboto/Roboto-Regular.ttf"],
+      // for each image below, you specify either a tag of an svg in the property "svgString"
+      // or you specify a URL to an image in the property "url",
+      // such as url: 'https://dev.w3.org/SVG/tools/svgweb/samples/svg-files/android.svg'
+      images: [
+        {
+          name: "star",
+          height: 60,
+          width: 60,
+          svgString:
+            '<svg xmlns="http://www.w3.org/2000/svg" width="304" height="290"> <path d="M2,111 h300 l-242.7,176.3 92.7,-285.3 92.7,285.3 z" style="fill:#00FF00;stroke:#0000FF;stroke-width:15;stroke-linejoin:round"/></svg>',
+        },
+        {
+          name: "smiley",
+          height: 64,
+          width: 64,
+          svgString:
+            '<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px" viewBox="451.451 -28.549 1657.098 1657.098" enable-background="new 451.451 -28.549 1657.098 1657.098" xml:space="preserve"><g><g><circle cx="992.682" cy="640.47" r="66.818"/></g><g><circle cx="1558.728" cy="640.47" r="66.818"/></g><g><path d="M1280,1600c-107.984,0-212.756-21.157-311.407-62.883c-95.268-40.295-180.819-97.973-254.279-171.432c-73.459-73.459-131.137-159.01-171.432-254.278C501.157,1012.757,480,907.984,480,800s21.157-212.756,62.883-311.407c40.295-95.268,97.973-180.819,171.432-254.279c73.46-73.459,159.011-131.137,254.279-171.432C1067.244,21.157,1172.016,0,1280,0s212.757,21.157,311.407,62.883c95.268,40.295,180.819,97.973,254.278,171.432c73.459,73.46,131.137,159.011,171.432,254.279C2058.843,587.244,2080,692.016,2080,800s-21.157,212.757-62.883,311.407c-40.295,95.268-97.973,180.819-171.432,254.278s-159.01,131.137-254.278,171.432C1492.757,1578.843,1387.984,1600,1280,1600z M1280,71.591c-401.646,0-728.409,326.763-728.409,728.409S878.354,1528.409,1280,1528.409S2008.409,1201.646,2008.409,800C2008.409,398.354,1681.646,71.591,1280,71.591z"/></g><g><path d="M1665.953,1071.004c-213.156,213.156-558.75,213.156-771.905,0c20.534-20.534,41.068-41.068,61.602-61.602c179.134,179.134,469.567,179.134,648.7,0C1624.884,1029.936,1645.418,1050.47,1665.953,1071.004z"/></g><g><path d="M1167.066,463.279c-96.31-96.31-252.459-96.31-348.768,0c16.971,16.971,33.941,33.941,50.912,50.912c68.192-68.192,178.753-68.192,246.945,0C1133.125,497.22,1150.096,480.249,1167.066,463.279z"/></g><g><path d="M1733.112,463.279c-96.31-96.31-252.459-96.31-348.768,0c16.971,16.971,33.941,33.941,50.912,50.912c68.192-68.192,178.753-68.192,246.945,0C1699.171,497.22,1716.142,480.249,1733.112,463.279z"/></g></g></svg>',
+        },
+      ],
+    };
+
+    super(options, specifiedParameters);
+    // just for convenience, alias the variable game to "this"
+    // (even though eslint doesn't like it)
+    // eslint-disable-next-line @typescript-eslint/no-this-alias
+    const game = this;
+
+    const instructionsScenes = Instructions.Create({
+      sceneNamePrefix: "instructions",
+      backgroundColor: WebColors.White,
+      nextButtonBackgroundColor: WebColors.Black,
+      backButtonBackgroundColor: WebColors.Black,
+      instructionScenes: [
+        {
+          title: "{{appName}} Demo",
+          text: "For this task, you will click the red rectangle. Open the developer console to see the trial data and other output.",
+          textFontSize: 24,
+          titleFontSize: 30,
+          image: "smiley",
+        },
+        {
+          title: "{{appName}} Demo",
+          text: "Press START to begin!",
+          textFontSize: 24,
+          titleFontSize: 30,
+          textAlignmentMode: LabelHorizontalAlignmentMode.center,
+          textVerticalBias: 0.25,
+          nextButtonText: "START",
+          nextButtonBackgroundColor: WebColors.Green,
+        },
+      ],
+      // this is the name of the scene to go to after the last instructions scene
+      postInstructionsScene: "getReady",
+    });
+    game.addScenes(instructionsScenes);
+
+    const getReadyScene = new Scene({
+      // Because this is the scene after the instructions, we must give
+      // it a name and provide it to postInstructionsScene, above
+      name: "getReady",
+      backgroundColor: WebColors.White,
+    });
+    game.addScene(getReadyScene);
+
+    const getReadyMessage = new Label({
+      text: "Get Ready",
+      fontSize: 24,
+      position: new Point(200, 400),
+    });
+    getReadyScene.addChild(getReadyMessage);
+
+    // example of how to use an image. The image must be previously loaded
+    const starSprite = new Sprite({
+      imageName: "star",
+      position: new Point(200, 500),
+    });
+    getReadyScene.addChild(starSprite);
+
+    // getReadyScene.setup() has a callback that is executed each time this scene is shown
+    getReadyScene.setup(() => {
+      getReadyScene.run(
+        Action.Sequence([
+          // Get the wait duration from the default game parameters, defined above
+          Action.Wait({ duration: game.getParameter("ReadyTime") }),
+          Action.Custom({
+            callback: () => {
+              game.presentScene(chooseRectangleScene);
+            },
+          }),
+        ])
+      );
+    });
+
+    // these entities before the setup() can be defined outside of a setup()
+    // because they exist through multiple trials
+    // Their position and how they respond to interactions may differ across trials,
+    // and that logic will be written within a setup()
+    const chooseRectangleScene = new Scene({
+      backgroundColor: WebColors.LightGray,
+    });
+    game.addScene(chooseRectangleScene);
+    const redRect = new Shape({
+      rect: new Rect({ width: 150, height: 100 }),
+      fillColor: WebColors.Red,
+    });
+    chooseRectangleScene.addChild(redRect);
+    const blueRect = new Shape({
+      rect: new Rect({ width: 150, height: 100 }),
+      fillColor: WebColors.Blue,
+    });
+    chooseRectangleScene.addChild(blueRect);
+    const correctMessage = new Label({
+      text: "CORRECT!",
+      position: new Point(200, 500),
+    });
+
+    const chooseMessage = new Label({
+      text: "Choose the red rectangle",
+      position: new Point(200, 200),
+    });
+    chooseRectangleScene.addChild(chooseMessage);
+
+    correctMessage.hidden = true;
+    chooseRectangleScene.addChild(correctMessage);
+    const wrongMessage = new Label({
+      text: "WRONG!",
+      position: new Point(200, 500),
+    });
+
+    wrongMessage.hidden = true;
+    chooseRectangleScene.addChild(wrongMessage);
+
+    // chooseRectangleScene.setup() is passed a callback that is executed each
+    // time this scene is shown. Within setup(), We will randomly decide on
+    // what side the red rectangle is shown
+    chooseRectangleScene.setup(() => {
+      let redOnLeft = true;
+      if (Math.random() > 0.5) {
+        redOnLeft = false;
+      }
+
+      if (redOnLeft) {
+        redRect.position = new Point(100, 300);
+        blueRect.position = new Point(300, 300);
+      } else {
+        redRect.position = new Point(300, 300);
+        blueRect.position = new Point(100, 300);
+      }
+
+      // helper function to record the user's choice and
+      // decide if we are done
+      function recordUserInput(choseRedRect: boolean) {
+        game.addTrialData("correct", choseRedRect);
+        if (choseRedRect) {
+          game.addTrialData("colorChosen", "red");
+        } else {
+          game.addTrialData("colorChosen", "blue");
+        }
+        game.trialComplete();
+        // have we finished the number of trials?
+        if (game.trialIndex < game.getParameter<number>("TrialNum")) {
+          game.presentScene(getReadyScene);
+        } else {
+          game.presentScene(endScene);
+        }
+      }
+
+      redRect.isUserInteractionEnabled = true;
+      redRect.onTapDown(() => {
+        redRect.run(
+          Action.Sequence([
+            Action.Custom({
+              callback: () => {
+                // once a choice is made, don't allow additional taps
+                redRect.isUserInteractionEnabled = false;
+                blueRect.isUserInteractionEnabled = false;
+              },
+            }),
+            // short animation to shrink and grow button
+            Action.Scale({ scale: 0.8, duration: 250 }),
+            Action.Scale({ scale: 1, duration: 250 }),
+            // Show the "CORRECT" message
+            Action.Custom({
+              callback: () => {
+                correctMessage.hidden = false;
+              },
+            }),
+            Action.Wait({ duration: 1000 }),
+            // Handle the logic of recording data, and deciding if we should
+            // do another trial in recordUserInput
+            Action.Custom({
+              callback: () => {
+                correctMessage.hidden = true;
+                recordUserInput(true);
+              },
+            }),
+          ])
+        );
+      });
+
+      blueRect.isUserInteractionEnabled = true;
+      blueRect.onTapDown(() => {
+        blueRect.run(
+          Action.Sequence([
+            Action.Custom({
+              callback: () => {
+                redRect.isUserInteractionEnabled = false;
+                blueRect.isUserInteractionEnabled = false;
+              },
+            }),
+            Action.Scale({ scale: 0.8, duration: 250 }),
+            Action.Scale({ scale: 1, duration: 250 }),
+            Action.Custom({
+              callback: () => {
+                wrongMessage.hidden = false;
+              },
+            }),
+            Action.Wait({ duration: 1000 }),
+            Action.Custom({
+              callback: () => {
+                wrongMessage.hidden = true;
+                recordUserInput(false);
+              },
+            }),
+          ])
+        );
+      });
+    });
+
+    const endScene = new Scene();
+    game.addScene(endScene);
+    const doneLabel = new Label({
+      text: `This will be reassigned in the setup() callback. If you see this, something went wrong!`,
+      position: new Point(200, 300),
+    });
+    endScene.addChild(doneLabel);
+
+    const startOverButton = new Button({
+      text: "Start over",
+      position: new Point(200, 600),
+    });
+    startOverButton.isUserInteractionEnabled = true;
+    startOverButton.onTapDown(() => {
+      // in the setup() for the end scene, we animate the smiley sprite with
+      // a move action. if the user taps the start over button before the
+      // animation is completed, we should remove it by calling
+      // removeAllActions()
+      smileySprite.removeAllActions();
+      game.initData();
+      game.presentScene(getReadyScene);
+    });
+    endScene.addChild(startOverButton);
+
+    const exitButton = new Button({
+      text: "Exit",
+      position: new Point(200, 675),
+    });
+    exitButton.isUserInteractionEnabled = true;
+    exitButton.onTapDown(() => {
+      // hide the start over button
+      startOverButton.hidden = true;
+      // don't allow repeated taps on exit button
+      exitButton.isUserInteractionEnabled = false;
+      game.end();
+    });
+    endScene.addChild(exitButton);
+
+    const smileySprite = new Sprite({ imageName: "smiley" });
+    endScene.addChild(smileySprite);
+
+    endScene.setup(() => {
+      doneLabel.text = `You did ${game.trialIndex} trials. You're done!`;
+
+      // example of how to position a sprite and create an action to move it
+      smileySprite.position = new Point(200, 500);
+      smileySprite.run(
+        Action.Move({ point: new Point(200, 100), duration: 3000 })
+      );
+    });
+
+    game.entryScene = "instructions-01";
+  }
+}
+
+// default was 3 trials; this is how we can specify a different value
+const game1 = new {{className}}({ TrialNum: 2 });
+
+const session = new Session({
+  activities: [game1],
+  gameCallbacks: {
+    // onGameTrialComplete() is where you insert code to post data to an API
+    // or interop with a native function in the host app, if applicable
+    onGameTrialComplete: (e: GameTrialEvent) => {
+      console.log(`********** trial ${e.trialIndex} complete`);
+      console.log("data: " + JSON.stringify(e.gameData));
+      console.log("trial schema: " + JSON.stringify(e.trialSchema));
+      console.log("game parameters: " + JSON.stringify(e.gameParameters));
+    },
+    // onGameEnd() is called when the user is done
+    onGameEnd: (e: GameLifecycleEvent) => {
+      if (e.ended) {
+        console.log(`user requested exit in game ${e.gameName}`);
+        // this session has only one activity, but this is how it would go to
+        // the next activity
+        if (session.nextActivity) {
+          session.advanceToNextActivity();
+        }
+      }
+    },
+  },
+});
+
+// make session also available on window in case we want to control
+// the session through another means
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+(window as unknown as any).session = session;
+
+session.init().then(() => {
+  session.start();
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@m2c2kit/cli",
-  "version": "0.1.3",
+  "version": "0.1.7",
   "description": "m2c2kit command line interface",
   "module": "dist/cli.js",
   "files": [
@@ -30,15 +30,15 @@
     "handlebars": "4.7.7",
     "ora": "6.0.1",
     "prompts": "2.4.2",
-    "yargs": "17.3.0"
+    "yargs": "17.3.1"
   },
   "devDependencies": {
-    "@types/node": "16.11.12",
+    "@types/node": "17.0.8",
     "@types/prompts": "2.0.14",
-    "@types/yargs": "17.0.7",
+    "@types/yargs": "17.0.8",
     "copyfiles": "2.4.1",
     "rimraf": "3.0.2",
     "tslib": "2.3.1",
-    "typescript": "4.5.3"
+    "typescript": "4.5.4"
   }
 }