@lage-run/cli 0.8.1 → 0.8.3

package/CHANGELOG.json

@@ -2,7 +2,73 @@
   "name": "@lage-run/cli",
   "entries": [
     {
-      "date": "Mon, 06 Feb 2023 23:42:47 GMT",
+      "date": "Wed, 15 Feb 2023 16:46:37 GMT",
+      "tag": "@lage-run/cli_v0.8.3",
+      "version": "0.8.3",
+      "comments": {
+        "patch": [
+          {
+            "author": "kchau@microsoft.com",
+            "package": "@lage-run/cli",
+            "commit": "d66a3b4811f36290a0499d9199948c84c8049728",
+            "comment": "bumping workspace-tools to latest to support yarn 3"
+          },
+          {
+            "author": "beachball",
+            "package": "@lage-run/cli",
+            "comment": "Bump @lage-run/scheduler to v0.8.4",
+            "commit": "d66a3b4811f36290a0499d9199948c84c8049728"
+          },
+          {
+            "author": "beachball",
+            "package": "@lage-run/cli",
+            "comment": "Bump @lage-run/scheduler-types to v0.3.1",
+            "commit": "d66a3b4811f36290a0499d9199948c84c8049728"
+          },
+          {
+            "author": "beachball",
+            "package": "@lage-run/cli",
+            "comment": "Bump @lage-run/target-graph to v0.6.2",
+            "commit": "d66a3b4811f36290a0499d9199948c84c8049728"
+          },
+          {
+            "author": "beachball",
+            "package": "@lage-run/cli",
+            "comment": "Bump @lage-run/cache to v0.2.4",
+            "commit": "d66a3b4811f36290a0499d9199948c84c8049728"
+          },
+          {
+            "author": "beachball",
+            "package": "@lage-run/cli",
+            "comment": "Bump @lage-run/reporters to v1.0.1",
+            "commit": "d66a3b4811f36290a0499d9199948c84c8049728"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Tue, 07 Feb 2023 23:52:48 GMT",
+      "tag": "@lage-run/cli_v0.8.2",
+      "version": "0.8.2",
+      "comments": {
+        "patch": [
+          {
+            "author": "kchau@microsoft.com",
+            "package": "@lage-run/cli",
+            "commit": "d7bf00acf2e7bda7d3e3478b6ef60db0d32ba243",
+            "comment": "migrating to V2"
+          },
+          {
+            "author": "beachball",
+            "package": "@lage-run/cli",
+            "comment": "Bump @lage-run/scheduler to v0.8.3",
+            "commit": "d7bf00acf2e7bda7d3e3478b6ef60db0d32ba243"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Mon, 06 Feb 2023 23:42:51 GMT",
       "tag": "@lage-run/cli_v0.8.1",
       "version": "0.8.1",
       "comments": {

package/CHANGELOG.md

@@ -1,12 +1,34 @@
 # Change Log - @lage-run/cli
 
-This log was last generated on Mon, 06 Feb 2023 23:42:47 GMT and should not be manually modified.
+This log was last generated on Wed, 15 Feb 2023 16:46:37 GMT and should not be manually modified.
 
 <!-- Start content -->
 
+## 0.8.3
+
+Wed, 15 Feb 2023 16:46:37 GMT
+
+### Patches
+
+- bumping workspace-tools to latest to support yarn 3 (kchau@microsoft.com)
+- Bump @lage-run/scheduler to v0.8.4
+- Bump @lage-run/scheduler-types to v0.3.1
+- Bump @lage-run/target-graph to v0.6.2
+- Bump @lage-run/cache to v0.2.4
+- Bump @lage-run/reporters to v1.0.1
+
+## 0.8.2
+
+Tue, 07 Feb 2023 23:52:48 GMT
+
+### Patches
+
+- migrating to V2 (kchau@microsoft.com)
+- Bump @lage-run/scheduler to v0.8.3
+
 ## 0.8.1
 
-Mon, 06 Feb 2023 23:42:47 GMT
+Mon, 06 Feb 2023 23:42:51 GMT
 
 ### Patches
 

package/lib/cli.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/commands/addFilterOptions.d.ts

@@ -0,0 +1,2 @@
+import type { Command } from "commander";
+export declare function addFilterOptions(program: Command): Command;

package/lib/commands/addLoggerOptions.d.ts

@@ -0,0 +1,2 @@
+import type { Command } from "commander";
+export declare function addLoggerOptions(program: Command): Command;

package/lib/commands/affected/action.d.ts

@@ -0,0 +1,6 @@
+import type { FilterOptions } from "../../types/FilterOptions.js";
+interface AffectedOptions extends FilterOptions {
+    outputFormat?: "json" | "graph" | "default";
+}
+export declare function affectedAction(options: AffectedOptions): Promise<void>;
+export {};

package/lib/commands/affected/index.d.ts

@@ -0,0 +1,3 @@
+import { Command } from "commander";
+declare const affectedCommand: Command;
+export { affectedCommand };

package/lib/commands/cache/action.d.ts

@@ -0,0 +1,8 @@
+import type { Command } from "commander";
+import type { ReporterInitOptions } from "../../types/ReporterInitOptions.js";
+interface CacheOptions extends ReporterInitOptions {
+    prune?: number;
+    clear?: boolean;
+}
+export declare function cacheAction(options: CacheOptions, command: Command): Promise<void>;
+export {};

package/lib/commands/cache/cacheDir.d.ts

@@ -0,0 +1 @@
+export declare function getCacheDir(workspace: string, internalCacheFolder: string): string;

package/lib/commands/cache/clearCache.d.ts

@@ -0,0 +1,8 @@
+import type { Logger } from "@lage-run/logger";
+export interface ClearCacheOptions {
+    cwd: string;
+    internalCacheFolder: string;
+    logger: Logger;
+    concurrency: number;
+}
+export declare function clearCache(options: ClearCacheOptions): Promise<void>;

package/lib/commands/cache/index.d.ts

@@ -0,0 +1,3 @@
+import { Command } from "commander";
+declare const cacheCommand: Command;
+export { cacheCommand };

package/lib/commands/cache/pruneCache.d.ts

@@ -0,0 +1,9 @@
+import type { Logger } from "@lage-run/logger";
+export interface PruneCacheOptions {
+    cwd: string;
+    internalCacheFolder: string;
+    logger: Logger;
+    concurrency: number;
+    pruneDays: number;
+}
+export declare function pruneCache(options: PruneCacheOptions): Promise<void>;

package/lib/commands/cache/runners/ClearCacheRunner.d.ts

@@ -0,0 +1,5 @@
+import type { TargetRunner, TargetRunnerOptions } from "@lage-run/scheduler-types";
+export declare class ClearCacheRunner implements TargetRunner {
+    shouldRun(): Promise<boolean>;
+    run(runOptions: TargetRunnerOptions): Promise<void>;
+}

package/lib/commands/cache/runners/PruneCacheRunner.d.ts

@@ -0,0 +1,5 @@
+import type { TargetRunner, TargetRunnerOptions } from "@lage-run/scheduler-types";
+export declare class PruneCacheRunner implements TargetRunner {
+    shouldRun(): Promise<boolean>;
+    run(runOptions: TargetRunnerOptions): Promise<void>;
+}

package/lib/commands/createReporter.d.ts

@@ -0,0 +1,3 @@
+import { JsonReporter, AdoReporter, LogReporter, ProgressReporter, ChromeTraceEventsReporter } from "@lage-run/reporters";
+import type { ReporterInitOptions } from "../types/ReporterInitOptions.js";
+export declare function createReporter(reporter: string, options: ReporterInitOptions): ChromeTraceEventsReporter | JsonReporter | AdoReporter | ProgressReporter | LogReporter;

package/lib/commands/initializeReporters.d.ts

@@ -0,0 +1,3 @@
+import type { Logger } from "@lage-run/logger";
+import type { ReporterInitOptions } from "../types/ReporterInitOptions.js";
+export declare function initializeReporters(logger: Logger, options: ReporterInitOptions): import("@lage-run/logger").Reporter<import("@lage-run/logger").LogStructuredData>[];

package/lib/commands/isRunningFromCI.d.ts

@@ -0,0 +1 @@
+export declare const isRunningFromCI: boolean;

package/lib/commands/run/action.d.ts

@@ -0,0 +1,23 @@
+import type { Command } from "commander";
+import type { ReporterInitOptions } from "../../types/ReporterInitOptions.js";
+interface RunOptions extends ReporterInitOptions {
+    concurrency: number;
+    profile: string | boolean | undefined;
+    dependencies: boolean;
+    dependents: boolean;
+    since: string;
+    to: string[];
+    scope: string[];
+    skipLocalCache: boolean;
+    continue: boolean;
+    cache: boolean;
+    resetCache: boolean;
+    nodeArg: string;
+    ignore: string[];
+    unstableWatch: boolean;
+    info: boolean;
+    maxWorkersPerTask: string[];
+    allowNoTargetRuns: boolean;
+}
+export declare function action(options: RunOptions, command: Command): Promise<void>;
+export {};

package/lib/commands/run/createCacheProvider.d.ts

@@ -0,0 +1,15 @@
+import type { CacheOptions } from "@lage-run/cache";
+import { RemoteFallbackCacheProvider, TargetHasher } from "@lage-run/cache";
+import type { Logger } from "@lage-run/logger";
+interface CreateCacheOptions {
+    cacheOptions?: CacheOptions;
+    logger: Logger;
+    root: string;
+    skipLocalCache: boolean;
+    cliArgs: string[];
+}
+export declare function createCache(options: CreateCacheOptions): {
+    cacheProvider: RemoteFallbackCacheProvider;
+    hasher: TargetHasher;
+};
+export {};

package/lib/commands/run/createTargetGraph.d.ts

@@ -0,0 +1,21 @@
+import type { Logger } from "@lage-run/logger";
+import type { PackageInfos } from "workspace-tools";
+import type { PipelineDefinition } from "../../types/PipelineDefinition.js";
+interface CreateTargetGraphOptions {
+    logger: Logger;
+    root: string;
+    dependencies: boolean;
+    dependents: boolean;
+    since: string;
+    scope: string[];
+    ignore: string[];
+    repoWideChanges: string[];
+    pipeline: PipelineDefinition;
+    outputs: string[];
+    tasks: string[];
+    packageInfos: PackageInfos;
+}
+export declare function createTargetGraph(options: CreateTargetGraphOptions): {
+    targets: Map<string, import("@lage-run/target-graph").Target>;
+};
+export {};

package/lib/commands/run/filterArgsForTasks.d.ts

@@ -0,0 +1,4 @@
+export declare function filterArgsForTasks(args: string[]): {
+    tasks: string[];
+    taskArgs: string[];
+};

package/lib/commands/run/filterPipelineDefinitions.d.ts

@@ -0,0 +1,3 @@
+import type { Target } from "@lage-run/target-graph";
+import type { PipelineDefinition } from "../../types/PipelineDefinition.js";
+export declare function filterPipelineDefinitions(targets: IterableIterator<Target>, pipeline: PipelineDefinition): PipelineDefinition;

package/lib/commands/run/index.d.ts

@@ -0,0 +1,3 @@
+import { Command } from "commander";
+declare const runCommand: Command;
+export { runCommand };

package/lib/commands/run/infoAction.d.ts

@@ -0,0 +1,14 @@
+import type { Command } from "commander";
+import type { ReporterInitOptions } from "../../types/ReporterInitOptions.js";
+interface RunOptions extends ReporterInitOptions {
+    dependencies: boolean;
+    dependents: boolean;
+    since: string;
+    scope: string[];
+    to: string[];
+    cache: boolean;
+    nodeArg: string;
+    ignore: string[];
+}
+export declare function infoAction(options: RunOptions, command: Command): Promise<void>;
+export {};

package/lib/commands/run/runAction.d.ts

@@ -0,0 +1,16 @@
+import type { Command } from "commander";
+import type { ReporterInitOptions } from "../../types/ReporterInitOptions.js";
+import type { FilterOptions } from "../../types/FilterOptions.js";
+interface RunOptions extends ReporterInitOptions, FilterOptions {
+    concurrency: number;
+    maxWorkersPerTask: string[];
+    profile: string | boolean | undefined;
+    skipLocalCache: boolean;
+    continue: boolean;
+    cache: boolean;
+    resetCache: boolean;
+    nodeArg: string;
+    allowNoTargetRuns: boolean;
+}
+export declare function runAction(options: RunOptions, command: Command): Promise<void>;
+export {};

package/lib/commands/run/runners/NpmScriptRunner.d.ts

@@ -0,0 +1 @@
+export { NpmScriptRunner } from "@lage-run/scheduler";

package/lib/commands/run/runners/WorkerRunner.d.ts

@@ -0,0 +1 @@
+export { WorkerRunner } from "@lage-run/scheduler";

package/lib/commands/run/watchAction.d.ts

@@ -0,0 +1,16 @@
+import type { Command } from "commander";
+import type { ReporterInitOptions } from "../../types/ReporterInitOptions.js";
+import type { FilterOptions } from "../../types/FilterOptions.js";
+interface RunOptions extends ReporterInitOptions, FilterOptions {
+    concurrency: number;
+    maxWorkersPerTask: string[];
+    profile: string | boolean | undefined;
+    skipLocalCache: boolean;
+    continue: boolean;
+    cache: boolean;
+    resetCache: boolean;
+    nodeArg: string;
+    allowNoTargetRuns: boolean;
+}
+export declare function watchAction(options: RunOptions, command: Command): Promise<void>;
+export {};

package/lib/commands/run/watcher.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="node" />
+import EventEmitter from "events";
+export declare function watch(cwd: string): EventEmitter;

package/lib/config/getConcurrency.d.ts

@@ -0,0 +1 @@
+export declare function getConcurrency(optionsConcurrency: number | undefined, configConcurrency: number | undefined): number;

package/lib/config/getConfig.d.ts

@@ -0,0 +1,2 @@
+import type { ConfigOptions } from "../types/ConfigOptions.js";
+export declare function getConfig(cwd: string): Promise<ConfigOptions>;

package/lib/config/getMaxWorkersPerTask.d.ts

@@ -0,0 +1,3 @@
+import type { ConfigOptions } from "../types/ConfigOptions.js";
+export declare function getMaxWorkersPerTask(pipelineConfig: ConfigOptions["pipeline"], concurrency: number): Map<string, number>;
+export declare function getMaxWorkersPerTaskFromOptions(maxWorkersPerTask: string[]): Map<string, number>;

package/lib/config/getMaxWorkersPerTask.js

@@ -44,10 +44,10 @@ function getMaxWorkersPerTask(pipelineConfig, concurrency) {
     // try to adjust the maxWorkersPerTask to fit the concurrency
     if (grandTotal > concurrency) {
         let newTotal = 0;
-        for (const [task1, maxWorkers1] of maxWorkersPerTask.entries()){
-            const newMaxWorkers = Math.max(1, Math.floor(maxWorkers1 / grandTotal * concurrency));
+        for (const [task, maxWorkers] of maxWorkersPerTask.entries()){
+            const newMaxWorkers = Math.max(1, Math.floor(maxWorkers / grandTotal * concurrency));
             newTotal += newMaxWorkers;
-            maxWorkersPerTask.set(task1, newMaxWorkers);
+            maxWorkersPerTask.set(task, newMaxWorkers);
         }
         if (newTotal > concurrency) {
             throw new Error("Could not adjust maxWorkers per task to fit the concurrency, try reducing the maxWorkers, or increasing the --concurrency CLI argument, or separate the tasks to be run");

package/lib/filter/getFilteredPackages.d.ts

@@ -0,0 +1,21 @@
+import type { PackageInfos } from "workspace-tools";
+import type { Logger } from "@lage-run/logger";
+export declare function getFilteredPackages(options: {
+    root: string;
+    packageInfos: PackageInfos;
+    logger: Logger;
+    scope: string[] | undefined;
+    since: string | undefined;
+    sinceIgnoreGlobs: string[] | undefined;
+    repoWideChanges: string[];
+    includeDependents: boolean;
+    includeDependencies: boolean;
+}): string[];
+export declare function filterPackages(options: {
+    logger: Logger;
+    packageInfos: PackageInfos;
+    includeDependents: boolean;
+    includeDependencies: boolean;
+    scopedPackages: string[] | undefined;
+    changedPackages: string[] | undefined;
+}): string[];

package/lib/index.d.ts

@@ -0,0 +1 @@
+export type { ConfigOptions } from "./types/ConfigOptions.js";

package/lib/showHelp.d.ts

@@ -0,0 +1 @@
+export declare function showHelp(msg: string): void;

package/lib/types/CacheOptions.d.ts

@@ -0,0 +1,7 @@
+import type { Config as BackfillCacheOptions } from "backfill-config";
+export type CacheOptions = BackfillCacheOptions & {
+    environmentGlob: string[];
+    cacheKey: string;
+    writeRemoteCache: boolean;
+    skipLocalCache: boolean;
+};

package/lib/types/ConfigOptions.d.ts

@@ -0,0 +1,56 @@
+import type { CacheOptions } from "./CacheOptions.js";
+import type { Priority } from "./Priority.js";
+import type { PipelineDefinition } from "./PipelineDefinition.js";
+import type { LoggerOptions } from "./LoggerOptions.js";
+import type { TargetRunnerPickerOptions } from "@lage-run/scheduler";
+export type NpmClient = "npm" | "yarn" | "pnpm";
+export interface ConfigOptions {
+    /**
+     * Defines the task pipeline, prefix with "^" character to denote a direct topological dependency,
+     * prefix with ^^ to denote a transitive topological dependency.
+     *
+     * Example:
+     *
+     * ```
+     * {
+     *   build: ["^build"],
+     *   test: ["build"],
+     *   lint: []
+     *   bundle: ["^^transpile"],
+     *   transpile: [],
+     * }
+     * ```
+     */
+    pipeline: PipelineDefinition;
+    /** Backfill cache options */
+    cacheOptions: CacheOptions;
+    /** Which files to ignore when calculating scopes with --since */
+    ignore: string[];
+    /** disables --since flag when any of this list of files changed */
+    repoWideChanges: string[];
+    /** Which NPM Client to use when running npm lifecycle scripts */
+    npmClient: NpmClient;
+    /** Optional priority to set on tasks in a package to make the scheduler give priority to tasks on the critical path for high priority tasks */
+    priorities: Priority[];
+    /**
+     * Options that will be sent to all log reporters.
+     */
+    loggerOptions: LoggerOptions;
+    /**
+     * Custom runners for tasks in the pipeline. The key is the task name, and the value is a configuration describing what would be
+     * passed to the runner constructor.
+     */
+    runners: TargetRunnerPickerOptions;
+    /**
+     * Maximum worker idle memory, this would cause workers to restart if they exceed this limit. This is useful to prevent memory leaks.
+     */
+    workerIdleMemoryLimit: number;
+    /**
+     * Maximum number of concurrent tasks to run
+     */
+    concurrency: number;
+    /**
+     * Allows for no targets run
+     */
+    allowNoTargetRuns: boolean;
+}

package/lib/types/FilterOptions.d.ts

@@ -0,0 +1,9 @@
+export interface FilterOptions {
+    dependencies: boolean;
+    dependents: boolean;
+    since: string;
+    scope: string[];
+    to: string[];
+    ignore: string[];
+    allowNoTargetRuns: boolean;
+}

package/lib/types/LoggerOptions.d.ts

@@ -0,0 +1,15 @@
+import type { LogLevel } from "@lage-run/logger";
+export interface LoggerOptions {
+    disp?: {
+        [level: string]: string;
+    };
+    style?: {
+        [level: string]: {
+            fg?: string;
+            bg?: string;
+        };
+    };
+    levels?: {
+        [level: string]: LogLevel;
+    };
+}

package/lib/types/PipelineDefinition.d.ts

@@ -0,0 +1,12 @@
+import type { TargetConfig } from "@lage-run/target-graph";
+import type { ConfigOptions } from "./ConfigOptions.js";
+export interface FactoryArgs {
+    cwd: string;
+    config: ConfigOptions;
+}
+export interface TargetConfigFactory {
+    (args: FactoryArgs): TargetConfig | TargetConfig[];
+}
+export interface PipelineDefinition {
+    [task: string]: string[] | TargetConfig;
+}

package/lib/types/Priority.d.ts

@@ -0,0 +1,8 @@
+export interface Priority {
+    /** package name, as in package.json */
+    package?: string;
+    /** task name, as listed in the `scripts` section of package.json */
+    task: string;
+    /** priority, the higher the more priority; undefined priority means lowest priority*/
+    priority: number;
+}

package/lib/types/ReporterInitOptions.d.ts

@@ -0,0 +1,10 @@
+import type { LogLevel } from "@lage-run/logger";
+export interface ReporterInitOptions {
+    reporter: string[] | string;
+    progress: boolean;
+    verbose: boolean;
+    grouped: boolean;
+    concurrency: number;
+    logLevel: keyof typeof LogLevel;
+    profile?: boolean | string;
+}

package/lib/types/errors.d.ts

@@ -0,0 +1 @@
+export declare const NoTargetFoundError: Error;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lage-run/cli",
-  "version": "0.8.1",
+  "version": "0.8.3",
   "description": "Command Line Interface for Lage",
   "repository": {
     "url": "https://github.com/microsoft/lage"
@@ -20,13 +20,13 @@
   "dependencies": {
     "@lage-run/find-npm-client": "^0.1.4",
     "@lage-run/logger": "^1.2.2",
-    "@lage-run/scheduler": "^0.8.2",
-    "@lage-run/scheduler-types": "^0.3.0",
-    "@lage-run/target-graph": "^0.6.1",
-    "@lage-run/cache": "^0.2.3",
-    "@lage-run/reporters": "^1.0.0",
+    "@lage-run/scheduler": "^0.8.4",
+    "@lage-run/scheduler-types": "^0.3.1",
+    "@lage-run/target-graph": "^0.6.2",
+    "@lage-run/cache": "^0.2.4",
+    "@lage-run/reporters": "^1.0.1",
     "commander": "^9.4.0",
-    "workspace-tools": "^0.29.0",
+    "workspace-tools": "^0.30.0",
     "chokidar": "3.5.3",
     "fast-glob": "^3.2.11",
     "cosmiconfig": "^7.0.0"