@prasenjeet/shipli 1.2.0 → 1.2.1

package/README.md

@@ -3,6 +3,8 @@
 [![npm version](https://img.shields.io/npm/v/@prasenjeet/shipli)](https://www.npmjs.com/package/@prasenjeet/shipli)
 [![license](https://img.shields.io/npm/l/@prasenjeet/shipli)](LICENSE)
 
+**Website:** [https://prasenjeet-symon.github.io/shipli-ai/](https://prasenjeet-symon.github.io/shipli-ai/)
+
 Store rejections cost days of development time. **Shipli** is a CLI tool that audits your Flutter source code against **Apple App Store** and **Google Play** guidelines using AI.
 
 Catch missing permissions, policy violations, and compliance issues before you submit.
@@ -233,6 +235,24 @@ The assistant will call the appropriate Shipli MCP tool and return the results i
 
 The CLI exits with code `1` on failure, making it easy to gate deployments.
 
+## Telemetry
+
+Shipli collects anonymous usage metrics to help improve the tool. No project data, file contents, API keys, or personally identifiable information is ever collected.
+
+**What's collected:** audit mode, platform, provider, model, pass/fail score, duration, token counts, OS, and CLI version.
+
+**Opt out** using any of these methods:
+
+```bash
+# Environment variable
+export SHIPLI_TELEMETRY=off
+
+# Or use the Do Not Track standard
+export DO_NOT_TRACK=1
+```
+
+Or add `"telemetry": false` to your `~/.shipli` config file.
+
 ## License
 
 MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prasenjeet/shipli",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "description": "AI-powered App Store review audit for Flutter projects. Catch rejections before you submit.",
   "type": "module",
   "bin": {
@@ -28,9 +28,10 @@
   ],
   "author": "",
   "license": "MIT",
+  "homepage": "https://prasenjeet-symon.github.io/shipli-ai/",
   "repository": {
     "type": "git",
-    "url": ""
+    "url": "https://github.com/prasenjeet-symon/shipli-ai"
   },
   "dependencies": {
     "@modelcontextprotocol/sdk": "^1.27.1",

package/src/index.js

@@ -18,6 +18,7 @@ import { audit } from './auditor.js';
 import { fetchGuidelines } from './guidelines.js';
 import { print as printReport } from './reporter.js';
 import { PROVIDER_DEFAULTS as DEFAULTS, detectPlatform } from './defaults.js';
+import { trackEvent } from './telemetry.js';
 
 // Read package version
 const __dirname = dirname(fileURLToPath(import.meta.url));
@@ -113,6 +114,7 @@ program
 
     const platformLabel = { ios: 'iOS', android: 'Android', both: 'iOS + Android' }[platform];
     let spinner = ora({ text: `Scanning Flutter project (${platformLabel})...`, color: 'cyan' }).start();
+    const startTime = Date.now();
 
     try {
       // 1. Read pubspec.yaml first (needed for type detection)
@@ -205,11 +207,23 @@ program
         platform,
       });
 
-      // 9. Exit with appropriate code
-      process.exit(result.score === 'FAIL' ? 1 : 0);
+      // 9. Track and exit
+      trackEvent('audit_completed', {
+        source: 'cli', mode, platform, provider, model,
+        project_type: projectType, score: result.score,
+        duration_ms: Date.now() - startTime,
+        tokens_input: result._tokens?.actual?.input ?? null,
+        tokens_output: result._tokens?.actual?.output ?? null,
+      });
+      process.exitCode = result.score === 'FAIL' ? 1 : 0;
     } catch (err) {
       spinner.fail(chalk.red(err.message));
-      process.exit(1);
+      trackEvent('audit_error', {
+        source: 'cli', mode, platform, provider, model,
+        duration_ms: Date.now() - startTime,
+        error_message: err.message.slice(0, 200),
+      });
+      process.exitCode = 1;
     }
   });
 

package/src/mcp-server.js

@@ -15,6 +15,7 @@ import { fetchGuidelines } from './guidelines.js';
 import { audit } from './auditor.js';
 import { loadConfig } from './config.js';
 import { PROVIDER_DEFAULTS, detectPlatform } from './defaults.js';
+import { trackEvent } from './telemetry.js';
 
 // ── Read package version ──
 
@@ -72,6 +73,7 @@ server.tool(
     platform: z.enum(['ios', 'android', 'both']).optional().describe('Target platform: "ios" (App Store only), "android" (Play Store only), or "both" (both stores). Auto-detected from ios/ and android/ directory presence if omitted.'),
   },
   async ({ projectDir, platform }) => {
+    const startTime = Date.now();
     try {
       const dir = validateProject(projectDir);
       const { provider, model, apiKey } = resolveConfig(dir);
@@ -124,10 +126,23 @@ server.tool(
         { apiKey, model, provider, mode: 'store', platform: resolvedPlatform },
       );
 
+      trackEvent('audit_completed', {
+        source: 'mcp', mode: 'store', platform: resolvedPlatform,
+        provider, model, project_type: projectType, score: result.score,
+        duration_ms: Date.now() - startTime,
+        tokens_input: result._tokens?.actual?.input ?? null,
+        tokens_output: result._tokens?.actual?.output ?? null,
+      });
+
       return {
         content: [{ type: 'text', text: JSON.stringify(result, null, 2) }],
       };
     } catch (err) {
+      trackEvent('audit_error', {
+        source: 'mcp', mode: 'store',
+        duration_ms: Date.now() - startTime,
+        error_message: err.message.slice(0, 200),
+      });
       return {
         content: [{ type: 'text', text: `Error: ${err.message}` }],
         isError: true,
@@ -145,6 +160,7 @@ server.tool(
     projectDir: z.string().describe('Absolute path to the Flutter project root directory. Must contain a pubspec.yaml and a lib/ folder. Example: "/Users/you/projects/my-flutter-app"'),
   },
   async ({ projectDir }) => {
+    const startTime = Date.now();
     try {
       const dir = validateProject(projectDir);
       const { provider, model, apiKey } = resolveConfig(dir);
@@ -176,10 +192,23 @@ server.tool(
         { apiKey, model, provider, mode: 'code', platform: 'both' },
       );
 
+      trackEvent('audit_completed', {
+        source: 'mcp', mode: 'code', platform: 'both',
+        provider, model, project_type: projectType, score: result.score,
+        duration_ms: Date.now() - startTime,
+        tokens_input: result._tokens?.actual?.input ?? null,
+        tokens_output: result._tokens?.actual?.output ?? null,
+      });
+
       return {
         content: [{ type: 'text', text: JSON.stringify(result, null, 2) }],
       };
     } catch (err) {
+      trackEvent('audit_error', {
+        source: 'mcp', mode: 'code',
+        duration_ms: Date.now() - startTime,
+        error_message: err.message.slice(0, 200),
+      });
       return {
         content: [{ type: 'text', text: `Error: ${err.message}` }],
         isError: true,

package/src/telemetry.js

@@ -0,0 +1,83 @@
+import { createHash } from 'node:crypto';
+import { hostname, userInfo, platform, arch } from 'node:os';
+import { readFileSync } from 'node:fs';
+import { join } from 'node:path';
+import { homedir } from 'node:os';
+import { fileURLToPath } from 'node:url';
+import { dirname } from 'node:path';
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+const pkg = JSON.parse(readFileSync(join(__dirname, '..', 'package.json'), 'utf-8'));
+
+const POSTHOG_ENDPOINT = 'https://us.i.posthog.com/capture';
+const POSTHOG_API_KEY = 'phc_JcSoYrxMXvJjCtlePCFI6UuhNbwq33WXNeUKmDB6Msz';
+
+// ── Opt-out check (lazy, cached) ──
+
+let _disabled = null;
+
+function isDisabled() {
+  if (_disabled !== null) return _disabled;
+
+  const envVal = (process.env.SHIPLI_TELEMETRY || '').toLowerCase();
+  if (['off', 'false', '0', 'no'].includes(envVal)) {
+    _disabled = true;
+    return true;
+  }
+
+  if (process.env.DO_NOT_TRACK === '1') {
+    _disabled = true;
+    return true;
+  }
+
+  try {
+    const raw = readFileSync(join(homedir(), '.shipli'), 'utf-8');
+    const config = JSON.parse(raw);
+    if (config.telemetry === false) {
+      _disabled = true;
+      return true;
+    }
+  } catch {
+    // No config file or invalid JSON — telemetry stays on
+  }
+
+  _disabled = false;
+  return false;
+}
+
+// ── Anonymous device ID ──
+
+function getAnonymousId() {
+  try {
+    const raw = `${hostname()}:${userInfo().username}`;
+    return createHash('sha256').update(raw).digest('hex').slice(0, 16);
+  } catch {
+    return createHash('sha256').update(hostname()).digest('hex').slice(0, 16);
+  }
+}
+
+// ── Fire-and-forget event dispatch ──
+
+export function trackEvent(name, properties = {}) {
+  if (isDisabled()) return;
+
+  const payload = {
+    api_key: POSTHOG_API_KEY,
+    event: name,
+    distinct_id: getAnonymousId(),
+    properties: {
+      ...properties,
+      cli_version: pkg.version,
+      node_version: process.version,
+      os: platform(),
+      arch: arch(),
+    },
+  };
+
+  fetch(POSTHOG_ENDPOINT, {
+    method: 'POST',
+    headers: { 'Content-Type': 'application/json' },
+    body: JSON.stringify(payload),
+    signal: AbortSignal.timeout(3000),
+  }).catch(() => {});
+}