@zeroheight/adoption-cli 2.4.0 → 2.4.3

package/CHANGELOG.md

@@ -1,9 +1,20 @@
 # Release notes
 
-## [2.4.0](https://www.npmjs.com/package/@zeroheight/adoption-cli/v/2.4.0) - 10th December 2024
+## [2.4.3](https://www.npmjs.com/package/@zeroheight/adoption-cli/v/2.4.3) - 2nd January 2025
+
+- `track-package --packages` option can be used to allow tracking specific packages within monorepos in non-interactive mode
+
+## [2.4.2](https://www.npmjs.com/package/@zeroheight/adoption-cli/v/2.4.2) - 17th December 2024
+
+- Fix issue with parsing pnpm lockfiles using version `6.0`
 
-- `analyze --ignore` option can be used moe than once to allow for more glob patterns, this fixes an issue in **2.3.0** where glob patterns containing commas would not work as expected
+## [2.4.1](https://www.npmjs.com/package/@zeroheight/adoption-cli/v/2.4.1) - 11th December 2024
+
+- The `monitor-repo` command now supports custom package naming for projects.
+
+## [2.4.0](https://www.npmjs.com/package/@zeroheight/adoption-cli/v/2.4.0) - 10th December 2024
 
+- `analyze --ignore` option can be used more than once to allow for more glob patterns, this fixes an issue in **2.3.0** where glob patterns containing commas would not work as expected
 
 ## [2.3.0](https://www.npmjs.com/package/@zeroheight/adoption-cli/v/2.3.0) - 5th December 2024
 

package/README.md

@@ -186,6 +186,18 @@ Pass in `false` to disable the interactive mode e.g. when running in a CI enviro
 zh-adoption track-package --interactive false
 ```
 
+`-p` / `--packages`
+
+Provide one or multiple package names to match when searching for design system packages. This must be passed when `-in` / `--interactive` is set to `false`.
+
+```bash
+zh-adoption track-package -in false -p package1 -p package2 -p package3
+```
+
+```bash
+zh-adoption track-package -in false --packages package1,package2,package3
+```
+
 `--log-level`
 
 Provide a severity to output diagnostic messages.

package/dist/cli.js

@@ -13,7 +13,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("2.4.0")
+    .version("2.4.3")
     .addHelpText("before", output)
     .option("--log-file <path>", "Path to write logs to, if not provided logs only error logs will be written to stderr")
     .addOption(new Option("--log-level <level>", "The lowest level of logs to display")

package/dist/commands/monitor-repo.d.ts

@@ -3,6 +3,7 @@ import { RenderOptions } from "ink";
 interface MonitorRepoOptions {
     interactive: boolean;
     dir?: string[];
+    packageName?: string;
 }
 export declare function monitorRepoAction(options: MonitorRepoOptions, _renderOptions?: RenderOptions): Promise<void>;
 export declare function monitorRepoCommand(): Command;

package/dist/commands/monitor-repo.js

@@ -8,7 +8,7 @@ export async function monitorRepoAction(options, _renderOptions) {
     // if (options.interactive) {
     //   render(<MonitorRepo />, renderOptions);
     // } else {
-    render(React.createElement(NonInteractiveMonitorRepo, { packageDirs: options.dir }));
+    render(React.createElement(NonInteractiveMonitorRepo, { packageDirs: options.dir, packageName: options.packageName }));
     // }
 }
 export function monitorRepoCommand() {
@@ -28,6 +28,7 @@ export function monitorRepoCommand() {
         //     .argParser((value) => yn(value))
         // )
         .addOption(new Option("-d, --dir <path...>", "use package directory to find package.json and lockfile"))
+        .addOption(new Option("-p, --package-name <name>", "specify the name used to identify the package in zeroheight"))
         .action(async (options) => {
         setStdErrStream();
         try {

package/dist/commands/track-package.d.ts

@@ -2,6 +2,7 @@ import { Command } from "commander";
 import { RenderOptions } from "ink";
 interface TrackPackageOptions {
     interactive: boolean;
+    packages?: string[];
 }
 export declare function trackPackageAction(options: TrackPackageOptions, renderOptions?: RenderOptions): Promise<void>;
 export declare function trackPackageCommand(): Command;

package/dist/commands/track-package.js

@@ -5,12 +5,13 @@ import yn from "yn";
 import NonInteractiveTrackPackage from "../components/track-package/non-interactive-track-package.js";
 import TrackPackage from "../components/track-package/track-package.js";
 import { setStdErrStream } from "../common/logging.js";
+import { parsePackageList } from "./track-package.utils.js";
 export async function trackPackageAction(options, renderOptions) {
     if (options.interactive) {
         render(React.createElement(TrackPackage, null), renderOptions);
     }
     else {
-        render(React.createElement(NonInteractiveTrackPackage, null));
+        render(React.createElement(NonInteractiveTrackPackage, { allowedPackages: options.packages }));
     }
 }
 export function trackPackageCommand() {
@@ -24,6 +25,7 @@ export function trackPackageCommand() {
         .addOption(new Option("-in, --interactive [boolean]", "disable to skip manual input (useful when running in CI)")
         .default(true)
         .argParser((value) => yn(value)))
+        .addOption(new Option("-p, --packages [packageNames]", "specify the packages to search for, use multiple times to match more than one package").argParser(parsePackageList))
         .action(async (options) => {
         if (!options.interactive) {
             setStdErrStream();

package/dist/commands/track-package.utils.d.ts

@@ -4,7 +4,14 @@ import { PackageFile } from "../common/types/package-file.js";
  * @param subpath - provide to search inside subpath instead of working directory
  */
 export declare function findPackageFiles(subpath?: string): Promise<string[]>;
-export declare function getPackageInfo(): Promise<{
+/**
+ * Get allowed package files from the directory and return
+ * their name/package/version/exports
+ *
+ * @param allowedPackages a list of package names to match on
+ * @returns a list of matched packages files and errors
+ */
+export declare function getPackageInfo(allowedPackages?: string[]): Promise<{
     files: PackageFile[];
     error: string | null;
 }>;
@@ -12,3 +19,7 @@ export declare function getPackageInfo(): Promise<{
  * Transform exports object into fully qualified aliases
  */
 export declare function getAliasesFromExports(packageName: string, exports?: PackageFile["exports"]): string[];
+/**
+ * Parse package list and format correctly
+ */
+export declare function parsePackageList(value: string, previous?: string[]): string[];

package/dist/commands/track-package.utils.js

@@ -9,7 +9,14 @@ export async function findPackageFiles(subpath) {
     const workingDir = joinPath(process.cwd(), subpath ?? "");
     return findFiles(workingDir, "**/**/package.json", []);
 }
-export async function getPackageInfo() {
+/**
+ * Get allowed package files from the directory and return
+ * their name/package/version/exports
+ *
+ * @param allowedPackages a list of package names to match on
+ * @returns a list of matched packages files and errors
+ */
+export async function getPackageInfo(allowedPackages) {
     const base = process.cwd();
     const files = await findPackageFiles();
     if (files.length === 0) {
@@ -19,16 +26,25 @@ export async function getPackageInfo() {
         };
     }
     try {
-        const packageFiles = await Promise.all(files.map(async (file) => {
+        let packageFiles = await Promise.all(files.map(async (file) => {
             const fileContents = await readFile(file, "utf-8");
             const parsedPackage = JSON.parse(fileContents);
             return {
                 name: parsedPackage.name,
-                path: `.${files[0]?.split(base).pop()}`,
+                path: `.${file.split(base).pop()}`,
                 version: parsedPackage.version,
                 exports: parsedPackage.exports,
             };
         }));
+        if (allowedPackages?.length) {
+            packageFiles = packageFiles.filter((pack) => allowedPackages.includes(pack.name));
+            if (!packageFiles.length) {
+                return {
+                    files: [],
+                    error: "Can't find any matching packages",
+                };
+            }
+        }
         return {
             files: packageFiles,
             error: null,
@@ -51,3 +67,15 @@ export function getAliasesFromExports(packageName, exports) {
         .map((path) => joinPath(packageName, path))
         .filter((name) => name !== packageName);
 }
+/**
+ * Parse package list and format correctly
+ */
+export function parsePackageList(value, previous = []) {
+    return [
+        ...previous,
+        ...value
+            .split(",")
+            .map((entry) => entry.trim())
+            .filter(Boolean),
+    ];
+}

package/dist/components/monitor-repo/non-interactive-monitor-repo.d.ts

@@ -1,6 +1,7 @@
 import React from "react";
 interface NonInteractiveMonitorRepoProps {
     packageDirs?: string[];
+    packageName?: string;
 }
-export default function NonInteractiveMonitorRepo({ packageDirs, }: NonInteractiveMonitorRepoProps): React.JSX.Element;
+export default function NonInteractiveMonitorRepo({ packageDirs, packageName, }: NonInteractiveMonitorRepoProps): React.JSX.Element;
 export {};

package/dist/components/monitor-repo/non-interactive-monitor-repo.js

@@ -1,7 +1,7 @@
 import React from "react";
 import { Box, Text } from "ink";
 import Spinner from "ink-spinner";
-import { join as joinPath } from "path";
+import { basename, join as joinPath } from "path";
 import { findLockfiles, getPackageMeta, groupByBasename, parseLockfile, } from "../../commands/monitor-repo.utils.js";
 import { findPackageFiles } from "../../commands/track-package.utils.js";
 import { ResponseStatus, submitMonitoredRepoDetails, } from "../../common/api.js";
@@ -15,7 +15,7 @@ var Step;
     Step[Step["FINDING_DETAILS"] = 2] = "FINDING_DETAILS";
     Step[Step["SENDING_DATA"] = 3] = "SENDING_DATA";
 })(Step || (Step = {}));
-export default function NonInteractiveMonitorRepo({ packageDirs, }) {
+export default function NonInteractiveMonitorRepo({ packageDirs, packageName, }) {
     const [errorMessage, setErrorMessage] = React.useState(); // Global error message
     const [repoStatus, setRepoStatus] = React.useState({});
     function updateRepoStatus(name, step, error) {
@@ -51,6 +51,13 @@ export default function NonInteractiveMonitorRepo({ packageDirs, }) {
             let packageMeta;
             try {
                 packageMeta = await getPackageMeta(joinPath(directory, "package.json"));
+                if (packageName) {
+                    packageMeta.name = packageName;
+                }
+                if (!packageMeta.name) {
+                    setErrorMessage(`Name field is missing in your ${basename(directory)}/package.json file. Re-run the command with --package-name <name> to continue.`);
+                    continue;
+                }
             }
             catch (e) {
                 // package.json doesn't exist or is invalid, skip pair

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

@@ -1,2 +1,5 @@
 import React from "react";
-export default function NonInteractiveTrackPackage(): React.JSX.Element;
+export interface NonInteractiveTrackPackageProps {
+    allowedPackages?: string[];
+}
+export default function NonInteractiveTrackPackage({ allowedPackages, }: NonInteractiveTrackPackageProps): React.JSX.Element;

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

@@ -13,7 +13,7 @@ var Step;
     Step[Step["MULTIPLE_PACKAGES_FOUND"] = 3] = "MULTIPLE_PACKAGES_FOUND";
     Step[Step["SINGLE_PACKAGE_FOUND"] = 4] = "SINGLE_PACKAGE_FOUND";
 })(Step || (Step = {}));
-export default function NonInteractiveTrackPackage() {
+export default function NonInteractiveTrackPackage({ allowedPackages, }) {
     const { exit } = useApp();
     const [currentStep, setCurrentStep] = React.useState(Step.FINDING_DETAILS);
     const [errorMessage, setErrorMessage] = React.useState(null);
@@ -22,7 +22,7 @@ export default function NonInteractiveTrackPackage() {
     const [packageVersion, setPackageVersion] = React.useState(null);
     async function runTrackPackage() {
         const config = (await readConfig()) ?? { token: "temp", client: "temp" };
-        const { files, error } = await getPackageInfo();
+        const { files, error } = await getPackageInfo(allowedPackages);
         try {
             if (files.length === 1) {
                 const { name, path, version, exports } = files[0];
@@ -83,7 +83,7 @@ export default function NonInteractiveTrackPackage() {
             " searching for package file...")),
         currentStep === Step.SINGLE_PACKAGE_FOUND && (React.createElement(React.Fragment, null,
             React.createElement(Text, null,
-                React.createElement(Text, { color: "green" }, "Details founds:"),
+                React.createElement(Text, { color: "green" }, "Details found:"),
                 " ",
                 packageName,
                 "@",

package/dist/lockfile-parsers/pnpm-lock-parser.js

@@ -37,7 +37,13 @@ _PNPMLockParser_instances = new WeakSet(), _PNPMLockParser_parseV5 = function _P
 }, _PNPMLockParser_parseV6 = function _PNPMLockParser_parseV6(data) {
     return Object.keys(data.packages)
         .map((packagePair) => {
-        const [name, version] = packagePair.split("@");
+        const lastIndex = packagePair.lastIndexOf("@");
+        let name = packagePair.slice(0, lastIndex);
+        const version = packagePair.slice(lastIndex + 1);
+        // v6 lockfiles have a leading slash
+        if (name.startsWith("/")) {
+            name = name.slice(1);
+        }
         return { name, version };
     })
         .filter((p) => p.name && p.version);

package/package.json

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