@zeroheight/adoption-cli 0.1.1 → 0.2.0

package/README.md

@@ -14,7 +14,7 @@ In the repository in which you wish to analyze the component usage, run the foll
 zh-adoption analyze
 ```
 
-To send adoption data to your zeroheight account you will need to authenticate. This can be done as part of the `analyze` flow or separetly by running:
+To send adoption data to your zeroheight account you will need to authenticate. This can be done as part of the `analyze` flow or separately by running:
 
 ```
 zh-adoption auth

package/dist/ast/analyze.js

@@ -27,6 +27,8 @@ export function analyze(ast) {
         JSXElement(node, state, _nodePath) {
             const el = node.openingElement;
             const elName = el.name.name;
+            if (!elName)
+                return;
             // Ignore html tags e.g. div, h1, span
             if (elName[0] === elName[0]?.toLocaleLowerCase())
                 return;
@@ -69,6 +71,10 @@ export function analyze(ast) {
         TSAsExpression() { },
         TSDeclareFunction() { },
         TSTypeAliasDeclaration() { },
+        TSNonNullExpression() { },
+        TSEnumDeclaration() { },
+        TSParameterProperty() { },
+        TSImportEqualsDeclaration() { },
     };
     try {
         walk.ancestor(ast, visitors, base, visitorState);

package/dist/commands/analyze.d.ts

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

package/dist/commands/analyze.js

@@ -4,7 +4,7 @@ import { Command, Option } from "commander";
 import Analyze from "../components/analyze/analyze.js";
 import { analyzeFiles } from "./analyze.utils.js";
 export async function analyzeAction(options, renderOptions) {
-    render(React.createElement(Analyze, { onAnalyzeFiles: () => analyzeFiles(options.extensions, options.ignore), dryRun: options.dryRun }), renderOptions);
+    render(React.createElement(Analyze, { onAnalyzeFiles: () => analyzeFiles(options.extensions, options.ignore), dryRun: options.dryRun, repoName: options.repoName }), renderOptions);
 }
 export function analyzeCommand() {
     const command = new Command();
@@ -12,8 +12,9 @@ export function analyzeCommand() {
         .command("analyze")
         .description("Analyze your codebase to determine component usage metrics")
         .addOption(new Option("-e, --extensions [ext]", "file extensions to include when searching for components").default("**/*.{js,jsx,ts,tsx}", "glob pattern to determine file extensions"))
-        .addOption(new Option("-i, --ignore", "files to ignore when searching for components").default("**/*.{test,spec}.*", "glob pattern to determine ignored files"))
+        .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"))
         .action(async (options) => {
         try {
             await analyzeAction(options);

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

@@ -1,5 +1,4 @@
 import { RawUsageMap } from "./analyze.js";
-import { Credentials } from "../common/config.js";
 export interface ComponentUsageRecord {
     name: string;
     files: string[];
@@ -15,11 +14,6 @@ export interface ComponentUsageRecord {
  * @returns list of file paths
  */
 export declare function findFiles(base: string, extensions: string, ignorePattern: string): Promise<string[]>;
-export declare function getZeroheightURL(): URL;
-/**
- * Post usage data to zeroheight to store
- */
-export declare function submitUsageData(usage: RawUsageMap, credentials: Credentials): Promise<any>;
 export declare function analyzeFiles(extensions: string, ignorePattern: string): Promise<{
     errors: string[];
     usage: RawUsageMap;

package/dist/commands/analyze.utils.js

@@ -46,61 +46,6 @@ async function getGitIgnore(base) {
         return "";
     }
 }
-export function getZeroheightURL() {
-    if (process.env["NODE_ENV"] === "dev") {
-        return new URL("https://zeroheight.dev");
-    }
-    else {
-        return new URL("https://zeroheight.com");
-    }
-}
-/**
- * Post usage data to zeroheight to store
- */
-export async function submitUsageData(usage, credentials) {
-    const baseURL = getZeroheightURL();
-    baseURL.pathname = "/open_api/v1/component_usages";
-    if (process.env["NODE_ENV"] === "dev") {
-        process.env["NODE_TLS_REJECT_UNAUTHORIZED"] = "0";
-    }
-    const response = await fetch(baseURL, {
-        method: "POST",
-        headers: {
-            "Content-Type": "application/json",
-            "X-API-CLIENT": credentials.client,
-            "X-API-KEY": credentials.token,
-        },
-        body: JSON.stringify({
-            component_usage: {
-                usage: transformUsageByName(usage),
-            },
-        }),
-    });
-    if (response.status === 401) {
-        throw new Error("Unauthorized");
-    }
-    return await response.json();
-}
-/**
- * Transform usage map grouped by file into usage map grouped by component
- */
-function transformUsageByName(usage) {
-    const transformedUsageMap = new Map();
-    for (const [file, rawUsage] of usage) {
-        for (const { count, package: packageName, name } of rawUsage) {
-            const key = `package:${packageName} name:${name}`;
-            const currentValue = transformedUsageMap.get(key);
-            const newFileList = [...(currentValue?.files ?? []), file]; // Add file to list
-            transformedUsageMap.set(key, {
-                name: currentValue?.name ?? name,
-                files: Array.from(new Set(newFileList)), // Ensure unique file paths
-                count: count + (currentValue?.count ?? 0),
-                package: packageName,
-            });
-        }
-    }
-    return Array.from(transformedUsageMap.values());
-}
 export async function analyzeFiles(extensions, ignorePattern) {
     const files = await findFiles(process.cwd(), extensions, ignorePattern);
     if (files.length === 0) {

package/dist/commands/auth.js

@@ -11,7 +11,10 @@ export async function authAction(options, renderOptions) {
         const { waitUntilExit } = render(React.createElement(CredentialsAlreadyExists, { existingConfig: existingConfig, token: options.token, client: options.client, configPath: configPath(), onOverwriteCredentials: async () => {
                 const newClient = options.client ?? existingConfig.client;
                 const newToken = options.token ?? existingConfig.token;
-                await writeConfig(newClient, newToken);
+                await writeConfig({
+                    client: newClient,
+                    token: newToken,
+                });
                 render(React.createElement(Box, { flexDirection: "column" },
                     React.createElement(Text, { color: "green" }, "Updated credentials"),
                     React.createElement(CredentialsPreview, { client: newClient, token: newToken })));
@@ -21,7 +24,10 @@ export async function authAction(options, renderOptions) {
     else {
         const { waitUntilExit, rerender } = render(React.createElement(NoCredentialsOnboarding, { configPath: configPath(), onSaveCredentials: async (persist, newClient, newToken) => {
                 if (persist) {
-                    await writeConfig(newClient, newToken);
+                    await writeConfig({
+                        client: newClient,
+                        token: newToken,
+                    });
                     rerender(React.createElement(Box, { flexDirection: "column" },
                         React.createElement(Text, { color: "green" }, "Updated credentials"),
                         React.createElement(CredentialsPreview, { client: newClient, token: newToken })));

package/dist/common/api.d.ts

@@ -0,0 +1,5 @@
+import { RawUsageMap } from "../commands/analyze.js";
+import { Credentials } from "./config.js";
+export declare function getZeroheightURL(): URL;
+export declare function submitUsageData(usage: RawUsageMap, repoName: string, credentials: Credentials): Promise<any>;
+export declare function getExistingRepoNames(credentials: Credentials): Promise<any>;

package/dist/common/api.js

@@ -0,0 +1,67 @@
+export function getZeroheightURL() {
+    if (process.env["NODE_ENV"] === "dev") {
+        return new URL("https://zeroheight.dev");
+    }
+    else {
+        return new URL("https://zeroheight.com");
+    }
+}
+export async function submitUsageData(usage, repoName, credentials) {
+    return post("/open_api/v1/component_usages", {
+        repo_name: repoName,
+        usage: transformUsageByName(usage),
+    }, credentials);
+}
+export function getExistingRepoNames(credentials) {
+    return get("/open_api/v1/component_usages/repo_names", credentials);
+}
+async function get(path, credentials) {
+    return request(path, credentials, {
+        method: "GET",
+    });
+}
+async function post(path, body, credentials) {
+    return request(path, credentials, {
+        method: "POST",
+        body: JSON.stringify(body),
+    });
+}
+async function request(path, credentials, init) {
+    const url = getZeroheightURL();
+    url.pathname = path;
+    if (process.env["NODE_ENV"] === "dev") {
+        process.env["NODE_TLS_REJECT_UNAUTHORIZED"] = "0";
+    }
+    const response = await fetch(url, {
+        ...init,
+        headers: {
+            "X-API-CLIENT": credentials.client,
+            "X-API-KEY": credentials.token,
+            "Content-Type": "application/json",
+        },
+    });
+    if (response.status === 401) {
+        throw new Error("Unauthorized");
+    }
+    return await response.json();
+}
+/**
+ * Transform usage map grouped by file into usage map grouped by component
+ */
+function transformUsageByName(usage) {
+    const transformedUsageMap = new Map();
+    for (const [file, rawUsage] of usage) {
+        for (const { count, package: packageName, name } of rawUsage) {
+            const key = `package:${packageName} name:${name}`;
+            const currentValue = transformedUsageMap.get(key);
+            const newFileList = [...(currentValue?.files ?? []), file]; // Add file to list
+            transformedUsageMap.set(key, {
+                name: currentValue?.name ?? name,
+                files: Array.from(new Set(newFileList)), // Ensure unique file paths
+                count: count + (currentValue?.count ?? 0),
+                package: packageName,
+            });
+        }
+    }
+    return Array.from(transformedUsageMap.values());
+}

package/dist/common/config.d.ts

@@ -2,10 +2,13 @@ export interface Credentials {
     token: string;
     client: string;
 }
+export interface Config extends Credentials {
+    repoNames: Record<string, string>;
+}
 export declare function configPath(): string;
 /**
  * Read the credentials from the user's home directory
  * @returns access token and client id or null
  */
-export declare function readConfig(): Promise<Credentials | null>;
-export declare function writeConfig(client: string, token: string): Promise<void>;
+export declare function readConfig(): Promise<Config | null>;
+export declare function writeConfig(newValues: Partial<Config>): Promise<void>;

package/dist/common/config.js

@@ -11,22 +11,31 @@ export function configPath() {
 export async function readConfig() {
     try {
         const rawData = await readFile(configPath(), "utf8");
-        const { token, client } = JSON.parse(rawData);
-        return { token, client };
+        const { token, client, repoNames = {} } = JSON.parse(rawData);
+        return { token, client, repoNames };
     }
     catch (e) {
         const client = process.env["ZEROHEIGHT_CLIENT_ID"];
         const token = process.env["ZEROHEIGHT_ACCESS_TOKEN"];
         if (client && token) {
-            return { token, client };
+            return { token, client, repoNames: {} };
         }
         return null;
     }
 }
-export async function writeConfig(client, token) {
+export async function writeConfig(newValues) {
+    const config = (await readConfig()) ??
+        {
+            repoNames: {},
+        };
+    // TODO: if we have a more complex config, we should use a deep merge here
     const payload = JSON.stringify({
-        client: client,
-        token: token,
+        ...config,
+        ...newValues,
+        repoNames: {
+            ...config.repoNames,
+            ...(newValues.repoNames ?? {}),
+        },
     });
     return writeFile(configPath(), payload);
 }

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

@@ -6,5 +6,6 @@ export interface AnalyzeProps {
         usage: RawUsageMap;
     }>;
     dryRun: boolean;
+    repoName?: string;
 }
-export default function Analyze({ onAnalyzeFiles, dryRun }: AnalyzeProps): React.JSX.Element;
+export default function Analyze({ onAnalyzeFiles, dryRun, repoName, }: AnalyzeProps): React.JSX.Element;

package/dist/components/analyze/analyze.js

@@ -4,16 +4,19 @@ 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 { getZeroheightURL, submitUsageData, } from "../../commands/analyze.utils.js";
 import Link from "ink-link";
 import NoCredentialsOnboarding from "../auth/no-credentials-onboarding.js";
-export default function Analyze({ onAnalyzeFiles, dryRun }) {
+import { getZeroheightURL, submitUsageData } from "../../common/api.js";
+import RepoNamePrompt from "../repo-name-prompt.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 [credentials, setCredentials] = React.useState(null);
     const [resourceURL, setResourceURL] = React.useState(null);
+    const [repo, setRepo] = React.useState(repoName);
+    const [promptRepo, setPromptRepo] = React.useState(repoName === undefined);
     React.useEffect(() => {
         onAnalyzeFiles()
             .then(({ errors, usage }) => {
@@ -22,15 +25,23 @@ export default function Analyze({ onAnalyzeFiles, dryRun }) {
         })
             .catch((e) => setErrorList((s) => [...s, e]));
         if (!dryRun) {
-            readConfig().then((newCredentials) => setCredentials(newCredentials));
+            readConfig().then((config) => {
+                if (config) {
+                    setCredentials({ token: config.token, client: config.client });
+                }
+            });
         }
     }, []);
     async function handleContinue(shouldContinue) {
         if (shouldContinue) {
-            if (!dryRun && credentials && usageResult) {
+            if (!dryRun && credentials && usageResult && !repo) {
+                setPromptRepo(true);
+                setRepo("");
+            }
+            else if (!dryRun && credentials && usageResult && repo) {
                 setIsSendingData(true);
                 try {
-                    await submitUsageData(usageResult, credentials);
+                    await submitUsageData(usageResult, repo, credentials);
                     const resourceURL = getZeroheightURL();
                     resourceURL.pathname = "/adoption/";
                     setResourceURL(resourceURL);
@@ -47,6 +58,15 @@ export default function Analyze({ onAnalyzeFiles, dryRun }) {
             exit();
         }
     }
+    function handleOnRepoNameSelected(repoName) {
+        setRepo(repoName);
+        writeConfig({
+            repoNames: {
+                [process.cwd()]: repoName,
+            },
+        });
+        setPromptRepo(false);
+    }
     if (errorList.length > 0) {
         return (React.createElement(Box, { flexDirection: "column" },
             React.createElement(Text, { color: "red" }, "Error:"),
@@ -59,7 +79,10 @@ export default function Analyze({ onAnalyzeFiles, dryRun }) {
                 const newCredentials = { token: newToken, client: newClient };
                 setCredentials(newCredentials);
                 if (persist) {
-                    await writeConfig(newClient, newToken);
+                    await writeConfig({
+                        client: newClient,
+                        token: newToken,
+                    });
                 }
             } }));
     }
@@ -91,7 +114,7 @@ export default function Analyze({ onAnalyzeFiles, dryRun }) {
                 " ",
                 React.createElement(Link, { url: resourceURL.toString() }, "usage data on zeroheight"))));
     }
-    if (usageResult) {
+    if (usageResult && !promptRepo) {
         return (React.createElement(Box, { flexDirection: "column" },
             React.createElement(UsageTable, { usage: usageResult }),
             dryRun && (React.createElement(React.Fragment, null,
@@ -103,5 +126,8 @@ export default function Analyze({ onAnalyzeFiles, dryRun }) {
                 React.createElement(Newline, null))),
             !dryRun && React.createElement(ContinuePrompt, { onContinue: handleContinue })));
     }
+    if (promptRepo) {
+        return (React.createElement(RepoNamePrompt, { credentials: credentials, onRepoNameSelected: handleOnRepoNameSelected }));
+    }
     return React.createElement(Text, null, "NOPE");
 }

package/dist/components/repo-name-prompt.d.ts

@@ -0,0 +1,8 @@
+import React from "react";
+import { Credentials } from "../common/config.js";
+interface RepoNamePromptProps {
+    credentials: Credentials | null;
+    onRepoNameSelected: (repoName: string) => void;
+}
+export default function RepoNamePrompt({ credentials, onRepoNameSelected, }: RepoNamePromptProps): React.JSX.Element | null;
+export {};

package/dist/components/repo-name-prompt.js

@@ -0,0 +1,93 @@
+import React from "react";
+import { Box, Text } from "ink";
+import Spinner from "ink-spinner";
+import SelectInput from "ink-select-input";
+import { readConfig } from "../common/config.js";
+import { getExistingRepoNames } from "../common/api.js";
+import TextInput from "ink-text-input";
+var RepoNamePromptState;
+(function (RepoNamePromptState) {
+    RepoNamePromptState["LOADING"] = "LOADING";
+    RepoNamePromptState["ERROR"] = "ERROR";
+    RepoNamePromptState["SELECT_REPO_NAME"] = "SELECT_REPO_NAME";
+    RepoNamePromptState["ENTER_REPO_NAME"] = "ENTER_REPO_NAME";
+})(RepoNamePromptState || (RepoNamePromptState = {}));
+export default function RepoNamePrompt({ credentials, onRepoNameSelected, }) {
+    const [state, setState] = React.useState(RepoNamePromptState.LOADING);
+    const [repoNames, setRepoNames] = React.useState([]);
+    const [repoName, setRepoName] = React.useState("");
+    async function loadRepoNames(credentials) {
+        try {
+            const names = await getExistingRepoNames(credentials);
+            setRepoNames(names);
+            if (names.length === 0) {
+                setState(RepoNamePromptState.ENTER_REPO_NAME);
+            }
+            else {
+                setState(RepoNamePromptState.SELECT_REPO_NAME);
+            }
+        }
+        catch (e) {
+            setState(RepoNamePromptState.ERROR);
+        }
+    }
+    React.useEffect(() => {
+        if (!credentials) {
+            return;
+        }
+        setState(RepoNamePromptState.LOADING);
+        readConfig().then((config) => {
+            const repoName = config?.repoNames?.[process.cwd()];
+            if (repoName) {
+                onRepoNameSelected(repoName);
+            }
+            else {
+                loadRepoNames(credentials);
+            }
+        });
+    }, [credentials]);
+    function onSelect(item) {
+        if (item.value === "enter-repository-name") {
+            setState(RepoNamePromptState.ENTER_REPO_NAME);
+            return;
+        }
+        onRepoNameSelected(item.value);
+    }
+    if (state === RepoNamePromptState.LOADING) {
+        return (React.createElement(Box, { flexDirection: "column" },
+            React.createElement(Text, null,
+                React.createElement(Text, { color: "cyan" },
+                    React.createElement(Spinner, { type: "dots" })),
+                " ",
+                "Fetching repository names...")));
+    }
+    if (state === RepoNamePromptState.ERROR) {
+        return (React.createElement(Box, { flexDirection: "column" },
+            React.createElement(Text, { color: "red" }, "Error:"),
+            React.createElement(Box, { flexDirection: "column", marginLeft: 1 },
+                React.createElement(Text, null, "- Failed to fetch repository names"))));
+    }
+    if (state === RepoNamePromptState.SELECT_REPO_NAME) {
+        const selectItems = [
+            { label: "Enter repository name", value: "enter-repository-name" },
+            ...repoNames.map((name) => ({
+                label: name,
+                value: name,
+            })),
+        ];
+        return (React.createElement(Box, { flexDirection: "column" },
+            React.createElement(Text, null, "Select the repository name"),
+            React.createElement(SelectInput, { items: selectItems, onSelect: onSelect })));
+    }
+    if (state === RepoNamePromptState.ENTER_REPO_NAME) {
+        return (React.createElement(Box, null,
+            React.createElement(Text, null, "Repository name:"),
+            React.createElement(TextInput, { value: repoName, onChange: setRepoName, onSubmit: (value) => {
+                    if (value.trim().length === 0) {
+                        return;
+                    }
+                    onRepoNameSelected(value);
+                } })));
+    }
+    return null;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zeroheight/adoption-cli",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "license": "ISC",
   "main": "dist/cli.js",
   "bin": {
@@ -45,6 +45,7 @@
     "glob": "^10.3.15",
     "ink-link": "^3.0.0",
     "ink-render-string": "^1.0.0",
+    "ink-select-input": "^5.0.0",
     "ink-spinner": "^5.0.0",
     "ink-testing-library": "git+ssh://git@github.com/vadimdemedes/ink-testing-library.git#f44b077e9a05a1d615bab41c72906726d34ea085",
     "ink-text-input": "^5.0.1",
@@ -58,13 +59,9 @@
   },
   "types": "./dist/cli.d.ts",
   "description": "CLI for measuring component usage",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/zeroheight/zh-measure-cli.git"
-  },
   "author": "zeroheight",
   "bugs": {
-    "url": "https://github.com/zeroheight/zh-measure-cli/issues"
+    "email": "support@zeroheight.com"
   },
-  "homepage": "https://github.com/zeroheight/zh-measure-cli#readme"
+  "homepage": "https://zeroheight.com"
 }