@zeroheight/adoption-cli 0.3.1 → 0.4.1

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Release notes
 
+## [0.4.1](https://www.npmjs.com/package/@zeroheight/adoption-cli/v/0.4.1) - 9th August 2024
+
+- Update README
+- Fix Changelog links
+
+## [0.4.0](https://www.npmjs.com/package/@zeroheight/adoption-cli/v/0.4.0) - 2nd August 2024
+
+- Allow `--interactive false` option for `analyze` command to better sipport CI
+
 ## [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

package/README.md

@@ -14,22 +14,67 @@ npm i @zeroheight/adoption-cli
 
 In the repository in which you wish to analyze the component usage, run the following command:
 
-```
+```bash
 zh-adoption analyze
 ```
 
-You are able to limit the file extensions to include when searching for components by using `-e, --extensions [ext]` with a glob pattern to determine file extensions.
+### Options
+
+`-e` / `--extensions`
+
+Provide a glob pattern to search for files with a specific extension.
+
+```bash
+zh-adoption analyze -e "**/*.{js,jsx,ts,tsx}"
+```
+
+`-i` / `--ignore`
 
-You are able to state files to ignore when searching for components by using `-i, --ignore [ext]` with a glob pattern to determine ignored files.
+Provide a glob pattern to ignore files, directories or file extensions when searching for components.
+
+```bash
+zh-adoption analyze -i "**/*.{test,spec}.*"
+```
+
+`-r` / `--repo-name`
+
+Provide a name for the current repository. This must be passed when `-in` / `--interactive` is set to `false`.
+
+```bash
+zh-adoption analyze -r "My Repo"
+```
+
+`-in` / `--interactive`
+
+Pass in `false` to disable the interactive mode e.g. when running in a CI environment.
+
+```bash
+zh-adoption analyze --interactive false -r "My Repo"
+```
 
 ---
 
-To send adoption data to your [zeroheight](https://zeroheight.com/) account you will need to authenticate. This can be done as part of the `analyze` flow or separately by running:
+To send adoption data to your [zeroheight](https://zeroheight.com/) account you will need to authenticate using a Client ID and Access Token.
+
+### Interactive mode
+
+When running the `analyze` command, you will be prompted to authenticate. This will save the Client ID and Access Token to your local machine.
+
+Alternatively, you can authenticate by running the following command:
 
 ```
 zh-adoption auth
 ```
 
+### Non-interactive mode
+
+When running the `analyze` command with the `--interactive false` flag, you will need to provide the Client ID and Access Token as environment variables.
+
+```bash
+export ZEROHEIGHT_CLIENT_ID="your-client-id"
+export ZEROHEIGHT_ACCESS_TOKEN="your-access-token"
+```
+
 ---
 
 More info on the commands can be seen by running

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.3.1")
+    .version("0.4.0")
     .addHelpText("before", output)
     .addCommand(analyzeCommand())
     .addCommand(authCommand());

package/dist/commands/analyze.d.ts

@@ -6,6 +6,7 @@ interface AnalyzeOptions {
     ignore: string;
     dryRun: boolean;
     repoName?: string;
+    interactive: boolean;
 }
 export type RawUsageMap = Map<string, RawUsage[]>;
 export declare function analyzeAction(options: AnalyzeOptions, renderOptions?: RenderOptions): Promise<void>;

package/dist/commands/analyze.js

@@ -1,10 +1,17 @@
 import React from "react";
 import { render } from "ink";
 import { Command, Option } from "commander";
-import Analyze from "../components/analyze/analyze.js";
+import yn from "yn";
 import { analyzeFiles } from "./analyze.utils.js";
+import Analyze from "../components/analyze/analyze.js";
+import NonInteractiveAnalyze from "../components/analyze/non-interactive-analyze.js";
 export async function analyzeAction(options, renderOptions) {
-    render(React.createElement(Analyze, { onAnalyzeFiles: () => analyzeFiles(options.extensions, options.ignore), dryRun: options.dryRun, repoName: options.repoName }), renderOptions);
+    if (options.interactive) {
+        render(React.createElement(Analyze, { dryRun: options.dryRun, onAnalyzeFiles: () => analyzeFiles(options.extensions, options.ignore), repoName: options.repoName }), renderOptions);
+    }
+    else {
+        render(React.createElement(NonInteractiveAnalyze, { repoName: options.repoName, onAnalyzeFiles: () => analyzeFiles(options.extensions, options.ignore) }));
+    }
 }
 export function analyzeCommand() {
     const command = new Command();
@@ -15,6 +22,9 @@ export function analyzeCommand() {
         .addOption(new Option("-i, --ignore [ext]", "files to ignore when searching for components").default("**/*.{test,spec}.*", "glob pattern to determine ignored files"))
         .addOption(new Option("-d, --dry-run", "don't push results to zeroheight").default(false))
         .addOption(new Option("-r, --repo-name <string>", "name of the repository"))
+        .addOption(new Option("-in, --interactive [boolean]", "disable to skip input (useful when running in CI)")
+        .default(true)
+        .argParser((value) => yn(value)))
         .action(async (options) => {
         try {
             await analyzeAction(options);

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

@@ -18,3 +18,4 @@ export declare function analyzeFiles(extensions: string, ignorePattern: string):
     errorFile: string | null;
     usage: RawUsageMap;
 }>;
+export declare function calculateNumberOfComponents(usageResult: RawUsageMap): number;

package/dist/commands/analyze.utils.js

@@ -70,8 +70,23 @@ export async function analyzeFiles(extensions, ignorePattern) {
     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'); });
+        parseErrors.forEach((err) => {
+            file.write(err + "\n");
+        });
         file.end();
     }
-    return { errorFile: parseErrors.length > 0 ? errorFile : null, usage: usageMap };
+    return {
+        errorFile: parseErrors.length > 0 ? errorFile : null,
+        usage: usageMap,
+    };
+}
+export function calculateNumberOfComponents(usageResult) {
+    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;
 }

package/dist/components/analyze/analyze.js

@@ -1,14 +1,15 @@
 import React from "react";
 import Spinner from "ink-spinner";
 import { Box, Newline, Text, useApp } from "ink";
-import { configPath, writeConfig, readConfig, } from "../../common/config.js";
-import UsageTable from "../usage-table.js";
-import ContinuePrompt from "../ui/continue-prompt.js";
 import Link from "ink-link";
+import ConfirmInput from "../ui/confirm-input.js";
+import ContinuePrompt from "../ui/continue-prompt.js";
 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";
+import UsageTable from "../usage-table.js";
+import { configPath, writeConfig, readConfig, } from "../../common/config.js";
+import { getZeroheightURL, submitUsageData } from "../../common/api.js";
+import { calculateNumberOfComponents } from "../../commands/analyze.utils.js";
 export default function Analyze({ onAnalyzeFiles, dryRun, repoName, }) {
     const { exit } = useApp();
     const [usageResult, setUsageResult] = React.useState(null);
@@ -22,20 +23,46 @@ export default function Analyze({ onAnalyzeFiles, dryRun, repoName, }) {
     const [showContinue, setShowContinue] = React.useState(false);
     const [showMoreResults, setShowMoreResults] = React.useState("");
     React.useEffect(() => {
-        onAnalyzeFiles()
-            .then(({ errorFile, usage }) => {
-            setErrorFileLocation(errorFile);
-            setUsageResult(usage);
-        })
-            .catch((e) => setErrorList((s) => [...s, e]));
-        if (!dryRun) {
-            readConfig().then((config) => {
+        (async () => {
+            try {
+                const { errorFile, usage } = await onAnalyzeFiles();
+                setErrorFileLocation(errorFile);
+                setUsageResult(usage);
+            }
+            catch (e) {
+                setErrorList((s) => [...s, e]);
+            }
+            if (dryRun)
+                return;
+            try {
+                const config = await readConfig();
                 if (config) {
                     setCredentials({ token: config.token, client: config.client });
                 }
-            });
-        }
+            }
+            catch (e) {
+                setErrorList((s) => [...s, "Failed to load credentials"]);
+            }
+        })();
     }, []);
+    async function sendData(result, repoName, credentials) {
+        setIsSendingData(true);
+        try {
+            await submitUsageData(result, repoName, credentials);
+            const resourceURL = getZeroheightURL();
+            resourceURL.pathname = "/adoption/";
+            setResourceURL(resourceURL);
+        }
+        catch (e) {
+            const errorMessage = e.message === "Unauthorized"
+                ? "Unauthorized. Please reset your authentication by running: zh-adoption auth"
+                : "Failed to send data to zeroheight";
+            setErrorList((s) => [...s, errorMessage]);
+        }
+        finally {
+            setIsSendingData(false);
+        }
+    }
     async function handleContinue(shouldContinue) {
         if (shouldContinue) {
             if (!dryRun && credentials && usageResult && !repo) {
@@ -43,22 +70,7 @@ export default function Analyze({ onAnalyzeFiles, dryRun, repoName, }) {
                 setRepo("");
             }
             else if (!dryRun && credentials && usageResult && repo) {
-                setIsSendingData(true);
-                try {
-                    await submitUsageData(usageResult, repo, credentials);
-                    const resourceURL = getZeroheightURL();
-                    resourceURL.pathname = "/adoption/";
-                    setResourceURL(resourceURL);
-                }
-                catch (e) {
-                    const errorMessage = e.message === "Unauthorized"
-                        ? "Unauthorized. Please reset your authentication by running: zh-adoption auth"
-                        : "Failed to send data to zeroheight";
-                    setErrorList((s) => [...s, errorMessage]);
-                }
-                finally {
-                    setIsSendingData(false);
-                }
+                sendData(usageResult, repo, credentials);
             }
         }
         else {
@@ -76,22 +88,12 @@ export default function Analyze({ onAnalyzeFiles, dryRun, repoName, }) {
     }
     function handleShowMore(showMore) {
         if (showMore) {
-            setShowMoreResults('true');
+            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:"),
@@ -99,7 +101,7 @@ export default function Analyze({ onAnalyzeFiles, dryRun, repoName, }) {
                 "- ",
                 e))))));
     }
-    if (!credentials && !dryRun) {
+    if (!promptRepo && !credentials && !dryRun) {
         return (React.createElement(NoCredentialsOnboarding, { configPath: configPath(), onSaveCredentials: async (persist, newClient, newToken) => {
                 const newCredentials = { token: newToken, client: newClient };
                 setCredentials(newCredentials);
@@ -139,27 +141,29 @@ export default function Analyze({ onAnalyzeFiles, dryRun, repoName, }) {
                 " ",
                 React.createElement(Link, { url: resourceURL.toString() }, "usage data on zeroheight"))));
     }
-    if (usageResult && !promptRepo && !(showMoreResults === 'true' || showContinue)) {
+    if (usageResult &&
+        !promptRepo &&
+        !(showMoreResults === "true" || showContinue)) {
         return (React.createElement(Box, { flexDirection: "column" },
             React.createElement(Text, { color: "green" },
-                calculateNumberOfComponents(),
+                calculateNumberOfComponents(usageResult),
                 " 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 ",
+                        " ",
+                        "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?",
-                    " ",
+                    "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') {
+    if (usageResult && !promptRepo && showMoreResults === "true") {
         return (React.createElement(Box, { flexDirection: "column" },
             React.createElement(UsageTable, { usage: usageResult }),
             dryRun && (React.createElement(React.Fragment, null,
@@ -185,5 +189,5 @@ export default function Analyze({ onAnalyzeFiles, dryRun, repoName, }) {
     if (promptRepo) {
         return (React.createElement(RepoNamePrompt, { credentials: credentials, onRepoNameSelected: handleOnRepoNameSelected }));
     }
-    return React.createElement(Text, null, "NOPE");
+    return React.createElement(Text, null, "Done");
 }

package/dist/components/analyze/non-interactive-analyze.d.ts

@@ -0,0 +1,10 @@
+import React from "react";
+import { RawUsageMap } from "../../commands/analyze.js";
+export interface NonInteractiveAnalyzeProps {
+    onAnalyzeFiles: () => Promise<{
+        errorFile: string | null;
+        usage: RawUsageMap;
+    }>;
+    repoName?: string;
+}
+export default function NonInteractiveAnalyze({ repoName, onAnalyzeFiles, }: NonInteractiveAnalyzeProps): React.JSX.Element;

package/dist/components/analyze/non-interactive-analyze.js

@@ -0,0 +1,124 @@
+import React from "react";
+import { Box, Newline, Text } from "ink";
+import Spinner from "ink-spinner";
+import Link from "ink-link";
+import { calculateNumberOfComponents } from "../../commands/analyze.utils.js";
+import { readConfig } from "../../common/config.js";
+import { submitUsageData } from "../../common/api.js";
+export default function NonInteractiveAnalyze({ repoName, onAnalyzeFiles, }) {
+    const [isSendingData, setIsSendingData] = React.useState(false);
+    const [isAnalyzingFiles, setIsAnalyzingFiles] = React.useState(false);
+    const [isFetchingCredentials, setIsFetchingCredentials] = React.useState(false);
+    const [errorFileLocation, setErrorFileLocation] = React.useState(null);
+    const [errorList, setErrorList] = React.useState([]);
+    const [credentials, setCredentials] = React.useState(null);
+    const [usage, setUsage] = React.useState(null);
+    async function loadCredentials() {
+        setIsFetchingCredentials(true);
+        try {
+            const config = await readConfig();
+            if (config) {
+                setCredentials({ token: config.token, client: config.client });
+            }
+            return config;
+        }
+        catch (e) {
+            setErrorList((s) => [...s, "Failed to load credentials"]);
+        }
+        finally {
+            setIsFetchingCredentials(false);
+        }
+        return null;
+    }
+    async function sendData(result, repoName, credentials) {
+        setIsSendingData(true);
+        try {
+            await submitUsageData(result, repoName, credentials);
+        }
+        catch (e) {
+            const errorMessage = e.message === "Unauthorized"
+                ? "Unauthorized. Please reset your authentication by running: zh-adoption auth"
+                : "Failed to send data to zeroheight";
+            setErrorList((s) => [...s, errorMessage]);
+        }
+        finally {
+            setIsSendingData(false);
+        }
+    }
+    async function anaylzeUsage() {
+        setIsAnalyzingFiles(true);
+        const { errorFile, usage } = await onAnalyzeFiles();
+        setUsage(usage);
+        if (errorFile) {
+            setErrorFileLocation(errorFile);
+        }
+        setIsAnalyzingFiles(false);
+        return usage;
+    }
+    React.useEffect(() => {
+        (async () => {
+            const credentials = await loadCredentials();
+            if (!credentials)
+                return;
+            const usage = await anaylzeUsage();
+            if (!repoName)
+                return;
+            await sendData(usage, repoName, credentials);
+        })();
+    }, []);
+    if (isAnalyzingFiles || isFetchingCredentials || isSendingData) {
+        return (React.createElement(Text, null,
+            React.createElement(Spinner, { type: "dots" }),
+            isAnalyzingFiles && React.createElement(Text, null, "Analyzing components"),
+            isFetchingCredentials && React.createElement(Text, null, "Loading credentials"),
+            isSendingData && React.createElement(Text, null, "Sending data to zerohegiht")));
+    }
+    if (errorList.length > 0) {
+        return (React.createElement(Box, { flexDirection: "column" },
+            React.createElement(Text, { color: "red" }, "Error:"),
+            React.createElement(Box, { flexDirection: "column", marginLeft: 1 }, errorList.map((e) => (React.createElement(Text, { key: e },
+                "- ",
+                e))))));
+    }
+    if (errorFileLocation) {
+        return (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)))));
+    }
+    if (!repoName) {
+        return (React.createElement(Text, null,
+            React.createElement(Text, { bold: true }, "Repo name"),
+            " not found, run the ",
+            React.createElement(Text, { bold: true }, "analyze"),
+            " ",
+            "command in interactive mode or provide the",
+            " ",
+            React.createElement(Text, { italic: true },
+                "--repo-name ",
+                "<my repo name>"),
+            " option"));
+    }
+    if (!credentials) {
+        return (React.createElement(Text, null,
+            "Credentials not found, please ensure they are set before running the",
+            " ",
+            React.createElement(Text, { bold: true }, "analyze"),
+            " command with",
+            " ",
+            React.createElement(Text, { italic: true }, "--interactive false")));
+    }
+    if (!usage) {
+        return React.createElement(Text, null, "No usage could be found.");
+    }
+    return (React.createElement(React.Fragment, null, usage && (React.createElement(Text, { color: "green" },
+        calculateNumberOfComponents(usage),
+        " components found and sent to",
+        " ",
+        React.createElement(Text, { color: "#f63e7c" }, "zeroheight")))));
+}

package/package.json

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