refactor(@angular/cli): add AI config tool to GA tracking

alan-agius4 · alan-agius4 · commit f5bccbdd9ac2 · 2025-08-15T11:03:52.000Z
This commit adds the AI config tool option to GA tracking. Since this option is an array we had to work around a limitation that custom dimensions cannot have an array as value.
diff --git a/docs/design/analytics.md b/docs/design/analytics.md
@@ -55,6 +55,7 @@ PROJECT NAME TO BUILD OR A MODULE NAME.**
 | Name | Parameter | Type |
 |:---:|:---|:---|
 | Command | `ep.ng_command` | `string` |
+| AiConfigTool | `ep.ng_ai_config_tool` | `string` |
 | SchematicCollectionName | `ep.ng_schematic_collection_name` | `string` |
 | SchematicName | `ep.ng_schematic_name` | `string` |
 | Standalone | `ep.ng_standalone` | `string` |
diff --git a/packages/angular/cli/src/analytics/analytics-parameters.mts b/packages/angular/cli/src/analytics/analytics-parameters.mts
@@ -69,6 +69,7 @@ export enum UserCustomDimension {
  */
 export enum EventCustomDimension {
   Command = 'ep.ng_command',
+  AiConfigTool = 'ep.ng_ai_config_tool',
   SchematicCollectionName = 'ep.ng_schematic_collection_name',
   SchematicName = 'ep.ng_schematic_name',
   Standalone = 'ep.ng_standalone',
diff --git a/packages/angular/cli/src/analytics/analytics-parameters.ts b/packages/angular/cli/src/analytics/analytics-parameters.ts
@@ -71,6 +71,7 @@ export enum UserCustomDimension {
  */
 export enum EventCustomDimension {
   Command = 'ep.ng_command',
+  AiConfigTool = 'ep.ng_ai_config_tool',
   SchematicCollectionName = 'ep.ng_schematic_collection_name',
   SchematicName = 'ep.ng_schematic_name',
   Standalone = 'ep.ng_standalone',
diff --git a/packages/angular/cli/src/command-builder/command-module.ts b/packages/angular/cli/src/command-builder/command-module.ts
@@ -89,7 +89,10 @@ export abstract class CommandModule<T extends {} = {}> implements CommandModuleI
   protected readonly shouldReportAnalytics: boolean = true;
   readonly scope: CommandScope = CommandScope.Both;
 
-  private readonly optionsWithAnalytics = new Map<string, string>();
+  private readonly optionsWithAnalytics = new Map<
+    string,
+    EventCustomDimension | EventCustomMetric
+  >();
 
   constructor(protected readonly context: CommandContext) {}
 
@@ -236,12 +239,16 @@ export abstract class CommandModule<T extends {} = {}> implements CommandModuleI
     ]);
 
     for (const [name, ua] of this.optionsWithAnalytics) {
+      if (!validEventCustomDimensionAndMetrics.has(ua)) {
+        continue;
+      }
+
       const value = options[name];
-      if (
-        (typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean') &&
-        validEventCustomDimensionAndMetrics.has(ua as EventCustomDimension | EventCustomMetric)
-      ) {
-        parameters[ua as EventCustomDimension | EventCustomMetric] = value;
+      if (typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean') {
+        parameters[ua] = value;
+      } else if (Array.isArray(value)) {
+        // GA doesn't allow array as values.
+        parameters[ua] = value.sort().join(', ');
       }
     }
 
diff --git a/packages/angular/cli/src/command-builder/schematics-command-module.ts b/packages/angular/cli/src/command-builder/schematics-command-module.ts
@@ -204,11 +204,13 @@ export abstract class SchematicsCommandModule
                     ? {
                         name: item,
                         value: item,
+                        checked: item === definition.default,
                       }
                     : {
                         ...item,
                         name: item.label,
                         value: item.value,
+                        checked: item.value === definition.default,
                       },
                 ),
               });
diff --git a/packages/angular/cli/src/command-builder/utilities/json-schema.ts b/packages/angular/cli/src/command-builder/utilities/json-schema.ts
@@ -8,6 +8,7 @@
 
 import { json, strings } from '@angular-devkit/core';
 import type { Arguments, Argv, PositionalOptions, Options as YargsOptions } from 'yargs';
+import { EventCustomDimension } from '../../analytics/analytics-parameters';
 
 /**
  * An option description.
@@ -280,10 +281,10 @@ export function addSchemaOptionsToCommand<T>(
   localYargs: Argv<T>,
   options: Option[],
   includeDefaultValues: boolean,
-): Map<string, string> {
+): Map<string, EventCustomDimension> {
   const booleanOptionsWithNoPrefix = new Set<string>();
   const keyValuePairOptions = new Set<string>();
-  const optionsWithAnalytics = new Map<string, string>();
+  const optionsWithAnalytics = new Map<string, EventCustomDimension>();
 
   for (const option of options) {
     const {
@@ -338,7 +339,7 @@ export function addSchemaOptionsToCommand<T>(
 
     // Record option of analytics.
     if (userAnalytics !== undefined) {
-      optionsWithAnalytics.set(name, userAnalytics);
+      optionsWithAnalytics.set(name, userAnalytics as EventCustomDimension);
     }
   }
 
diff --git a/packages/schematics/angular/ai-config/schema.json b/packages/schematics/angular/ai-config/schema.json
@@ -12,6 +12,7 @@
       "default": "none",
       "x-prompt": "Which AI tools do you want to configure with Angular best practices? https://angular.dev/ai/develop-with-ai",
       "description": "Specifies which AI tools to generate configuration files for. These file are used to improve the outputs of AI tools by following the best practices.",
+      "x-user-analytics": "ep.ng_ai_config_tool",
       "items": {
         "type": "string",
         "enum": ["none", "gemini", "copilot", "claude", "cursor", "jetbrains", "windsurf"]
diff --git a/packages/schematics/angular/ng-new/schema.json b/packages/schematics/angular/ng-new/schema.json
@@ -147,6 +147,7 @@
       "type": "array",
       "uniqueItems": true,
       "description": "Specifies which AI tools to generate configuration files for. These file are used to improve the outputs of AI tools by following the best practices.",
+      "x-user-analytics": "ep.ng_ai_config_tool",
       "items": {
         "type": "string",
         "enum": ["none", "gemini", "copilot", "claude", "cursor", "jetbrains", "windsurf"]
