@zeroheight/adoption-cli 0.3.0 → 0.3.1

package/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Release notes
 
+## [0.3.1](https://www.npmjs.com/package/@zeroheight/adoption-cli/v/0.3.1) - 30th July 2024
+
+- Condense analyze output to be easier to parse
+- Output parsing errors into log file
+
 ## [0.3.0](https://www.npmjs.com/package/@zeroheight/adoption-cli/v/0.3.0) - 29th July 2024
 
 - Replace acorn parser with oxc-parser

package/dist/cli.js

@@ -10,7 +10,7 @@ const { output, cleanup } = render(React.createElement(HelpInfo, null));
 program
     .name("zh-adoption")
     .description("CLI for measuring design system usage usage in your products")
-    .version("0.2.13")
+    .version("0.3.1")
     .addHelpText("before", output)
     .addCommand(analyzeCommand())
     .addCommand(authCommand());

package/dist/commands/analyze.utils.d.ts

@@ -15,6 +15,6 @@ export interface ComponentUsageRecord {
  */
 export declare function findFiles(base: string, extensions: string, ignorePattern: string): Promise<string[]>;
 export declare function analyzeFiles(extensions: string, ignorePattern: string): Promise<{
-    errors: never[];
+    errorFile: string | null;
     usage: RawUsageMap;
 }>;

package/dist/commands/analyze.utils.js

@@ -51,6 +51,7 @@ export async function analyzeFiles(extensions, ignorePattern) {
     if (files.length === 0) {
         throw new Error("Can't find any relevant files");
     }
+    const parseErrors = [];
     const usageMap = new Map();
     for (const file of files) {
         try {
@@ -62,7 +63,15 @@ export async function analyzeFiles(extensions, ignorePattern) {
                 usageMap.set(relativePath, usage);
             }
         }
-        catch { }
+        catch {
+            parseErrors.push(`Can't parse file ${file}`);
+        }
+    }
+    const errorFile = `/tmp/zh-adoption-analyze-errors-${Date.now()}`;
+    if (parseErrors.length > 0) {
+        const file = fs.createWriteStream(errorFile);
+        parseErrors.forEach((err) => { file.write(err + '\n'); });
+        file.end();
     }
-    return { errors: [], usage: usageMap };
+    return { errorFile: parseErrors.length > 0 ? errorFile : null, usage: usageMap };
 }

package/dist/components/analyze/analyze.d.ts

@@ -2,7 +2,7 @@ import React from "react";
 import { RawUsageMap } from "../../commands/analyze.js";
 export interface AnalyzeProps {
     onAnalyzeFiles: () => Promise<{
-        errors: string[];
+        errorFile: string | null;
         usage: RawUsageMap;
     }>;
     dryRun: boolean;

package/dist/components/analyze/analyze.js

@@ -8,19 +8,23 @@ import Link from "ink-link";
 import NoCredentialsOnboarding from "../auth/no-credentials-onboarding.js";
 import { getZeroheightURL, submitUsageData } from "../../common/api.js";
 import RepoNamePrompt from "../repo-name-prompt.js";
+import ConfirmInput from "../ui/confirm-input.js";
 export default function Analyze({ onAnalyzeFiles, dryRun, repoName, }) {
     const { exit } = useApp();
     const [usageResult, setUsageResult] = React.useState(null);
     const [isSendingData, setIsSendingData] = React.useState(false);
     const [errorList, setErrorList] = React.useState([]);
+    const [errorFileLocation, setErrorFileLocation] = React.useState(null);
     const [credentials, setCredentials] = React.useState(null);
     const [resourceURL, setResourceURL] = React.useState(null);
     const [repo, setRepo] = React.useState(repoName);
     const [promptRepo, setPromptRepo] = React.useState(repoName === undefined);
+    const [showContinue, setShowContinue] = React.useState(false);
+    const [showMoreResults, setShowMoreResults] = React.useState("");
     React.useEffect(() => {
         onAnalyzeFiles()
-            .then(({ errors, usage }) => {
-            setErrorList((s) => [...s, ...errors]);
+            .then(({ errorFile, usage }) => {
+            setErrorFileLocation(errorFile);
             setUsageResult(usage);
         })
             .catch((e) => setErrorList((s) => [...s, e]));
@@ -70,6 +74,24 @@ export default function Analyze({ onAnalyzeFiles, dryRun, repoName, }) {
         });
         setPromptRepo(false);
     }
+    function handleShowMore(showMore) {
+        if (showMore) {
+            setShowMoreResults('true');
+        }
+        else {
+            setShowContinue(true);
+        }
+    }
+    function calculateNumberOfComponents() {
+        if (usageResult) {
+            const components = Array.from(usageResult.entries()).flatMap((comps) => comps[1]);
+            const componentCount = components.reduce((prev, next) => {
+                return prev + next.count;
+            }, 0);
+            return componentCount;
+        }
+        return 0;
+    }
     if (errorList.length > 0) {
         return (React.createElement(Box, { flexDirection: "column" },
             React.createElement(Text, { color: "red" }, "Error:"),
@@ -117,7 +139,27 @@ export default function Analyze({ onAnalyzeFiles, dryRun, repoName, }) {
                 " ",
                 React.createElement(Link, { url: resourceURL.toString() }, "usage data on zeroheight"))));
     }
-    if (usageResult && !promptRepo) {
+    if (usageResult && !promptRepo && !(showMoreResults === 'true' || showContinue)) {
+        return (React.createElement(Box, { flexDirection: "column" },
+            React.createElement(Text, { color: "green" },
+                calculateNumberOfComponents(),
+                " components found"),
+            errorFileLocation && (React.createElement(React.Fragment, null,
+                React.createElement(Newline, null),
+                React.createElement(Box, null,
+                    React.createElement(Text, { color: "red" }, "Error:"),
+                    React.createElement(Text, null,
+                        ' ',
+                        "Some files could not be parsed. Errors can be found at ",
+                        React.createElement(Link, { url: errorFileLocation }, errorFileLocation))))),
+            React.createElement(Box, null,
+                React.createElement(Text, null,
+                    "Show more details?",
+                    " ",
+                    React.createElement(Text, { dimColor: true }, "(y/N)")),
+                React.createElement(ConfirmInput, { isChecked: false, value: showMoreResults, onChange: setShowMoreResults, onSubmit: handleShowMore }))));
+    }
+    if (usageResult && !promptRepo && showMoreResults === 'true') {
         return (React.createElement(Box, { flexDirection: "column" },
             React.createElement(UsageTable, { usage: usageResult }),
             dryRun && (React.createElement(React.Fragment, null,
@@ -129,6 +171,17 @@ export default function Analyze({ onAnalyzeFiles, dryRun, repoName, }) {
                 React.createElement(Newline, null))),
             !dryRun && React.createElement(ContinuePrompt, { onContinue: handleContinue })));
     }
+    if (usageResult && !promptRepo && showContinue) {
+        return (React.createElement(Box, { flexDirection: "column" },
+            dryRun && (React.createElement(React.Fragment, null,
+                React.createElement(Newline, null),
+                React.createElement(Text, null,
+                    "Nothing sent to zeroheight, if you want to track component usage data then remove the ",
+                    React.createElement(Text, { italic: true }, "--dry-run"),
+                    " option."),
+                React.createElement(Newline, null))),
+            !dryRun && React.createElement(ContinuePrompt, { onContinue: handleContinue })));
+    }
     if (promptRepo) {
         return (React.createElement(RepoNamePrompt, { credentials: credentials, onRepoNameSelected: handleOnRepoNameSelected }));
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zeroheight/adoption-cli",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "license": "ISC",
   "main": "dist/cli.js",
   "bin": {