@lage-run/cli 0.6.3 → 0.7.0

package/CHANGELOG.json

@@ -2,7 +2,37 @@
   "name": "@lage-run/cli",
   "entries": [
     {
-      "date": "Fri, 27 Jan 2023 00:28:03 GMT",
+      "date": "Fri, 27 Jan 2023 20:50:19 GMT",
+      "tag": "@lage-run/cli_v0.7.0",
+      "version": "0.7.0",
+      "comments": {
+        "minor": [
+          {
+            "author": "kchau@microsoft.com",
+            "package": "@lage-run/cli",
+            "commit": "2d6b70f69754030e144521409d3d5d6704746612",
+            "comment": "adding an info flag for run"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Fri, 27 Jan 2023 20:02:06 GMT",
+      "tag": "@lage-run/cli_v0.6.4",
+      "version": "0.6.4",
+      "comments": {
+        "patch": [
+          {
+            "author": "kchau@microsoft.com",
+            "package": "@lage-run/cli",
+            "commit": "597b0e8ad233f460a0d16e0996079fa97bd9de14",
+            "comment": "make sure to take the task args into account for caching"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Fri, 27 Jan 2023 00:28:15 GMT",
       "tag": "@lage-run/cli_v0.6.3",
       "version": "0.6.3",
       "comments": {

package/CHANGELOG.md

@@ -1,12 +1,28 @@
 # Change Log - @lage-run/cli
 
-This log was last generated on Fri, 27 Jan 2023 00:28:03 GMT and should not be manually modified.
+This log was last generated on Fri, 27 Jan 2023 20:50:19 GMT and should not be manually modified.
 
 <!-- Start content -->
 
+## 0.7.0
+
+Fri, 27 Jan 2023 20:50:19 GMT
+
+### Minor changes
+
+- adding an info flag for run (kchau@microsoft.com)
+
+## 0.6.4
+
+Fri, 27 Jan 2023 20:02:06 GMT
+
+### Patches
+
+- make sure to take the task args into account for caching (kchau@microsoft.com)
+
 ## 0.6.3
 
-Fri, 27 Jan 2023 00:28:03 GMT
+Fri, 27 Jan 2023 00:28:15 GMT
 
 ### Patches
 

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/addFilterOptions.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "addFilterOptions", {
+    enumerable: true,
+    get: ()=>addFilterOptions
+});
+function addFilterOptions(program) {
+    return program.option("--scope <scope...>", "scopes the run to a subset of packages (by default, includes the dependencies and dependents as well)").option("--no-deps|--no-dependents", "disables running any dependents of the scoped packages").option("--include-dependencies|--dependencies", 'adds the scoped packages dependencies as the "entry points" for the target graph run').option("--to <scope...>", "runs up to a package (shorthand for --scope=<scope...> --no-dependents)").option("--since <since>", "only runs packages that have changed since the given commit, tag, or branch").option("--ignore <ignore...>", "ignores files when calculating the scope with `--since` in addition to the files specified in lage.config", []).option("--allow-no-target-runs");
+}

package/lib/commands/addLoggerOptions.js

@@ -9,7 +9,7 @@ Object.defineProperty(exports, "addLoggerOptions", {
 const _commander = require("commander");
 function addLoggerOptions(program) {
     const isCI = process.env.CI || process.env.TF_BUILD;
-    return program.option("--reporter <reporter...>", "reporter", "npmLog").addOption(new _commander.Option("--progress").conflicts("--reporter").default(!isCI)).addOption(new _commander.Option("--log-level <level>", "log level").choices([
+    return program.option("--reporter <reporter...>", "reporter", "npmLog").option("--grouped", "groups the logs", false).addOption(new _commander.Option("--progress").conflicts("--reporter").default(!isCI)).addOption(new _commander.Option("--log-level <level>", "log level").choices([
         "info",
         "warn",
         "error",

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

@@ -15,6 +15,7 @@ interface RunOptions extends ReporterInitOptions {
     nodeArg: string;
     ignore: string[];
     unstableWatch: boolean;
+    info: boolean;
     maxWorkersPerTask: string[];
     allowNoTargetRuns: boolean;
 }

package/lib/commands/run/action.js

@@ -6,10 +6,13 @@ Object.defineProperty(exports, "action", {
     enumerable: true,
     get: ()=>action
 });
+const _infoActionJs = require("./infoAction.js");
 const _runActionJs = require("./runAction.js");
 const _watchActionJs = require("./watchAction.js");
 async function action(options, command) {
-    if (options.unstableWatch) {
+    if (options.info) {
+        return (0, _infoActionJs.infoAction)(options, command);
+    } else if (options.unstableWatch) {
         return (0, _watchActionJs.watchAction)(options, command);
     } else {
         return (0, _runActionJs.runAction)(options, command);

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

@@ -6,6 +6,7 @@ interface CreateCacheOptions {
     logger: Logger;
     root: string;
     skipLocalCache: boolean;
+    cliArgs: string[];
 }
 export declare function createCache(options: CreateCacheOptions): {
     cacheProvider: RemoteFallbackCacheProvider;

package/lib/commands/run/createCacheProvider.js

@@ -9,7 +9,7 @@ Object.defineProperty(exports, "createCache", {
 const _cache = require("@lage-run/cache");
 const _isRunningFromCIJs = require("../isRunningFromCI.js");
 function createCache(options) {
-    const { cacheOptions , logger , root , skipLocalCache  } = options;
+    const { cacheOptions , logger , root , skipLocalCache , cliArgs  } = options;
     const hasRemoteCacheConfig = !!cacheOptions?.cacheStorageConfig || !!process.env.BACKFILL_CACHE_PROVIDER || !!process.env.BACKFILL_CACHE_PROVIDER_OPTIONS;
     // Create Cache Provider
     const cacheProvider = new _cache.RemoteFallbackCacheProvider({
@@ -38,7 +38,8 @@ function createCache(options) {
     const hasher = new _cache.TargetHasher({
         root,
         environmentGlob: cacheOptions?.environmentGlob ?? [],
-        cacheKey: cacheOptions?.cacheKey
+        cacheKey: cacheOptions?.cacheKey,
+        cliArgs
     });
     return {
         cacheProvider,

package/lib/commands/run/index.js

@@ -10,10 +10,10 @@ const _commander = require("commander");
 const _actionJs = require("./action.js");
 const _addLoggerOptionsJs = require("../addLoggerOptions.js");
 const _isRunningFromCIJs = require("../isRunningFromCI.js");
+const _addFilterOptionsJs = require("../addFilterOptions.js");
 const runCommand = new _commander.Command("run");
-(0, _addLoggerOptionsJs.addLoggerOptions)(runCommand).action(_actionJs.action).option("-c, --concurrency <n>", "concurrency", (value)=>parseInt(value, 10)).option("--max-workers-per-task <maxWorkersPerTarget...>", "set max worker per task, e.g. --max-workers-per-task build=2 test=4", [])// Common Options
-.option("--scope <scope...>", "scopes the run to a subset of packages (by default, includes the dependencies and dependents as well)").option("--no-deps|--no-dependents", "disables running any dependents of the scoped packages").option("--include-dependencies|--dependencies", 'adds the scoped packages dependencies as the "entry points" for the target graph run').option("--since <since>", "only runs packages that have changed since the given commit, tag, or branch").option("--to <scope...>", "runs up to a package (shorthand for --scope=<scope...> --no-dependents)").option("--allow-no-target-runs")// Run Command Options
-.option("--grouped", "groups the logs", false).option("--no-cache", "disables the cache").option("--reset-cache", "resets the cache, filling it after a run").option("--skip-local-cache", "skips caching locally (defaults to true in CI environments)", _isRunningFromCIJs.isRunningFromCI).option("--profile [profile]", "writes a run profile into a file that can be processed by Chromium devtool").option("--ignore <ignore...>", "ignores files when calculating the scope with `--since` in addition to the files specified in lage.config", []).option("--nodearg|--node-arg <nodeArg>", 'arguments to be passed to node (e.g. --nodearg="--max_old_space_size=1234 --heap-prof" - set via "NODE_OPTIONS" environment variable').option("--continue", "continues the run even on error").option("--unstable-watch", "runs in watch mode").allowUnknownOption(true).addHelpCommand("[run] command1 [command2...commandN] [options]", "run commands").addHelpText("after", `
+(0, _addFilterOptionsJs.addFilterOptions)((0, _addLoggerOptionsJs.addLoggerOptions)(runCommand)).action(_actionJs.action).option("-c, --concurrency <n>", "concurrency", (value)=>parseInt(value, 10)).option("--max-workers-per-task <maxWorkersPerTarget...>", "set max worker per task, e.g. --max-workers-per-task build=2 test=4", [])// Run Command Options
+.option("--no-cache", "disables the cache").option("--reset-cache", "resets the cache, filling it after a run").option("--skip-local-cache", "skips caching locally (defaults to true in CI environments)", _isRunningFromCIJs.isRunningFromCI).option("--profile [profile]", "writes a run profile into a file that can be processed by Chromium devtool").option("--nodearg|--node-arg <nodeArg>", 'arguments to be passed to node (e.g. --nodearg="--max_old_space_size=1234 --heap-prof" - set via "NODE_OPTIONS" environment variable').option("--continue", "continues the run even on error").addOption(new _commander.Option("--info", "outputs information about a run action, suitable for calculating shards or as an input for another task runner").conflicts("unstableWatch")).option("--unstable-watch", "runs in watch mode").allowUnknownOption(true).addHelpCommand("[run] command1 [command2...commandN] [options]", "run commands").addHelpText("after", `
 Runs a set of commands in a target graph. The targets are defined by packages and their scripts as defined the package.json files.
 
 Examples

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

@@ -0,0 +1,14 @@
+import type { Command } from "commander";
+import type { ReporterInitOptions } from "@lage-run/reporters";
+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/infoAction.js

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "infoAction", {
+    enumerable: true,
+    get: ()=>infoAction
+});
+const _createCacheProviderJs = require("./createCacheProvider.js");
+const _createTargetGraphJs = require("./createTargetGraph.js");
+const _filterArgsForTasksJs = require("./filterArgsForTasks.js");
+const _getConfigJs = require("../../config/getConfig.js");
+const _workspaceTools = require("workspace-tools");
+const _logger = /*#__PURE__*/ _interopRequireDefault(require("@lage-run/logger"));
+const _targetGraph = require("@lage-run/target-graph");
+function _interopRequireDefault(obj) {
+    return obj && obj.__esModule ? obj : {
+        default: obj
+    };
+}
+async function infoAction(options, command) {
+    const cwd = process.cwd();
+    const config = await (0, _getConfigJs.getConfig)(cwd);
+    const logger = (0, _logger.default)();
+    // Build Target Graph
+    const root = (0, _workspaceTools.getWorkspaceRoot)(process.cwd());
+    const packageInfos = (0, _workspaceTools.getPackageInfos)(root);
+    const { tasks , taskArgs  } = (0, _filterArgsForTasksJs.filterArgsForTasks)(command.args);
+    const targetGraph = (0, _createTargetGraphJs.createTargetGraph)({
+        logger,
+        root,
+        dependencies: options.dependencies,
+        dependents: options.dependents && !options.to,
+        ignore: options.ignore.concat(config.ignore),
+        pipeline: config.pipeline,
+        repoWideChanges: config.repoWideChanges,
+        scope: (options.scope ?? []).concat(options.to ?? []),
+        since: options.since,
+        outputs: config.cacheOptions.outputGlob,
+        tasks,
+        packageInfos
+    });
+    // Make sure we do not attempt writeRemoteCache in info mode
+    config.cacheOptions.writeRemoteCache = false;
+    const { hasher  } = (0, _createCacheProviderJs.createCache)({
+        root,
+        logger,
+        cacheOptions: config.cacheOptions,
+        skipLocalCache: false,
+        cliArgs: taskArgs
+    });
+    const { targets  } = targetGraph;
+    for (const target of targets.values()){
+        if (target.id === (0, _targetGraph.getStartTargetId)()) {
+            continue;
+        }
+        const startIdIndex = target.dependencies.indexOf((0, _targetGraph.getStartTargetId)());
+        target.dependencies.splice(startIdIndex, 1);
+        process.stdout.write(`${JSON.stringify({
+            ...target,
+            hash: await hasher.hash(target)
+        })}\n`);
+    }
+}

package/lib/commands/run/runAction.js

@@ -67,7 +67,8 @@ async function runAction(options, command) {
         root,
         logger,
         cacheOptions: config.cacheOptions,
-        skipLocalCache: options.skipLocalCache
+        skipLocalCache: options.skipLocalCache,
+        cliArgs: taskArgs
     });
     logger.verbose(`Running with ${concurrency} workers`);
     const filteredPipeline = (0, _filterPipelineDefinitionsJs.filterPipelineDefinitions)(targetGraph.targets.values(), config.pipeline);

package/lib/commands/run/watchAction.js

@@ -92,7 +92,8 @@ async function watchAction(options, command) {
         root,
         logger,
         cacheOptions: config.cacheOptions,
-        skipLocalCache: false
+        skipLocalCache: false,
+        cliArgs: taskArgs
     });
     const filteredPipeline = (0, _filterPipelineDefinitionsJs.filterPipelineDefinitions)(targetGraph.targets.values(), config.pipeline);
     const maxWorkersPerTaskMap = (0, _getMaxWorkersPerTaskJs.getMaxWorkersPerTaskFromOptions)(options.maxWorkersPerTask);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lage-run/cli",
-  "version": "0.6.3",
+  "version": "0.7.0",
   "description": "Command Line Interface for Lage",
   "repository": {
     "url": "https://github.com/microsoft/lage"