@lage-run/cli 0.7.3 → 0.8.0

package/CHANGELOG.json

@@ -2,7 +2,22 @@
   "name": "@lage-run/cli",
   "entries": [
     {
-      "date": "Tue, 31 Jan 2023 23:54:40 GMT",
+      "date": "Fri, 03 Feb 2023 00:20:00 GMT",
+      "tag": "@lage-run/cli_v0.8.0",
+      "version": "0.8.0",
+      "comments": {
+        "minor": [
+          {
+            "author": "kchau@microsoft.com",
+            "package": "@lage-run/cli",
+            "commit": "9772c8f6e81edac6a8ae1b4a4c26b1cb8c0986b0",
+            "comment": "adding an affected command"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Tue, 31 Jan 2023 23:54:49 GMT",
       "tag": "@lage-run/cli_v0.7.3",
       "version": "0.7.3",
       "comments": {

package/CHANGELOG.md

@@ -1,12 +1,20 @@
 # Change Log - @lage-run/cli
 
-This log was last generated on Tue, 31 Jan 2023 23:54:40 GMT and should not be manually modified.
+This log was last generated on Fri, 03 Feb 2023 00:20:00 GMT and should not be manually modified.
 
 <!-- Start content -->
 
+## 0.8.0
+
+Fri, 03 Feb 2023 00:20:00 GMT
+
+### Minor changes
+
+- adding an affected command (kchau@microsoft.com)
+
 ## 0.7.3
 
-Tue, 31 Jan 2023 23:54:40 GMT
+Tue, 31 Jan 2023 23:54:49 GMT
 
 ### Patches
 

package/lib/cli.js

@@ -6,12 +6,14 @@ const _commander = require("commander");
 const _indexJs = require("./commands/run/index.js");
 const _indexJs1 = require("./commands/cache/index.js");
 const _errorsJs = require("./types/errors.js");
+const _indexJs2 = require("./commands/affected/index.js");
 async function main() {
     const program = new _commander.Command();
     program.addCommand(_indexJs.runCommand, {
         isDefault: true
     });
     program.addCommand(_indexJs1.cacheCommand);
+    program.addCommand(_indexJs2.affectedCommand);
     await program.parseAsync(process.argv);
 }
 main().catch((err)=>{

package/lib/commands/addFilterOptions.js

@@ -7,5 +7,5 @@ Object.defineProperty(exports, "addFilterOptions", {
     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");
+    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", []);
 }

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

@@ -0,0 +1,105 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "affectedAction", {
+    enumerable: true,
+    get: ()=>affectedAction
+});
+const _logger = /*#__PURE__*/ _interopRequireDefault(require("@lage-run/logger"));
+const _workspaceTools = require("workspace-tools");
+const _getConfigJs = require("../../config/getConfig.js");
+const _getFilteredPackagesJs = require("../../filter/getFilteredPackages.js");
+function _interopRequireDefault(obj) {
+    return obj && obj.__esModule ? obj : {
+        default: obj
+    };
+}
+async function affectedAction(options) {
+    const { dependencies , dependents , since , scope , ignore , outputFormat  } = options;
+    const cwd = process.cwd();
+    const config = await (0, _getConfigJs.getConfig)(cwd);
+    const logger = (0, _logger.default)();
+    const root = (0, _workspaceTools.getWorkspaceRoot)(cwd);
+    const packageInfos = (0, _workspaceTools.getPackageInfos)(root);
+    const packages = (0, _getFilteredPackagesJs.getFilteredPackages)({
+        root,
+        logger,
+        packageInfos,
+        includeDependencies: dependencies,
+        includeDependents: dependents,
+        since,
+        scope,
+        repoWideChanges: config.repoWideChanges,
+        sinceIgnoreGlobs: ignore
+    });
+    let output = "";
+    switch(outputFormat){
+        case "graph":
+            output = renderGraph({
+                packages,
+                packageInfos
+            });
+            break;
+        case "json":
+            output = renderJson({
+                packages,
+                packageInfos
+            });
+            break;
+        default:
+            output = renderDefault({
+                packages
+            });
+            break;
+    }
+    // eslint-disable-next-line no-console
+    console.log(output);
+}
+function renderDefault(props) {
+    const { packages  } = props;
+    return `
+All Affected Packages
+---------------------
+
+${packages.join("\n")}
+`;
+}
+function renderJson(props) {
+    const graph = generatePackageGraph(props);
+    return JSON.stringify(graph);
+}
+function renderGraph(props) {
+    const graph = generatePackageGraph(props);
+    const { packages  } = graph;
+    const adjacencies = [];
+    for (const [pkg, info] of Object.entries(packages)){
+        for (const dep of info.dependencies){
+            adjacencies.push([
+                pkg,
+                dep
+            ]);
+        }
+    }
+    return `
+digraph affected {
+${adjacencies.map((entry)=>`  "${entry[0]}" -> "${entry[1]}"`).join("\n")}
+}  
+`;
+}
+function generatePackageGraph(props) {
+    const { packages , packageInfos  } = props;
+    const packageGraph = packages.reduce((accum, pkg)=>{
+        const dependencies = Object.keys(packageInfos[pkg].dependencies ?? {}).filter((dep)=>packages.includes(dep));
+        const dependents = Object.keys(packageInfos[pkg].dependents ?? {}).filter((dep)=>packages.includes(dep));
+        accum[pkg] = {
+            dependencies,
+            dependents
+        };
+        return accum;
+    }, {});
+    return {
+        packages: packageGraph,
+        count: packages.length
+    };
+}

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

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

package/lib/commands/affected/index.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "affectedCommand", {
+    enumerable: true,
+    get: ()=>affectedCommand
+});
+const _commander = require("commander");
+const _addFilterOptionsJs = require("../addFilterOptions.js");
+const _actionJs = require("./action.js");
+const affectedCommand = new _commander.Command("affected");
+(0, _addFilterOptionsJs.addFilterOptions)(affectedCommand).action(_actionJs.affectedAction).option("--output-format <graph|json|default>", `Generate a report about what packages are affected by the current change (defaults to human readable format) ` + `"graph" will generate a GraphViz .dot file format`).option("--since <branch>", "Calculate changes since this branch (defaults to origin/master)", "origin/master");

package/lib/commands/run/index.js

@@ -13,7 +13,7 @@ const _isRunningFromCIJs = require("../isRunningFromCI.js");
 const _addFilterOptionsJs = require("../addFilterOptions.js");
 const runCommand = new _commander.Command("run");
 (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", `
+.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").option("--allow-no-target-runs").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/runAction.d.ts

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

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

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

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

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});

package/package.json

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