@lage-run/cli 0.13.2 → 0.15.0

package/CHANGELOG.json

@@ -2,7 +2,107 @@
   "name": "@lage-run/cli",
   "entries": [
     {
-      "date": "Fri, 14 Apr 2023 04:37:34 GMT",
+      "date": "Wed, 26 Apr 2023 04:56:07 GMT",
+      "tag": "@lage-run/cli_v0.15.0",
+      "version": "0.15.0",
+      "comments": {
+        "minor": [
+          {
+            "author": "elcraig@microsoft.com",
+            "package": "@lage-run/cli",
+            "commit": "56910ce2ef67d9d3dc99b7a75df007820e9444c8",
+            "comment": "Add back the init command"
+          },
+          {
+            "author": "beachball",
+            "package": "@lage-run/cli",
+            "comment": "Bump @lage-run/config to v0.2.0",
+            "commit": "56910ce2ef67d9d3dc99b7a75df007820e9444c8"
+          },
+          {
+            "author": "beachball",
+            "package": "@lage-run/cli",
+            "comment": "Bump @lage-run/scheduler to v0.11.4",
+            "commit": "56910ce2ef67d9d3dc99b7a75df007820e9444c8"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Tue, 25 Apr 2023 02:51:19 GMT",
+      "tag": "@lage-run/cli_v0.14.0",
+      "version": "0.14.0",
+      "comments": {
+        "minor": [
+          {
+            "author": "stchur@microsoft.com",
+            "package": "@lage-run/cli",
+            "commit": "a2e112e8aafee26380684efca4db994a9c5e3801",
+            "comment": "Add support for --log-file (to be used in concert with --reporter vfl"
+          },
+          {
+            "author": "beachball",
+            "package": "@lage-run/cli",
+            "comment": "Bump @lage-run/config to v0.1.4",
+            "commit": "a2e112e8aafee26380684efca4db994a9c5e3801"
+          },
+          {
+            "author": "beachball",
+            "package": "@lage-run/cli",
+            "comment": "Bump @lage-run/logger to v1.3.0",
+            "commit": "a2e112e8aafee26380684efca4db994a9c5e3801"
+          },
+          {
+            "author": "beachball",
+            "package": "@lage-run/cli",
+            "comment": "Bump @lage-run/scheduler to v0.11.3",
+            "commit": "a2e112e8aafee26380684efca4db994a9c5e3801"
+          },
+          {
+            "author": "beachball",
+            "package": "@lage-run/cli",
+            "comment": "Bump @lage-run/scheduler-types to v0.3.8",
+            "commit": "a2e112e8aafee26380684efca4db994a9c5e3801"
+          },
+          {
+            "author": "beachball",
+            "package": "@lage-run/cli",
+            "comment": "Bump @lage-run/target-graph to v0.8.4",
+            "commit": "a2e112e8aafee26380684efca4db994a9c5e3801"
+          },
+          {
+            "author": "beachball",
+            "package": "@lage-run/cli",
+            "comment": "Bump @lage-run/cache to v0.5.4",
+            "commit": "a2e112e8aafee26380684efca4db994a9c5e3801"
+          },
+          {
+            "author": "beachball",
+            "package": "@lage-run/cli",
+            "comment": "Bump @lage-run/reporters to v1.2.0",
+            "commit": "a2e112e8aafee26380684efca4db994a9c5e3801"
+          }
+        ],
+        "patch": [
+          {
+            "author": "elcraig@microsoft.com",
+            "package": "@lage-run/cli",
+            "commit": "a2e112e8aafee26380684efca4db994a9c5e3801",
+            "comment": "Update repository and homepage"
+          },
+          {
+            "author": "stchur@microsoft.com",
+            "package": "@lage-run/cli",
+            "commit": "a2e112e8aafee26380684efca4db994a9c5e3801",
+            "comment": {
+              "title": "Add reporter cleanup to watchAction"
+            }
+          }
+        ]
+      }
+    },
+    {
+      "date": "Fri, 14 Apr 2023 04:37:54 GMT",
       "tag": "@lage-run/cli_v0.13.2",
       "version": "0.13.2",
       "comments": {

package/CHANGELOG.md

@@ -1,12 +1,42 @@
 # Change Log - @lage-run/cli
 
-This log was last generated on Fri, 14 Apr 2023 04:37:34 GMT and should not be manually modified.
+This log was last generated on Wed, 26 Apr 2023 04:56:07 GMT and should not be manually modified.
 
 <!-- Start content -->
 
+## 0.15.0
+
+Wed, 26 Apr 2023 04:56:07 GMT
+
+### Minor changes
+
+- Add back the init command (elcraig@microsoft.com)
+- Bump @lage-run/config to v0.2.0
+- Bump @lage-run/scheduler to v0.11.4
+
+## 0.14.0
+
+Tue, 25 Apr 2023 02:51:19 GMT
+
+### Minor changes
+
+- Add support for --log-file (to be used in concert with --reporter vfl (stchur@microsoft.com)
+- Bump @lage-run/config to v0.1.4
+- Bump @lage-run/logger to v1.3.0
+- Bump @lage-run/scheduler to v0.11.3
+- Bump @lage-run/scheduler-types to v0.3.8
+- Bump @lage-run/target-graph to v0.8.4
+- Bump @lage-run/cache to v0.5.4
+- Bump @lage-run/reporters to v1.2.0
+
+### Patches
+
+- Update repository and homepage (elcraig@microsoft.com)
+- [object Object] (stchur@microsoft.com)
+
 ## 0.13.2
 
-Fri, 14 Apr 2023 04:37:34 GMT
+Fri, 14 Apr 2023 04:37:54 GMT
 
 ### Patches
 

package/lib/cli.js

@@ -7,6 +7,7 @@ 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");
+const _indexJs3 = require("./commands/init/index.js");
 async function main() {
     const program = new _commander.Command();
     program.addCommand(_indexJs.runCommand, {
@@ -14,6 +15,7 @@ async function main() {
     });
     program.addCommand(_indexJs1.cacheCommand);
     program.addCommand(_indexJs2.affectedCommand);
+    program.addCommand(_indexJs3.initCommand);
     await program.parseAsync(process.argv);
 }
 main().catch((err)=>{

package/lib/commands/addLoggerOptions.js

@@ -19,5 +19,5 @@ function addLoggerOptions(program) {
         "error",
         "verbose",
         "silly"
-    ]).conflicts("verbose")).option("--verbose", "verbose output", false);
+    ]).conflicts("verbose")).addOption(new _commander.Option("--log-file <file>", "when used with --reporter vfl, writes verbose, ungrouped logs to the specified file")).option("--verbose", "verbose output", false);
 }

package/lib/commands/createReporter.d.ts

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

package/lib/commands/createReporter.js

@@ -17,7 +17,7 @@ function _interopRequireDefault(obj) {
     };
 }
 function createReporter(reporter, options) {
-    const { verbose , grouped , logLevel: logLevelName , concurrency , profile , progress  } = options;
+    const { verbose , grouped , logLevel: logLevelName , concurrency , profile , progress , logFile  } = options;
     const logLevel = _logger.LogLevel[logLevelName];
     const root = (0, _workspaceTools.findPackageRoot)(__filename);
     const packageJson = JSON.parse((0, _fs.readFileSync)(_path.default.join(root, "package.json"), "utf-8"));
@@ -44,6 +44,9 @@ function createReporter(reporter, options) {
                 grouped,
                 logLevel: verbose ? _logger.LogLevel.verbose : logLevel
             });
+        case "verboseFileLog":
+        case "vfl":
+            return new _reporters.VerboseFileLogReporter(logFile);
         default:
             if (progress && !(logLevel >= _logger.LogLevel.verbose || verbose || grouped)) {
                 return new _reporters.ProgressReporter({

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

@@ -0,0 +1 @@
+export declare function initAction(): Promise<void>;

package/lib/commands/init/action.js

@@ -0,0 +1,119 @@
+/* eslint-disable no-console -- logger doesn't work in this context */ "use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "initAction", {
+    enumerable: true,
+    get: ()=>initAction
+});
+const _config = require("@lage-run/config");
+const _fs = /*#__PURE__*/ _interopRequireDefault(require("fs"));
+const _path = /*#__PURE__*/ _interopRequireDefault(require("path"));
+const _execa = /*#__PURE__*/ _interopRequireDefault(require("execa"));
+function _interopRequireDefault(obj) {
+    return obj && obj.__esModule ? obj : {
+        default: obj
+    };
+}
+var _packageJson, _packageJson1;
+async function initAction() {
+    const cwd = process.cwd();
+    const config = await (0, _config.readConfigFile)(cwd);
+    if (config) {
+        console.error("lage is already initialized in this workspace");
+        process.exitCode = 1;
+        return;
+    }
+    console.info("Installing lage and creating a default configuration file");
+    let workspaceManager = "yarn";
+    try {
+        workspaceManager = whichWorkspaceManager(cwd);
+    } catch (e) {
+        console.error("lage requires you to be using a workspace - make sure you are using yarn workspaces, npm workspaces, pnpm workspaces, or rush");
+        process.exitCode = 1;
+        return;
+    }
+    const pipeline = {
+        build: [
+            "^build"
+        ],
+        test: [
+            "build"
+        ],
+        lint: []
+    };
+    const lageConfig = {
+        pipeline,
+        npmClient: workspaceManager === "yarn" ? "yarn" : "npm"
+    };
+    const lageConfigFile = _path.default.join(cwd, "lage.config.js");
+    _fs.default.writeFileSync(lageConfigFile, "module.exports = " + JSON.stringify(lageConfig, null, 2) + ";");
+    installLage(cwd, workspaceManager, pipeline);
+    console.info(`Lage is initialized! You can now run: ${getBuildCommand(workspaceManager)}`);
+}
+function getBuildCommand(workspaceManager) {
+    switch(workspaceManager){
+        case "yarn":
+            return "yarn lage build";
+        case "pnpm":
+            return "pnpm run lage build";
+        case "rush":
+        case "npm":
+            return "npm run lage build";
+    }
+}
+function whichWorkspaceManager(cwd) {
+    const packageJson = readPackageJson(cwd);
+    if (_fs.default.existsSync(_path.default.join(cwd, "rush.json"))) {
+        return "rush";
+    }
+    if (_fs.default.existsSync(_path.default.join(cwd, "yarn.lock")) && packageJson.workspaces) {
+        return "yarn";
+    }
+    if (_fs.default.existsSync(_path.default.join(cwd, "pnpm-workspace.yaml"))) {
+        return "pnpm";
+    }
+    if (_fs.default.existsSync(_path.default.join(cwd, "package-lock.json")) && packageJson.workspaces) {
+        return "npm";
+    }
+    throw new Error("not a workspace");
+}
+async function installLage(cwd, workspaceManager, pipeline) {
+    const lageVersion = getLageVersion();
+    const packageJson = readPackageJson(cwd);
+    (_packageJson = packageJson).scripts ?? (_packageJson.scripts = {});
+    for (const script of Object.keys(pipeline)){
+        packageJson.scripts[script] = `lage ${script}`;
+    }
+    if (workspaceManager === "rush") {
+        packageJson.scripts.lage = `node common/scripts/install-run.js lage@${lageVersion} lage`;
+        writePackageJson(cwd, packageJson);
+    } else {
+        packageJson.scripts.lage = "lage";
+        (_packageJson1 = packageJson).devDependencies ?? (_packageJson1.devDependencies = {});
+        packageJson.devDependencies.lage = lageVersion;
+        writePackageJson(cwd, packageJson);
+        await (0, _execa.default)(workspaceManager, [
+            "install"
+        ], {
+            stdio: "inherit"
+        });
+    }
+}
+function getLageVersion() {
+    const lagePackageJsonFile = require.resolve("../../package.json", {
+        paths: [
+            __dirname
+        ]
+    });
+    const lagePackageJson = JSON.parse(_fs.default.readFileSync(lagePackageJsonFile, "utf-8"));
+    return lagePackageJson.version;
+}
+function writePackageJson(cwd, packageJson) {
+    const packageJsonFile = _path.default.join(cwd, "package.json");
+    _fs.default.writeFileSync(packageJsonFile, JSON.stringify(packageJson, null, 2));
+}
+function readPackageJson(cwd) {
+    const packageJsonFile = _path.default.join(cwd, "package.json");
+    return JSON.parse(_fs.default.readFileSync(packageJsonFile, "utf-8"));
+}

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

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

package/lib/commands/init/index.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "initCommand", {
+    enumerable: true,
+    get: ()=>initCommand
+});
+const _commander = require("commander");
+const _addFilterOptionsJs = require("../addFilterOptions.js");
+const _actionJs = require("./action.js");
+const initCommand = new _commander.Command("init");
+(0, _addFilterOptionsJs.addFilterOptions)(initCommand).description("Install lage in a workspace and create a config file").action(_actionJs.initAction);

package/lib/commands/run/index.js

@@ -67,6 +67,10 @@ Choosing a different reporter while logging (e.g. nice outputs for Azure DevOps)
 
     $ lage build test lint --reporter=azureDevOps
 
+Or combine multiple reporters (e.g. Azure DepOps with VerboseFileLog)
+
+    $ lage build test lint --reporter azureDevOps --reporter vfl --log-file /my/verbose/log.file
+
 Ignoring files when calculating the scope with --since in addition to files specified in lage.config:
 
     $ lage build test lint --since origin/master --ignore "package.json" "yarn.lock" "**/.azure-pipelines/**"

package/lib/commands/run/runAction.js

@@ -29,7 +29,7 @@ async function runAction(options, command) {
     const allowNoTargetRuns = options.allowNoTargetRuns || config.allowNoTargetRuns;
     // Configure logger
     const logger = (0, _logger.default)();
-    (0, _initializeReportersJs.initializeReporters)(logger, {
+    const reporters = (0, _initializeReportersJs.initializeReporters)(logger, {
         ...options,
         concurrency
     });
@@ -96,6 +96,9 @@ async function runAction(options, command) {
     const summary = await scheduler.run(root, targetGraph);
     await scheduler.cleanup();
     displaySummaryAndExit(summary, logger.reporters);
+    for (const reporter of reporters){
+        await reporter.cleanup?.();
+    }
 }
 function displaySummaryAndExit(summary, reporters) {
     if (summary.results !== "success") {

package/lib/commands/run/watchAction.js

@@ -154,5 +154,6 @@ async function watchAction(options, command) {
 function displaySummary(summary, reporters) {
     for (const reporter of reporters){
         reporter.summarize(summary);
+        reporter.cleanup?.();
     }
 }

package/lib/types/ReporterInitOptions.d.ts

@@ -7,4 +7,5 @@ export interface ReporterInitOptions {
     concurrency: number;
     logLevel: keyof typeof LogLevel;
     profile?: boolean | string;
+    logFile?: string;
 }

package/package.json

@@ -1,10 +1,12 @@
 {
   "name": "@lage-run/cli",
-  "version": "0.13.2",
+  "version": "0.15.0",
   "description": "Command Line Interface for Lage",
   "repository": {
+    "type": "git",
     "url": "https://github.com/microsoft/lage"
   },
+  "homepage": "https://microsoft.github.io/lage/",
   "bin": {
     "lage": "./bin/lage"
   },
@@ -18,22 +20,23 @@
     "lint": "monorepo-scripts lint"
   },
   "dependencies": {
-    "@lage-run/config": "^0.1.3",
+    "@lage-run/cache": "^0.5.4",
+    "@lage-run/config": "^0.2.0",
     "@lage-run/find-npm-client": "^0.1.4",
-    "@lage-run/logger": "^1.2.2",
-    "@lage-run/scheduler": "^0.11.2",
-    "@lage-run/scheduler-types": "^0.3.7",
-    "@lage-run/target-graph": "^0.8.3",
-    "@lage-run/cache": "^0.5.3",
-    "@lage-run/reporters": "^1.1.2",
-    "commander": "^9.4.0",
-    "workspace-tools": "^0.34.0",
+    "@lage-run/logger": "^1.3.0",
+    "@lage-run/reporters": "^1.2.0",
+    "@lage-run/scheduler": "^0.11.4",
+    "@lage-run/scheduler-types": "^0.3.8",
+    "@lage-run/target-graph": "^0.8.4",
     "chokidar": "3.5.3",
-    "fast-glob": "^3.2.11"
+    "commander": "^9.4.0",
+    "execa": "5.1.1",
+    "fast-glob": "^3.2.11",
+    "workspace-tools": "^0.34.0"
   },
   "devDependencies": {
-    "monorepo-scripts": "*",
-    "@lage-run/monorepo-fixture": "*"
+    "@lage-run/monorepo-fixture": "*",
+    "monorepo-scripts": "*"
   },
   "publishConfig": {
     "access": "public"