@rushstack/rush-sdk 5.64.0 → 5.66.0

package/README.md

@@ -23,8 +23,8 @@ Verbose logging can be turn on by set environment variable `RUSH_SDK_DEBUG` to `
 ## Links
 
 - [CHANGELOG.md](
-  https://github.com/microsoft/rushstack/blob/master/apps/rush/CHANGELOG.md) - Find
+  https://github.com/microsoft/rushstack/blob/main/apps/rush/CHANGELOG.md) - Find
   out what's new in the latest version
-- [API Reference](https://rushstack.io/pages/api/rush-lib/)
+- [API Reference](https://api.rushstack.io/pages/rush-lib/)
 
 Rush is part of the [Rush Stack](https://rushstack.io/) family of projects.

package/dist/rush-lib.d.ts

@@ -5,6 +5,7 @@
 
 /// <reference types="node" />
 
+import { AsyncParallelHook } from 'tapable';
 import { AsyncSeriesHook } from 'tapable';
 import { AsyncSeriesWaterfallHook } from 'tapable';
 import type { CollatedWriter } from '@rushstack/stream-collator';
@@ -1228,6 +1229,7 @@ declare interface IRushConfigurationJson {
     approvedPackagesPolicy?: IApprovedPackagesPolicyJson;
     gitPolicy?: IRushGitPolicyJson;
     telemetryEnabled?: boolean;
+    allowedProjectTags?: string[];
     projects: IRushConfigurationProjectJson[];
     eventHooks?: IEventHooksJson;
     hotfixChangeEnabled?: boolean;
@@ -1250,6 +1252,7 @@ declare interface IRushConfigurationProjectJson {
     shouldPublish?: boolean;
     skipRushCheck?: boolean;
     publishFolder?: string;
+    tags?: string[];
 }
 
 /**
@@ -1268,6 +1271,10 @@ declare interface IRushConfigurationProjectOptions {
      * A unique string name for this project
      */
     tempProjectName: string;
+    /**
+     * If specified, validate project tags against this list.
+     */
+    allowedProjectTags: Set<string> | undefined;
 }
 
 /**
@@ -1357,6 +1364,43 @@ declare interface IRushVariantOptionsJson {
     description: string;
 }
 
+/**
+ * @beta
+ */
+export declare interface ITelemetryData {
+    /**
+     * Command name
+     * @example 'build'
+     */
+    readonly name: string;
+    /**
+     * Duration in seconds
+     */
+    readonly durationInSeconds: number;
+    /**
+     * The result of the command
+     */
+    readonly result: 'Succeeded' | 'Failed';
+    /**
+     * The timestamp of the telemetry logging
+     * @example 1648001893024
+     */
+    readonly timestamp?: number;
+    /**
+     * The platform the command was executed on, reads from process.platform
+     * @example darwin, win32, linux...
+     */
+    readonly platform?: string;
+    /**
+     * The rush version
+     * @example 5.63.0
+     */
+    readonly rushVersion?: string;
+    readonly extraData?: {
+        [key: string]: string;
+    };
+}
+
 /**
  * Options for `RushConfiguration.tryFindRushJsonLocation`.
  * @public
@@ -2103,8 +2147,8 @@ export declare class RushConfiguration {
     private _telemetryEnabled;
     private _projects;
     private _projectsByName;
-    private _commonVersionsConfigurations;
-    private _implicitlyPreferredVersions;
+    private _projectsByTag;
+    private _commonVersionsConfigurationsByVariant;
     private _versionPolicyConfiguration;
     private _versionPolicyConfigurationFilePath;
     private _experimentsConfiguration;
@@ -2415,6 +2459,11 @@ export declare class RushConfiguration {
     get telemetryEnabled(): boolean;
     get projects(): RushConfigurationProject[];
     get projectsByName(): Map<string, RushConfigurationProject>;
+    /**
+     * Obtains the mapping from custom tags to projects.
+     * @beta
+     */
+    get projectsByTag(): ReadonlyMap<string, ReadonlySet<RushConfigurationProject>>;
     /**
      * {@inheritDoc NpmOptionsConfiguration}
      */
@@ -2546,7 +2595,6 @@ export declare class RushConfiguration {
      * If the path is not under any project's folder, returns undefined.
      */
     tryGetProjectForPath(currentFolderPath: string): RushConfigurationProject | undefined;
-    private _collectVersionsForDependencies;
     private _getVariantConfigFolderPath;
 }
 
@@ -2572,6 +2620,7 @@ export declare class RushConfigurationProject {
     private readonly _skipRushCheck;
     private readonly _publishFolder;
     private readonly _rushConfiguration;
+    private readonly _tags;
     private _versionPolicy;
     private _dependencyProjects;
     private _consumingProjects;
@@ -2719,6 +2768,11 @@ export declare class RushConfigurationProject {
      * @beta
      */
     get isMainProject(): boolean;
+    /**
+     * The set of tags applied to this project.
+     * @beta
+     */
+    get tags(): ReadonlySet<string>;
 }
 
 /**
@@ -2984,6 +3038,10 @@ export declare class RushLifecycleHooks {
      * A hook map to allow plugins to hook specific named phased commands (defined in command-line.json) before execution.
      */
     runPhasedCommand: HookMap<AsyncSeriesHook<IPhasedCommand>>;
+    /**
+     * A hook to allow plugins to hook custom logic to process telemetry data.
+     */
+    flushTelemetry: AsyncParallelHook<[ReadonlyArray<ITelemetryData>]>;
 }
 
 declare class RushPluginsConfiguration {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rushstack/rush-sdk",
-  "version": "5.64.0",
+  "version": "5.66.0",
   "description": "An API for interacting with the Rush engine",
   "repository": {
     "type": "git",
@@ -12,18 +12,18 @@
   "typings": "dist/rush-lib.d.ts",
   "license": "MIT",
   "dependencies": {
-    "@rushstack/node-core-library": "3.45.1",
+    "@rushstack/node-core-library": "3.45.2",
     "@types/node-fetch": "1.6.9",
     "tapable": "2.2.1"
   },
   "devDependencies": {
-    "@microsoft/rush-lib": "5.64.0",
-    "@rushstack/eslint-config": "2.5.2",
-    "@rushstack/heft": "0.44.5",
-    "@rushstack/heft-node-rig": "1.8.3",
-    "@rushstack/stream-collator": "4.0.160",
-    "@rushstack/ts-command-line": "4.10.7",
-    "@rushstack/terminal": "0.3.29",
+    "@microsoft/rush-lib": "5.66.0",
+    "@rushstack/eslint-config": "2.5.3",
+    "@rushstack/heft": "0.44.8",
+    "@rushstack/heft-node-rig": "1.8.6",
+    "@rushstack/stream-collator": "4.0.163",
+    "@rushstack/ts-command-line": "4.10.8",
+    "@rushstack/terminal": "0.3.32",
     "@types/heft-jest": "1.0.1",
     "@types/semver": "7.3.5",
     "@types/webpack-env": "1.13.0"
@@ -33,5 +33,5 @@
     "_phase:build": "heft build --clean",
     "_phase:test": "heft test --no-build"
   },
-  "readme": "## @rushstack/rush-sdk\n\nThis is a companion package for the Rush tool.  See the [@microsoft/rush](https://www.npmjs.com/package/@microsoft/rush) package for details.\n\n⚠ ***THIS PACKAGE IS EXPERIMENTAL*** ⚠\n\nThe **@rushstack/rush-sdk** package acts as a lightweight proxy for accessing the APIs of the **@microsoft/rush-lib** engine.  It is intended to support three different use cases:\n\n1. Rush plugins should import from **@rushstack/rush-sdk** instead of **@microsoft/rush-lib**.  This gives plugins full access to Rush APIs while avoiding a redundant installation of those packages.  At runtime, the APIs will be bound to the correct `rushVersion` from **rush.json**, and guaranteed to be the same **@microsoft/rush-lib** module instance as the plugin host.\n\n2. When authoring unit tests for a Rush plugin, developers should add **@microsoft/rush-lib** to their **package.json** `devDependencies`.  In this context, **@rushstack/rush-sdk** will resolve to that instance for testing purposes.\n\n3. For scripts and tools that are designed to be used in a Rush monorepo, in the future **@rushstack/rush-sdk** will automatically invoke **install-run-rush.js** and load the local installation.  This ensures that tools load a compatible version of the Rush engine for the given branch.  Once this is implemented, **@rushstack/rush-sdk** can replace **@microsoft/rush-lib** entirely as the official API interface, with the latter serving as the underlying implementation.\n\n\nThe **@rushstack/rush-sdk** API declarations are identical to the corresponding version of **@microsoft/rush-lib**.\n\n## Debugging\n\nVerbose logging can be turn on by set environment variable `RUSH_SDK_DEBUG` to `1`\n\n\n## Links\n\n- [CHANGELOG.md](\n  https://github.com/microsoft/rushstack/blob/master/apps/rush/CHANGELOG.md) - Find\n  out what's new in the latest version\n- [API Reference](https://rushstack.io/pages/api/rush-lib/)\n\nRush is part of the [Rush Stack](https://rushstack.io/) family of projects.\n"
+  "readme": "## @rushstack/rush-sdk\n\nThis is a companion package for the Rush tool.  See the [@microsoft/rush](https://www.npmjs.com/package/@microsoft/rush) package for details.\n\n⚠ ***THIS PACKAGE IS EXPERIMENTAL*** ⚠\n\nThe **@rushstack/rush-sdk** package acts as a lightweight proxy for accessing the APIs of the **@microsoft/rush-lib** engine.  It is intended to support three different use cases:\n\n1. Rush plugins should import from **@rushstack/rush-sdk** instead of **@microsoft/rush-lib**.  This gives plugins full access to Rush APIs while avoiding a redundant installation of those packages.  At runtime, the APIs will be bound to the correct `rushVersion` from **rush.json**, and guaranteed to be the same **@microsoft/rush-lib** module instance as the plugin host.\n\n2. When authoring unit tests for a Rush plugin, developers should add **@microsoft/rush-lib** to their **package.json** `devDependencies`.  In this context, **@rushstack/rush-sdk** will resolve to that instance for testing purposes.\n\n3. For scripts and tools that are designed to be used in a Rush monorepo, in the future **@rushstack/rush-sdk** will automatically invoke **install-run-rush.js** and load the local installation.  This ensures that tools load a compatible version of the Rush engine for the given branch.  Once this is implemented, **@rushstack/rush-sdk** can replace **@microsoft/rush-lib** entirely as the official API interface, with the latter serving as the underlying implementation.\n\n\nThe **@rushstack/rush-sdk** API declarations are identical to the corresponding version of **@microsoft/rush-lib**.\n\n## Debugging\n\nVerbose logging can be turn on by set environment variable `RUSH_SDK_DEBUG` to `1`\n\n\n## Links\n\n- [CHANGELOG.md](\n  https://github.com/microsoft/rushstack/blob/main/apps/rush/CHANGELOG.md) - Find\n  out what's new in the latest version\n- [API Reference](https://api.rushstack.io/pages/rush-lib/)\n\nRush is part of the [Rush Stack](https://rushstack.io/) family of projects.\n"
 }