flowershow 0.0.9 → 0.0.11

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # flowershow
 
+## 0.0.11
+
+### Patch Changes
+
+- Basic anonymous telemetry (OS, Flowershow version and command being run).
+
+## 0.0.10
+
+### Patch Changes
+
+- Rename `flowershow build-static` to `flowershow export`.
+
 ## 0.0.9
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "flowershow",
-  "version": "0.0.9",
+  "version": "0.0.11",
   "description": "Publish your digital garden",
   "bin": {
     "flowershow": "src/bin/cli.js"
@@ -29,7 +29,8 @@
     "degit": "^2.8.4",
     "execa": "^6.1.0",
     "inquirer": "^9.1.1",
-    "ora": "^6.1.2"
+    "ora": "^6.1.2",
+    "universal-analytics": "^0.5.3"
   },
   "type": "module",
   "engines": {

package/src/bin/cli.js

@@ -1,20 +1,48 @@
 #!/usr/bin/env node
 import { createRequire } from "node:module";
 const require = createRequire(import.meta.url);
-import { warn } from "../lib/utils/index.js";
+import { warn, exit, sendEvent } from "../lib/utils/index.js";
+import { Command } from "commander";
 
-import os from "os";
+// TODO check current vs required node version (package.json engines)
+// const requiredNodeVersion = require("../package.json").engines.node;
 
-if (os.platform() === "win32") {
+const { version: cli } = require("../../package.json");
+const { version: node, platform, argv } = process;
+
+if (platform === "win32") {
   warn(
-    "This may not work as expected. You're trying to run Flowreshow CLI on Windows, which is not supported yet..."
+    "This may not work as expected. You're trying to run Flowreshow CLI on Windows, which is not thoroughly tested. Please submit an issue if you encounter any problems: https://github.com/flowershow/flowershow/issues"
   );
 }
 
-// TODO check current vs required node version (package.json engines)
-// const requiredNodeVersion = require("../package.json").engines.node;
+const [, , cmd, ...args] = argv;
+sendEvent({
+  event: "cli-usage",
+  action: cmd,
+  meta: {
+    args,
+    cli,
+    node,
+    platform,
+  },
+});
 
-import { Command } from "commander";
+process.on("uncaughtException", () => {
+  sendEvent({
+    event: "cli-error",
+    action: cmd,
+    meta: {
+      args,
+      cli,
+      node,
+      platform,
+    },
+  });
+  exit(1);
+});
+
+// CLI commands
 
 const program = new Command();
 
@@ -54,16 +82,16 @@ program
   });
 
 program
-  .command("build-static")
-  .description("build static Flowershow website")
+  .command("export")
+  .description("build a static Flowershow website")
   .argument(
     "[project-dir]",
     "Path to the folder where Flowershow template is installed (root folder of .flowershow)",
     "."
   )
   .action(async (projectPath) => {
-    const { default: buildStatic } = await import("../lib/buildStatic.js");
-    buildStatic(projectPath);
+    const { default: buildExport } = await import("../lib/buildExport.js");
+    buildExport(projectPath);
   });
 
 program

package/src/lib/Installer.js

@@ -180,7 +180,9 @@ export default class Installer {
       const emitter = degit(templateRepo);
       await emitter.clone(flowershowDir);
     } catch {
-      error(`Failed to create Flowershow template in ${flowershowDir}.`);
+      error(
+        `Failed to clone Flowershow template into ${flowershowDir}. This may be a problem with Flowershow. Please let us know about it by submitting an issue: https://github.com/flowershow/flowershow/issues.`
+      );
       exit(1);
     }
 

package/src/lib/{buildStatic.js → buildExport.js}

@@ -3,7 +3,7 @@ import { execa } from "execa";
 
 import { FLOWERSHOW_FOLDER_NAME } from "./const.js";
 
-export default async function buildStatic(dir) {
+export default async function buildExport(dir) {
   const flowershowDir = path.resolve(dir, FLOWERSHOW_FOLDER_NAME);
 
   const subprocess = execa("npm", ["run", "export"], { cwd: flowershowDir });

package/src/lib/utils/index.js

@@ -1,6 +1,7 @@
 export { error, info, log, success, warn } from "./logger.js";
 export { exit } from "./exit.js";
 export { isSubdir } from "./isSubdir.js";
+export { sendEvent } from "./sendEvent.js";
 export {
   logWithSpinner,
   stopSpinner,

package/src/lib/utils/sendEvent.js

@@ -0,0 +1,7 @@
+import ua from "universal-analytics";
+
+const visitor = ua("UA-235099461-1");
+
+export function sendEvent({ event, action, meta }) {
+  visitor.event(event, action, JSON.stringify(meta)).send();
+}