@eventra_dev/eventra-cli 0.0.5 → 0.0.7

package/.github/workflows/release.yml

@@ -33,6 +33,9 @@ jobs:
       - name: Build CLI
         run: pnpm build
 
+      - name: Run tests
+        run: pnpm test
+
       - name: Publish to npm
         run: npm publish --access public
         env:

package/README.md

@@ -7,6 +7,8 @@
 [![npm version](https://img.shields.io/npm/v/@eventra_dev/eventra-cli.svg)](https://www.npmjs.com/package/@eventra_dev/eventra-cli)
 [![npm downloads](https://img.shields.io/npm/dm/@eventra_dev/eventra-cli.svg)](https://www.npmjs.com/package/@eventra_dev/eventra-cli)
 [![TypeScript](https://img.shields.io/badge/typescript-ready-blue.svg)](https://www.typescriptlang.org/)
+[![Tests](https://github.com/and-1991/eventra-cli/actions/workflows/release.yml/badge.svg)]()
+[![License](https://img.shields.io/npm/l/@eventra_dev/eventra-cli)]()
 
 Eventra CLI automatically discovers feature usage events in your codebase and syncs them with Eventra.
 

package/dist/commands/init.js

@@ -5,31 +5,97 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.init = init;
 const chalk_1 = __importDefault(require("chalk"));
-const fs_extra_1 = __importDefault(require("fs-extra"));
-const path_1 = __importDefault(require("path"));
 const inquirer_1 = __importDefault(require("inquirer"));
 const config_1 = require("../utils/config");
 async function init() {
     console.log(chalk_1.default.blue("Initializing Eventra..."));
-    const configPath = path_1.default.join(process.cwd(), config_1.CONFIG_NAME);
-    if (await fs_extra_1.default.pathExists(configPath)) {
-        console.log(chalk_1.default.yellow("eventra.json already exists"));
-        return;
-    }
-    const answers = await inquirer_1.default.prompt([
+    // API KEY
+    const { apiKey } = await inquirer_1.default.prompt([
         {
             type: "input",
             name: "apiKey",
             message: "API Key (optional):"
         }
     ]);
+    console.log(chalk_1.default.gray("\nEventra automatically detects:"));
+    console.log(chalk_1.default.gray("• track('event')"));
+    console.log(chalk_1.default.gray("• tracker.track('event')"));
+    const wrappers = [];
+    const functionWrappers = [];
+    // COMPONENT WRAPPERS
+    console.log(chalk_1.default.blue("\nComponent wrappers"));
+    let addComponent = true;
+    while (addComponent) {
+        const { useWrapper } = await inquirer_1.default.prompt([
+            {
+                type: "confirm",
+                name: "useWrapper",
+                message: "Add component wrapper?",
+                default: false
+            }
+        ]);
+        if (!useWrapper)
+            break;
+        const { name, prop } = await inquirer_1.default.prompt([
+            {
+                type: "input",
+                name: "name",
+                message: "Component name:",
+                validate: (v) => v ? true : "Required"
+            },
+            {
+                type: "input",
+                name: "prop",
+                message: "Event prop:",
+                default: "event"
+            }
+        ]);
+        wrappers.push({
+            name,
+            prop
+        });
+    }
+    // FUNCTION WRAPPERS
+    console.log(chalk_1.default.blue("\nFunction wrappers"));
+    let addFunction = true;
+    while (addFunction) {
+        const { useWrapper } = await inquirer_1.default.prompt([
+            {
+                type: "confirm",
+                name: "useWrapper",
+                message: "Add function wrapper?",
+                default: false
+            }
+        ]);
+        if (!useWrapper)
+            break;
+        const { name, event } = await inquirer_1.default.prompt([
+            {
+                type: "input",
+                name: "name",
+                message: "Function name:"
+            },
+            {
+                type: "input",
+                name: "event",
+                message: "Event field (leave empty if string argument):",
+                default: ""
+            }
+        ]);
+        functionWrappers.push({
+            name,
+            event: event || undefined
+        });
+    }
     const config = {
-        apiKey: answers.apiKey || "",
+        apiKey,
         events: [],
-        wrappers: [],
-        functionWrappers: [],
+        wrappers,
+        functionWrappers,
         sync: {
-            include: ["**/*.{ts,tsx,js,jsx}"],
+            include: [
+                "**/*.{ts,tsx,js,jsx,vue,svelte,astro}"
+            ],
             exclude: [
                 "node_modules",
                 "dist",
@@ -39,5 +105,6 @@ async function init() {
         }
     };
     await (0, config_1.saveConfig)(config);
-    console.log(chalk_1.default.green("eventra.json created"));
+    console.log(chalk_1.default.green("\neventra.json created"));
+    console.log(chalk_1.default.gray("\nRun `eventra sync`"));
 }

package/dist/commands/sync.js

@@ -28,6 +28,13 @@ async function sync() {
     const files = await (0, fast_glob_1.default)(config.sync.include, {
         ignore: config.sync.exclude
     });
+    const functionWrappers = (config.functionWrappers ?? []).map((w) => ({
+        name: w.name,
+        path: w.event
+            ? `0.${w.event}`
+            : "0"
+    }));
+    const componentWrappers = config.wrappers ?? [];
     for (const file of files) {
         const parser = (0, router_1.detectParser)(file);
         let content = await promises_1.default.readFile(file, "utf-8");
@@ -37,10 +44,13 @@ async function sync() {
             content = (0, svelte_1.parseSvelte)(content);
         if (parser === "astro")
             content = (0, astro_1.parseAstro)(content);
-        const source = project.createSourceFile(file, content, { overwrite: true });
+        const virtualFile = parser === "ts"
+            ? file
+            : file + ".tsx";
+        const source = project.createSourceFile(virtualFile, content, { overwrite: true });
         (0, track_1.scanTrack)(source).forEach((e) => events.add(e));
-        (0, function_wrappers_1.scanFunctionWrappers)(source, config.functionWrappers ?? []).forEach((e) => events.add(e));
-        (0, component_wrappers_1.scanComponentWrappers)(source, config.wrappers ?? []).forEach((e) => events.add(e));
+        (0, function_wrappers_1.scanFunctionWrappers)(source, functionWrappers).forEach((e) => events.add(e));
+        (0, component_wrappers_1.scanComponentWrappers)(source, componentWrappers).forEach((e) => events.add(e));
     }
     const list = [...events].sort();
     config.events = list;

package/dist/utils/config.js

@@ -18,7 +18,7 @@ function normalizeConfig(config) {
         functionWrappers: config.functionWrappers ?? [],
         sync: config.sync ?? {
             include: [
-                "**/*.{ts,tsx,js,jsx}"
+                "**/*.{ts,tsx,js,jsx,vue,svelte,astro}"
             ],
             exclude: [
                 "node_modules",

package/dist/utils/extract.js

@@ -7,23 +7,38 @@ function extractEvent(call, path) {
     let node = call.getArguments()[Number(parts[0])];
     if (!node)
         return null;
+    node = unwrap(node);
     for (let i = 1; i < parts.length; i++) {
-        if (ts_morph_1.Node.isObjectLiteralExpression(node)) {
-            const obj = node;
-            const prop = obj.getProperty(parts[i]);
-            if (!prop)
-                return null;
-            if (ts_morph_1.Node.isPropertyAssignment(prop)) {
-                const initializer = prop.getInitializer();
-                if (!initializer)
-                    return null;
-                node = initializer;
-            }
+        if (!ts_morph_1.Node.isObjectLiteralExpression(node)) {
+            return null;
         }
+        const obj = node;
+        const prop = obj.getProperty(parts[i]);
+        if (!prop)
+            return null;
+        if (!ts_morph_1.Node.isPropertyAssignment(prop)) {
+            return null;
+        }
+        const initializer = prop.getInitializer();
+        if (!initializer)
+            return null;
+        node = unwrap(initializer);
     }
-    if (node &&
-        ts_morph_1.Node.isStringLiteral(node)) {
+    if (ts_morph_1.Node.isStringLiteral(node)) {
         return node.getLiteralText();
     }
+    if (node.getKind() ===
+        ts_morph_1.SyntaxKind.NoSubstitutionTemplateLiteral) {
+        return node
+            .getText()
+            .replace(/`/g, "");
+    }
     return null;
 }
+function unwrap(node) {
+    let current = node;
+    while (ts_morph_1.Node.isParenthesizedExpression(current)) {
+        current = current.getExpression();
+    }
+    return current;
+}

package/dist/utils/parsers/vue.js

@@ -4,7 +4,15 @@ exports.parseVue = parseVue;
 function parseVue(content) {
     const template = content.match(/<template[\s\S]*?>([\s\S]*?)<\/template>/);
     const script = content.match(/<script[\s\S]*?>([\s\S]*?)<\/script>/);
-    return ((template?.[1] ?? "") +
-        "\n" +
-        (script?.[1] ?? ""));
+    return `
+${script?.[1] ?? ""}
+
+function __vue_template__() {
+  return (
+    <>
+      ${template?.[1] ?? ""}
+    </>
+  );
+}
+`;
 }

package/dist/utils/scanners/component-wrappers.js

@@ -32,13 +32,11 @@ function scanComponentWrappers(source, wrappers) {
                 const init = attrNode.getInitializer();
                 if (!init)
                     continue;
-                // event="signup"
                 if (init.getKind() ===
                     ts_morph_1.SyntaxKind.StringLiteral) {
                     const value = init.asKindOrThrow(ts_morph_1.SyntaxKind.StringLiteral);
                     events.add(value.getLiteralText());
                 }
-                // event={"signup"}
                 if (init.getKind() ===
                     ts_morph_1.SyntaxKind.JsxExpression) {
                     const expr = init

package/dist/utils/scanners/function-wrappers.js

@@ -7,29 +7,65 @@ function scanFunctionWrappers(source, wrappers) {
     const events = new Set();
     const calls = source.getDescendantsOfKind(ts_morph_1.SyntaxKind.CallExpression);
     for (const call of calls) {
-        const expression = call.getExpression();
-        let name = null;
-        // trackFeature()
-        if (expression.getKind() ===
-            ts_morph_1.SyntaxKind.Identifier) {
-            name =
-                expression.getText();
-        }
-        // analytics.trackFeature()
-        if (expression.getKind() ===
-            ts_morph_1.SyntaxKind.PropertyAccessExpression) {
-            const prop = expression.asKindOrThrow(ts_morph_1.SyntaxKind.PropertyAccessExpression);
-            name = prop.getName();
-        }
+        const name = getFunctionName(call);
         if (!name)
             continue;
         for (const wrapper of wrappers) {
-            if (name !== wrapper.name)
+            if (wrapper.name !== name)
                 continue;
-            const event = (0, extract_1.extractEvent)(call, wrapper.path);
+            const event = extractEventFromArgs(call, wrapper.event);
             if (event)
                 events.add(event);
         }
     }
     return events;
 }
+function getFunctionName(call) {
+    const expression = call.getExpression();
+    // trackFeature()
+    if (ts_morph_1.Node.isIdentifier(expression)) {
+        return expression.getText();
+    }
+    // analytics.trackFeature()
+    if (ts_morph_1.Node.isPropertyAccessExpression(expression)) {
+        return getDeepName(expression);
+    }
+    return null;
+}
+function getDeepName(node) {
+    let current = node;
+    let name = "";
+    while (ts_morph_1.Node.isPropertyAccessExpression(current)) {
+        name =
+            current.getName();
+        current =
+            current.getExpression();
+    }
+    return name;
+}
+function extractEventFromArgs(call, event) {
+    const args = call.getArguments();
+    for (let i = 0; i < args.length; i++) {
+        const arg = args[i];
+        // string case
+        if (!event) {
+            if (ts_morph_1.Node.isStringLiteral(arg)) {
+                return arg.getLiteralText();
+            }
+            // template literal
+            if (arg.getKind() ===
+                ts_morph_1.SyntaxKind.NoSubstitutionTemplateLiteral) {
+                return arg
+                    .getText()
+                    .replace(/`/g, "");
+            }
+        }
+        // object case
+        if (event) {
+            const result = (0, extract_1.extractEvent)(call, `${i}.${event}`);
+            if (result)
+                return result;
+        }
+    }
+    return null;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eventra_dev/eventra-cli",
-  "version": "0.0.5",
+  "version": "0.0.7",
   "description": "Eventra CLI",
   "type": "commonjs",
   "bin": {
@@ -15,7 +15,8 @@
   "license": "MIT",
   "scripts": {
     "build": "tsc",
-    "dev": "tsx src/index.ts"
+    "dev": "tsx src/index.ts",
+    "test": "tsx tests/run.ts"
   },
   "dependencies": {
     "chalk": "^4.1.2",
@@ -29,6 +30,7 @@
     "@types/fs-extra": "^11.0.4",
     "@types/inquirer": "^9.0.9",
     "@types/node": "^20.0.0",
+    "cross-spawn": "^7.0.6",
     "tsx": "^4.7.0",
     "typescript": "^5.3.0"
   }

package/src/commands/init.ts

@@ -1,47 +1,147 @@
 import chalk from "chalk";
-import fs from "fs-extra";
-import path from "path";
 import inquirer from "inquirer";
-import {
-  CONFIG_NAME,
-  saveConfig
-} from "../utils/config";
+
+import { saveConfig } from "../utils/config";
+import {ComponentWrapper, FunctionWrapper} from "../types";
 
 export async function init() {
   console.log(
     chalk.blue("Initializing Eventra...")
   );
 
-  const configPath = path.join(
-    process.cwd(),
-    CONFIG_NAME
+  // API KEY
+  const { apiKey } =
+    await inquirer.prompt([
+      {
+        type: "input",
+        name: "apiKey",
+        message:
+          "API Key (optional):"
+      }
+    ]);
+
+  console.log(
+    chalk.gray(
+      "\nEventra automatically detects:"
+    )
+  );
+
+  console.log(
+    chalk.gray("• track('event')")
+  );
+
+  console.log(
+    chalk.gray(
+      "• tracker.track('event')"
+    )
   );
 
-  if (await fs.pathExists(configPath)) {
-    console.log(
-      chalk.yellow(
-        "eventra.json already exists"
-      )
-    );
-    return;
+  const wrappers: ComponentWrapper[] = [];
+  const functionWrappers: FunctionWrapper[] = [];
+
+
+  // COMPONENT WRAPPERS
+  console.log(
+    chalk.blue(
+      "\nComponent wrappers"
+    )
+  );
+
+  let addComponent = true;
+
+  while (addComponent) {
+    const { useWrapper } =
+      await inquirer.prompt([
+        {
+          type: "confirm",
+          name: "useWrapper",
+          message:
+            "Add component wrapper?",
+          default: false
+        }
+      ]);
+
+    if (!useWrapper) break;
+
+    const { name, prop } =
+      await inquirer.prompt([
+        {
+          type: "input",
+          name: "name",
+          message: "Component name:",
+          validate: (v) =>
+            v ? true : "Required"
+        },
+        {
+          type: "input",
+          name: "prop",
+          message:
+            "Event prop:",
+          default: "event"
+        }
+      ]);
+
+    wrappers.push({
+      name,
+      prop
+    });
   }
 
-  const answers = await inquirer.prompt([
-    {
-      type: "input",
-      name: "apiKey",
-      message:
-        "API Key (optional):"
-    }
-  ]);
+  // FUNCTION WRAPPERS
+  console.log(
+    chalk.blue(
+      "\nFunction wrappers"
+    )
+  );
+
+  let addFunction = true;
+
+  while (addFunction) {
+    const { useWrapper } =
+      await inquirer.prompt([
+        {
+          type: "confirm",
+          name: "useWrapper",
+          message:
+            "Add function wrapper?",
+          default: false
+        }
+      ]);
+
+    if (!useWrapper) break;
+
+    const { name, event } =
+      await inquirer.prompt([
+        {
+          type: "input",
+          name: "name",
+          message:
+            "Function name:"
+        },
+        {
+          type: "input",
+          name: "event",
+          message:
+            "Event field (leave empty if string argument):",
+          default: ""
+        }
+      ]);
+
+    functionWrappers.push({
+      name,
+      event: event || undefined
+    });
+  }
 
   const config = {
-    apiKey: answers.apiKey || "",
+    apiKey,
     events: [],
-    wrappers: [],
-    functionWrappers: [],
+    wrappers,
+    functionWrappers,
     sync: {
-      include: ["**/*.{ts,tsx,js,jsx}"],
+      include: [
+        "**/*.{ts,tsx,js,jsx,vue,svelte,astro}"
+      ],
       exclude: [
         "node_modules",
         "dist",
@@ -55,7 +155,13 @@ export async function init() {
 
   console.log(
     chalk.green(
-      "eventra.json created"
+      "\neventra.json created"
+    )
+  );
+
+  console.log(
+    chalk.gray(
+      "\nRun `eventra sync`"
     )
   );
 }

package/src/commands/sync.ts

@@ -41,6 +41,18 @@ export async function sync() {
     }
   );
 
+  const functionWrappers =
+    (config.functionWrappers ?? []).map(
+      (w) => ({
+        name: w.name,
+        path: w.event
+          ? `0.${w.event}`
+          : "0"
+      })
+    );
+  const componentWrappers =
+    config.wrappers ?? [];
+
   for (const file of files) {
     const parser =
       detectParser(file);
@@ -60,9 +72,14 @@ export async function sync() {
     if (parser === "astro")
       content = parseAstro(content);
 
+    const virtualFile =
+      parser === "ts"
+        ? file
+        : file + ".tsx";
+
     const source =
       project.createSourceFile(
-        file,
+        virtualFile,
         content,
         { overwrite: true }
       );
@@ -71,16 +88,17 @@ export async function sync() {
       (e) => events.add(e)
     );
 
+
     scanFunctionWrappers(
       source,
-      config.functionWrappers ?? []
+      functionWrappers
     ).forEach((e) =>
       events.add(e)
     );
 
     scanComponentWrappers(
       source,
-      config.wrappers ?? []
+      componentWrappers
     ).forEach((e) =>
       events.add(e)
     );

package/src/types.ts

@@ -5,7 +5,7 @@ export type ComponentWrapper = {
 
 export type FunctionWrapper = {
   name: string;
-  path: string;
+  event?: string;
 };
 
 export type EventraConfig = {

package/src/utils/config.ts

@@ -15,7 +15,7 @@ export function normalizeConfig(
       config.functionWrappers ?? [],
     sync: config.sync ?? {
       include: [
-        "**/*.{ts,tsx,js,jsx}"
+        "**/*.{ts,tsx,js,jsx,vue,svelte,astro}"
       ],
       exclude: [
         "node_modules",