@zeroheight/adoption-cli 2.2.3 → 2.4.0

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Release notes
 
+## [2.4.0](https://www.npmjs.com/package/@zeroheight/adoption-cli/v/2.4.0) - 10th December 2024
+
+- `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.3.0](https://www.npmjs.com/package/@zeroheight/adoption-cli/v/2.3.0) - 5th December 2024
+
+- The `analyze` command now ignores `*.d.ts` files by default, alongside `*.test.*` and `*.spec.*` files.
+- `analyze --ignore` now accepts a list of patterns to ignore using a comma seperated list e.g. `analyze --ignore "**/*.{test,spec}.*,**/*.d.ts"`
+
 ## [2.2.3](https://www.npmjs.com/package/@zeroheight/adoption-cli/v/2.2.3) - 28th November 2024
 
 - Update README to explain new CLI options

package/README.md

@@ -78,6 +78,18 @@ Provide a glob pattern to ignore files, directories or file extensions when sear
 zh-adoption analyze -i "**/*.{test,spec}.*"
 ```
 
+To pass multiple patterns, use the option multiple times e.g.
+
+```bash
+zh-adoption analyze -i "**/*.{test,spec}.*" -i "**/*.d.ts"
+```
+
+To ignore nothing, even the default patterns (`['**/*.{test,spec}.*', '**/*.d.ts']`), pass an empty value
+
+```bash
+zh-adoption analyze -i
+```
+
 `-r` / `--repo-name`
 
 Provide a name for the current repository. This must be passed when `-in` / `--interactive` is set to `false`.

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.2.3")
+    .version("2.4.0")
     .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/analyze.d.ts

@@ -3,7 +3,7 @@ import { Command } from "commander";
 import { RawUsage } from "../ast/analyze.js";
 interface AnalyzeOptions {
     extensions: string;
-    ignore: string;
+    ignore: string[];
     dryRun: boolean;
     repoName?: string;
     interactive: boolean;

package/dist/commands/analyze.js

@@ -1,8 +1,8 @@
-import React from "react";
+import * as React from "react";
 import { render } from "ink";
 import { Command, Option } from "commander";
 import yn from "yn";
-import { analyzeFiles } from "./analyze.utils.js";
+import { analyzeFiles, parseGlobList } from "./analyze.utils.js";
 import Analyze from "../components/analyze/analyze.js";
 import NonInteractiveAnalyze from "../components/analyze/non-interactive-analyze.js";
 import logger, { setStdErrStream } from "../common/logging.js";
@@ -23,7 +23,9 @@ export function analyzeCommand() {
         showGlobalOptions: true,
     })
         .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 [ext]", "files to ignore when searching for components").default("**/*.{test,spec}.*", "glob pattern to determine ignored files"))
+        .addOption(new Option("-i, --ignore [patterns]", "files to ignore when searching for components, use multiple times to add more than one glob pattern")
+        .default(["**/*.{test,spec}.*", "**/*.d.ts"], "*.test.*, *.spec.* and *.d.ts files")
+        .argParser(parseGlobList))
         .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)")
@@ -33,8 +35,10 @@ export function analyzeCommand() {
         if (!options.interactive) {
             setStdErrStream();
         }
+        // If no option is passed in aka `true`, use empty list of ignore patterns
+        const ignorePattern = typeof options.ignore === "boolean" ? [] : options.ignore;
         try {
-            await analyzeAction(options);
+            await analyzeAction({ ...options, ignore: ignorePattern });
         }
         catch (e) {
             logger.error({ error: e }, "Unhandled exception running analyze command");

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

@@ -1,3 +1,4 @@
+import type { Option } from "commander";
 import { RawUsageMap } from "./analyze.js";
 import { ComponentProps } from "../ast/analyze.js";
 export interface ComponentUsageRecord {
@@ -15,9 +16,13 @@ export interface ComponentUsageRecord {
  * @param gitIgnore contents of .gitignore file
  * @returns list of file paths
  */
-export declare function findFiles(base: string, extensions: string, ignorePattern: string): Promise<string[]>;
-export declare function analyzeFiles(extensions: string, ignorePattern: string): Promise<{
+export declare function findFiles(base: string, extensions: string, ignorePattern: string[]): Promise<string[]>;
+export declare function analyzeFiles(extensions: string, ignorePattern: string[]): Promise<{
     errorFile: string | null;
     usage: RawUsageMap;
 }>;
 export declare function calculateNumberOfComponents(usageResult: RawUsageMap): number;
+/**
+ * Parse the ignore array and format correctly
+ */
+export declare function parseGlobList(this: Option, value: string, previous: unknown): any[];

package/dist/commands/analyze.utils.js

@@ -28,7 +28,11 @@ export async function findFiles(base, extensions, ignorePattern) {
         // add gitignore rules
         .add(gitIgnore);
     const matchingFiles = [];
-    const g = new Glob(extensions, { cwd: base, ignore: ignorePattern, fs });
+    const g = new Glob(extensions, {
+        cwd: base,
+        ignore: ignorePattern,
+        fs,
+    });
     for await (const file of g) {
         const fullFilepath = path.join(base, file);
         const meta = await stat(fullFilepath);
@@ -97,3 +101,17 @@ export function calculateNumberOfComponents(usageResult) {
     }
     return 0;
 }
+/**
+ * Parse the ignore array and format correctly
+ */
+export function parseGlobList(value, previous) {
+    // Ignore default values if option given instead
+    if (previous == this.defaultValue) {
+        return [value];
+    }
+    // Concat to array if array already exists
+    if (Array.isArray(previous)) {
+        return previous.concat(value);
+    }
+    return [value];
+}

package/dist/commands/monitor-repo.utils.js

@@ -40,7 +40,7 @@ export async function parseLockfile(lockfilePath) {
  */
 export async function findLockfiles(subpath) {
     const workingDir = joinPath(process.cwd(), subpath ?? "");
-    return findFiles(workingDir, "**/**/{package-lock.json,shrinkwrap.yaml,pnpm-lock.yaml,yarn.lock}", "");
+    return findFiles(workingDir, "**/**/{package-lock.json,shrinkwrap.yaml,pnpm-lock.yaml,yarn.lock}", []);
 }
 /**
  * Get the lockfile parser so name, version and packages can be extracted from the lockfile

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

@@ -7,7 +7,7 @@ import { findFiles } from "./analyze.utils.js";
  */
 export async function findPackageFiles(subpath) {
     const workingDir = joinPath(process.cwd(), subpath ?? "");
-    return findFiles(workingDir, "**/**/package.json", "");
+    return findFiles(workingDir, "**/**/package.json", []);
 }
 export async function getPackageInfo() {
     const base = process.cwd();

package/package.json

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