avo 3.2.9 → 3.2.11-alpha.0

package/README.md

@@ -2,7 +2,7 @@
 
 Better event tracking, **faster**.
 
-![https://www.avo.app](https://cdn.avo.app/assets/avo-cado.png)
+![https://www.avo.app](https://cdn.avo.app/assets/avo-find-fix-prevent.png)
 
 The Avo CLI gives you access to [Avo Codegen](https://www.avo.app/docs/implementation/devs-101) right from your command line. It allows you to pull [your Avo tracking plan](http://avo.app/schemas/default) as type-safe functions for each of your events, making analytics implementation quick and seamless. Avo Codegen supports a variety of [platforms, programming languages and destinations](https://www.avo.app/docs/implementation/supported-programming-languages). 
 
@@ -47,6 +47,6 @@ For more documentation, visit [https://www.avo.app/docs/implementation/cli](http
 
 **To create a release:**
 1. Verify that the changes in the _Unreleased_ section in CHANGELOG.md are accurate, create a new heading with the correct semantic version then move the content from the _Unreleased_ section there
-2. Udate the semantic version in `package.json` to match the one you just created in the changelog
+2. Update the semantic version in `package.json` to match the one you just created in the changelog
 3. Commit with the message `Release <version>` and push the changes
 4. Publish the package to npm (you'll need to be a maintainer of the avo project in npm): `npm publish`

package/cli.js

@@ -15,7 +15,6 @@ import pify from 'pify';
 import portfinder from 'portfinder';
 import querystring from 'querystring';
 import got from 'got'; // eslint-disable-line import/no-unresolved
-import report from 'yurnalist';
 import semver from 'semver';
 import updateNotifier from 'update-notifier';
 import url from 'url';
@@ -30,6 +29,7 @@ import yargs from 'yargs';
 import { hideBin } from 'yargs/helpers';
 import httpShutdown from 'http-shutdown';
 import fuzzypath from 'inquirer-fuzzy-path';
+import * as report from './reporter.js';
 import Avo from './Avo.js';
 const pkg = JSON.parse(fs.readFileSync(new URL('package.json', import.meta.url), 'utf-8'));
 /// //////////////////////////////////////////////////////////////////////
@@ -1035,7 +1035,7 @@ function findMatches(data, regex) {
     lastIndex += lines.length;
     return fileMatches;
 }
-function getEventMap(data) {
+function getEventMap(data, verbose) {
     const searchFor = 'AVOEVENTMAP:';
     const lines = data.split('\n').filter((line) => line.indexOf(searchFor) > -1);
     if (lines.length === 1) {
@@ -1044,9 +1044,12 @@ function getEventMap(data) {
         const eventMap = JSON.parse(line);
         return eventMap;
     }
+    if (verbose) {
+        report.error('No event map found');
+    }
     return null;
 }
-function getModuleMap(data) {
+function getModuleMap(data, verbose) {
     const searchFor = 'AVOMODULEMAP:';
     const lines = data.split('\n').filter((line) => line.indexOf(searchFor) > -1);
     if (lines.length === 1) {
@@ -1055,6 +1058,9 @@ function getModuleMap(data) {
         const moduleMap = JSON.parse(line);
         return moduleMap;
     }
+    if (verbose) {
+        report.error('No module map found');
+    }
     return null;
 }
 function getSource(argv, json) {
@@ -1090,21 +1096,30 @@ function status(source, json, argv) {
         follow: false,
     }).then((results) => Promise.all(results
         .filter((result) => !result.startsWith('.git'))
-        .map((resultPath) => pify(fs.lstat)(resultPath).then((stats) => {
+        .map((resultPath) => pify(fs.lstat)(resultPath)
+        .then((stats) => {
         if (stats.isSymbolicLink()) {
             return [];
         }
-        return pify(fs.readFile)(resultPath, 'utf8').then((data) => [
-            resultPath,
-            data,
-        ]);
+        return pify(fs.readFile)(resultPath, 'utf8')
+            .then((data) => [resultPath, data])
+            .catch(() => {
+            if (argv.verbose) {
+                report.warn(`Failed to parse file: ${resultPath}`);
+            }
+        });
+    })
+        .catch(() => {
+        if (argv.verbose) {
+            report.warn(`Failed to read file stats: ${resultPath}`);
+        }
     }))).then((cachePairs) => Object.fromEntries(cachePairs)));
     fileCache
         .then((cache) => {
         sources = Promise.all(sources.map((source) => pify(fs.readFile)(source.path, 'utf8').then((data) => {
-            const eventMap = getEventMap(data);
+            const eventMap = getEventMap(data, argv.verbose);
             if (eventMap !== null) {
-                const moduleMap = getModuleMap(data);
+                const moduleMap = getModuleMap(data, argv.verbose);
                 const sourcePath = path.parse(source.path);
                 const moduleName = source.analysis?.module ??
                     moduleMap ??
@@ -1148,13 +1163,19 @@ function status(source, json, argv) {
                         lookup[cachePath] = value;
                     }
                 });
+                if (argv.verbose) {
+                    const combinedPaths = [];
+                    Object.entries(lookup).forEach(([path, _data]) => {
+                        combinedPaths.push(path);
+                    });
+                    report.info(`Looking for events: ${eventMap.join('\n')}`);
+                    report.info(`Looking in module: ${moduleName}`);
+                    report.info(`Looking in files: ${combinedPaths.join('\n')}`);
+                }
                 return Promise.all(eventMap.map((eventName) => {
                     const re = new RegExp(`(${moduleName}\\.${eventName}|\\[${moduleName} ${eventName})`);
                     const results = Object.entries(lookup)
                         .map(([path, data]) => {
-                        if (argv.verbose) {
-                            report.info(`Looking for events in ${path}`);
-                        }
                         const results = findMatches(data, re);
                         return results.length ? [[path, results]] : [];
                     })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "avo",
-  "version": "3.2.9",
+  "version": "3.2.11-alpha.0",
   "type": "module",
   "description": "The command-line interface for Avo",
   "author": "Avo (https://www.avo.app)",
@@ -26,6 +26,7 @@
   },
   "files": [
     "cli.js",
+    "reporter.js",
     "Avo.js"
   ],
   "dependencies": {
@@ -51,8 +52,7 @@
     "uuid": "^9.0.0",
     "write": "^2.0.0",
     "write-json-file": "^5.0.0",
-    "yargs": "^17.2.1",
-    "yurnalist": "^2.1.0"
+    "yargs": "^17.2.1"
   },
   "devDependencies": {
     "@types/ignore-walk": "^4.0.0",

package/reporter.js

@@ -0,0 +1,28 @@
+import chalk from 'chalk';
+export function log(text) {
+    console.log(text);
+}
+export function info(text) {
+    console.log(chalk.blue('info'), text);
+}
+export function success(text) {
+    console.log(chalk.green('success'), text);
+}
+export function warn(text) {
+    console.log(chalk.yellow('warn'), text);
+}
+export function error(text) {
+    console.log(chalk.red('error'), text);
+}
+export function tree(text, children) {
+    function recursiveTree(name = '', nodes = [], prefix = '') {
+        nodes.sort((a, b) => a.name.localeCompare(b.name));
+        return `${name}\n${nodes
+            .map((node, index) => {
+            const last = index === nodes.length - 1;
+            return `${prefix}${last ? '└' : '├'}─ ${recursiveTree(node.name, node.children, `${prefix}${last ? ' ' : '│'}  `)}`;
+        })
+            .join('')}`;
+    }
+    console.log(recursiveTree(text, children));
+}