feat: disable telemetry by option (#345)

* feat(disable-telemetry): add `--disable-telemetry` option * chore: bump to 1.16.0
pankod · Jun 1, 2023 · 9a41f1d · 9a41f1d
1 parent fa1386f
commit 9a41f1d
Show file tree

Hide file tree

Showing 6 changed files with 16 additions and 40 deletions.
diff --git a/@types/sao.d.ts b/@types/sao.d.ts
@@ -311,6 +311,7 @@ interface IExtras {
     paths: IPaths;
     projectType: string;
     presetAnswers?: Record<string, string | undefined>;
+    disableTelemetry?: boolean;
 }
 interface Options$1 {
     appName?: string;

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "superplate-cli",
-    "version": "1.15.5",
+    "version": "1.16.0",
     "description": "The frontend boilerplate with superpowers",
     "license": "MIT",
     "repository": {

diff --git a/src/Helper/index.ts b/src/Helper/index.ts
@@ -31,6 +31,5 @@ export {
     is_multi_type,
     prompt_project_types,
 } from "./source";
-export { prompt_telemetry } from "./telemetry";
 export { tips } from "./tips";
 export { UrlHelper } from "./url";
diff --git a/src/Helper/telemetry/index.ts b/src/Helper/telemetry/index.ts
diff --git a/src/cli.ts b/src/cli.ts
@@ -52,6 +52,7 @@ const cli = async (): Promise<void> => {
         )
         .option("-p, --project <project-name>", "specify a project type to use")
         .option("-d, --debug", "print additional logs and skip install script")
+        .option("--disable-telemetry", "disable anonymous telemetry")
         .on("--help", () => {
             console.log();
             console.log(
@@ -193,6 +194,7 @@ const cli = async (): Promise<void> => {
         extras: {
             apiMode: false,
             debug: !!program.debug,
+            disableTelemetry: !!program.disableTelemetry,
             projectType,
             paths: {
                 sourcePath,

diff --git a/src/saofile.ts b/src/saofile.ts
@@ -8,7 +8,6 @@ import {
     mergeJSONFiles,
     mergePackages,
     mergePluginData,
-    prompt_telemetry,
     tips,
 } from "@Helper";
 import { ProjectPrompt } from "@Helper/lucky";
@@ -325,22 +324,18 @@ const saoConfig: GeneratorConfig = {
             },
         });
 
-        if (!sao.opts.extras.apiMode) {
-            const { telemetry } = await prompt_telemetry();
-
-            if (telemetry === "yes") {
-                try {
-                    analytics.track({
-                        event: "generate",
-                        properties: {
-                            ...sao.answers,
-                            type: sao.opts.extras.projectType,
-                        },
-                        anonymousId: uuidv4(),
-                    });
-                } catch (error) {
-                    //
-                }
+        if (!sao.opts.extras.apiMode && !sao.opts.extras.disableTelemetry) {
+            try {
+                analytics.track({
+                    event: "generate",
+                    properties: {
+                        ...sao.answers,
+                        type: sao.opts.extras.projectType,
+                    },
+                    anonymousId: uuidv4(),
+                });
+            } catch (error) {
+                //
             }
         }