@rushstack/heft - npm Package Compare versions

Comparing version 0.36.4 to 0.37.0

CHANGELOG.md

 # Change Log - @rushstack/heft
 
-This log was last generated on Fri, 27 Aug 2021 00:07:25 GMT and should not be manually modified.
+This log was last generated on Tue, 31 Aug 2021 00:07:11 GMT and should not be manually modified.
 
+## 0.37.0
+Tue, 31 Aug 2021 00:07:11 GMT
+
+### Minor changes
+
+- Add commandParameters to IMetricsData for recording parameter usage
+
 ## 0.36.4
@@ -6,0 +13,0 @@ Fri, 27 Aug 2021 00:07:25 GMT

dist/heft.d.ts

@@ -467,2 +467,6 @@ import { AsyncParallelHook } from 'tapable';
     machineTotalMemoryMB: number;
+    /**
+     * A map of commandline parameter names to their effective values
+     */
+    commandParameters: Record<string, string>;
 }
@@ -600,5 +604,6 @@
      * @param command - Describe the user command, e.g. `start` or `build`
-     * @param params - Optional parameters
+     * @param parameterMap - Optional map of parameters to their values
+     * @param performanceData - Optional performance data
      */
-    record(command: string, performanceData?: Partial<_IPerformanceData>): void;
+    record(command: string, performanceData?: Partial<_IPerformanceData>, parameters?: Record<string, string>): void;
     /**
@@ -605,0 +610,0 @@ * Flushes all pending logged metrics.

dist/tsdoc-metadata.json

@@ -8,5 +8,5 @@ // This file is read by tools that parse documentation comments conforming to the TSDoc standard.
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.18.6"
+      "packageVersion": "7.18.7"
     }
   ]
 }

lib/cli/actions/HeftActionBase.js

@@ -51,3 +51,3 @@ "use strict";
     recordMetrics() {
-        this.metricsCollector.record(this.actionName);
+        this.metricsCollector.record(this.actionName, undefined, this.getParameterStringMap());
     }
@@ -54,0 +54,0 @@ async onExecute() {

lib/metrics/MetricsCollector.d.ts

@@ -34,2 +34,6 @@ import { AsyncParallelHook, SyncHook } from 'tapable';
     machineTotalMemoryMB: number;
+    /**
+     * A map of commandline parameter names to their effective values
+     */
+    commandParameters: Record<string, string>;
 }
@@ -77,5 +81,6 @@ /**
      * @param command - Describe the user command, e.g. `start` or `build`
-     * @param params - Optional parameters
+     * @param parameterMap - Optional map of parameters to their values
+     * @param performanceData - Optional performance data
      */
-    record(command: string, performanceData?: Partial<IPerformanceData>): void;
+    record(command: string, performanceData?: Partial<IPerformanceData>, parameters?: Record<string, string>): void;
     /**
@@ -82,0 +87,0 @@ * Flushes all pending logged metrics.

lib/metrics/MetricsCollector.js

@@ -73,5 +73,6 @@ "use strict";
      * @param command - Describe the user command, e.g. `start` or `build`
-     * @param params - Optional parameters
+     * @param parameterMap - Optional map of parameters to their values
+     * @param performanceData - Optional performance data
      */
-    record(command, performanceData) {
+    record(command, performanceData, parameters) {
         if (this._startTimeMs === undefined) {
@@ -94,3 +95,4 @@ throw new node_core_library_1.InternalError('MetricsCollector has not been initialized with setStartTime() yet');
             machineProcessor: os.cpus()[0].model,
-            machineTotalMemoryMB: os.totalmem()
+            machineTotalMemoryMB: os.totalmem(),
+            commandParameters: parameters || {}
         };
@@ -97,0 +99,0 @@ this.hooks.recordMetric.call('inner_loop_heft', metricsData);

package.json

 {
 	"name": "@rushstack/heft",
-	"version": "0.36.4",
+	"version": "0.37.0",
 	"description": "Build all your JavaScript projects the same way: A way that works.",
@@ -5,0 +5,0 @@ "keywords": [

No alert changes

Improved metrics

Total package byte prevSize

1121817

increased by0.16%

Lines of code

11699

increased by0.21%

No dependency changes