Merge branch 'master' into release

MaxKless · MaxKless · commit e0e19db9ac85 · 2025-11-06T14:19:33.000+01:00
diff --git a/.github/ISSUE_TEMPLATE/1-bug.md b/.github/ISSUE_TEMPLATE/1-bug.md
@@ -32,11 +32,17 @@ labels: 'type: bug'
 
 **For VS Code users:**
 
-1. Open Command Palette (`Ctrl+Shift+P` / `Cmd+Shift+P`)
-2. Go to `View: Toggle Output`
-3. Select `Nx Console` from the dropdown
-4. Also select `Nx Language Server` from the dropdown
-5. Paste both outputs below
+1. Enable debug logging (recommended for detailed logs):
+   - Open Settings (`Ctrl+,` / `Cmd+,`)
+   - Search for `nxConsole.enableDebugLogging`
+   - Enable the setting
+   - Restart VS Code or reload the window (`Ctrl+Shift+P` / `Cmd+Shift+P` → `Developer: Reload Window`)
+2. Reproduce the issue
+3. Open Command Palette (`Ctrl+Shift+P` / `Cmd+Shift+P`)
+4. Go to `View: Toggle Output`
+5. Select `Nx Console` from the dropdown
+6. Also select `Nx Language Server` from the dropdown
+7. Paste both outputs below
 
 **For JetBrains IDE users (IntelliJ, WebStorm, etc.):**
 
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -37,6 +37,29 @@ When debugging the JCEF-based generate UI, you can attach an instance of Chrome
 
 ### Building the extension for local testing
 
+### Debugging
+
+When developing or troubleshooting issues, you can enable debug logging to get detailed output:
+
+#### VSCode
+
+1. Open Settings (`Ctrl+,` / `Cmd+,`)
+2. Search for `nxConsole.enableDebugLogging`
+3. Enable the setting
+4. Restart VS Code or reload the window (`Ctrl+Shift+P` / `Cmd+Shift+P` → `Developer: Reload Window`)
+5. View logs in the Output panel:
+   - Open Command Palette (`Ctrl+Shift+P` / `Cmd+Shift+P`)
+   - Go to `View: Toggle Output`
+   - Select `Nx Console` and `Nx Language Server` from the dropdown
+
+#### IntelliJ
+
+1. Go to `Help` → `Diagnostic Tools` → `Debug Log Settings...`
+2. Add: `#dev.nx.console:trace`
+3. Click `OK` and restart the IDE
+4. Access logs via `Help` → `Show Log in Explorer` (Windows) / `Show Log in Finder` (macOS) / `Show Log in Files` (Linux)
+5. Look for the `idea.log` file
+
 ## Submitting a PR
 
 Please follow the following guidelines:
diff --git a/apps/nx-mcp/src/main.ts b/apps/nx-mcp/src/main.ts
@@ -55,7 +55,10 @@ async function main() {
   );
 
   let mcpStdioConnected = false;
-  let logger: { log: (message: string) => void } = consoleLogger;
+  let logger: {
+    log: (message: string) => void;
+    debug?: (message: string) => void;
+  } = consoleLogger;
 
   if (argv.transport === 'stdio') {
     logger = {
@@ -69,8 +72,25 @@ async function main() {
           // do nothing
         }
       },
+      debug: (data: string) => {
+        if (argv.debugLogs && mcpStdioConnected) {
+          mcpServer.server.sendLoggingMessage({
+            level: 'info',
+            data,
+          });
+        }
+      },
     };
     ensureOnlyJsonRpcStdout();
+  } else {
+    logger = {
+      log: consoleLogger.log,
+      debug: (message: string) => {
+        if (argv.debugLogs) {
+          consoleLogger.log?.(message);
+        }
+      },
+    };
   }
 
   logger.log('Starting Nx MCP server');
diff --git a/apps/nx-mcp/src/yargs-config.ts b/apps/nx-mcp/src/yargs-config.ts
@@ -8,6 +8,7 @@ export interface ArgvType {
   port?: number;
   disableTelemetry: boolean;
   keepAliveInterval: number;
+  debugLogs: boolean;
   _: (string | number)[];
   $0: string;
   [x: string]: unknown;
@@ -59,6 +60,11 @@ export function createYargsConfig(args: string[]): Argv<any> {
       hidden: true,
       default: 30000,
     })
+    .option('debugLogs', {
+      describe: 'Enable debug logging',
+      type: 'boolean',
+      default: false,
+    })
     .check((argv) => {
       // Check for conflicting options
       if (argv.sse && argv.transport === 'http') {
diff --git a/apps/nxls/src/main.ts b/apps/nxls/src/main.ts
@@ -134,10 +134,10 @@ const documents = new TextDocuments(TextDocument);
 documents.listen(connection);
 
 connection.onInitialize(async (params) => {
-  setLspLogger(connection);
+  const { workspacePath, enableDebugLogging } =
+    params.initializationOptions ?? {};
+  setLspLogger(connection, enableDebugLogging ?? false);
   lspLogger.log('Initializing Nx Language Server');
-
-  const { workspacePath } = params.initializationOptions ?? {};
   try {
     WORKING_PATH =
       workspacePath ||
diff --git a/apps/vscode/package.json b/apps/vscode/package.json
@@ -1078,6 +1078,11 @@
           "type": "number",
           "scope": "resource",
           "description": "Fixed port for the Nx MCP server. If set to 0, a random available port will be used."
+        },
+        "nxConsole.enableDebugLogging": {
+          "type": "boolean",
+          "default": false,
+          "description": "Enable debug logging in Nx Console output channels and the Nx Language Server."
         }
       }
     },
diff --git a/apps/vscode/src/main.ts b/apps/vscode/src/main.ts
@@ -12,13 +12,8 @@ import {
   workspace,
 } from 'vscode';
 
+import { killGroup, withTimeout } from '@nx-console/shared-utils';
 import {
-  killGroup,
-  loadRootEnvFiles,
-  withTimeout,
-} from '@nx-console/shared-utils';
-import {
-  getNxWorkspacePath,
   GlobalConfigurationStore,
   WorkspaceConfigurationStore,
 } from '@nx-console/vscode-configuration';
@@ -65,6 +60,7 @@ import {
   hasNxGraphServer,
   hasNxGraphServerAffected,
 } from '@nx-console/vscode-graph-base';
+import { initMessagingServer } from '@nx-console/vscode-messaging';
 import { initNvmTip } from '@nx-console/vscode-nvm-tip';
 import {
   handleSelfHealingUri,
@@ -80,7 +76,6 @@ import { getTelemetry, initTelemetry } from '@nx-console/vscode-telemetry';
 import { RequestType } from 'vscode-languageserver';
 import { initNxInit } from './nx-init';
 import { registerRefreshWorkspace } from './refresh-workspace';
-import { initMessagingServer } from '@nx-console/vscode-messaging';
 
 let nxProjectsTreeProvider: NxProjectTreeProvider;
 
diff --git a/apps/vscode/src/nx-init.ts b/apps/vscode/src/nx-init.ts
@@ -28,7 +28,7 @@ export function initNxInit(context: ExtensionContext) {
         const workspacePath =
           workspace.workspaceFolders &&
           workspace.workspaceFolders[0].uri.fsPath;
-        const provenanceResult = await nxLatestProvenanceCheck();
+        const provenanceResult = await nxLatestProvenanceCheck(workspacePath);
         if (provenanceResult !== true) {
           getTelemetry().logUsage('misc.nx-latest-no-provenance');
           logAndShowError(noProvenanceError, provenanceResult);
diff --git a/libs/language-server/utils/src/lib/lsp-log.ts b/libs/language-server/utils/src/lib/lsp-log.ts
@@ -2,10 +2,12 @@ import { Logger } from '@nx-console/shared-utils';
 import { Connection } from 'vscode-languageserver';
 
 let log: Console['log'] | undefined;
+let enableDebugLogging = false;
 
-export function setLspLogger(connection: Connection) {
+export function setLspLogger(connection: Connection, debugLogging = false) {
   if (!log) {
     log = connection.console.log.bind(connection.console);
+    enableDebugLogging = debugLogging;
   } else {
     throw `Can't set logger twice`;
   }
@@ -18,4 +20,12 @@ export const lspLogger: Logger = {
       ...args,
     );
   },
+  debug(message: string, ...args: any[]) {
+    if (enableDebugLogging) {
+      log?.(
+        `[Nxls] - ${new Date(Date.now()).toISOString()} - ${message}\n`,
+        ...args,
+      );
+    }
+  },
 };
diff --git a/libs/nx-mcp/nx-mcp-server/src/lib/mcp-logger.ts b/libs/nx-mcp/nx-mcp-server/src/lib/mcp-logger.ts
@@ -1,13 +1,24 @@
 import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
 import { Logger } from '@nx-console/shared-utils';
 
-export function getMcpLogger(server: McpServer): Logger {
+export function getMcpLogger(
+  server: McpServer,
+  enableDebugLogging = false,
+): Logger {
   return {
     log: (message: string) => {
       server.server.sendLoggingMessage({
         level: 'info',
         data: message,
       });
     },
+    debug: (message: string) => {
+      if (enableDebugLogging) {
+        server.server.sendLoggingMessage({
+          level: 'info',
+          data: message,
+        });
+      }
+    },
   };
 }
diff --git a/libs/nx-mcp/nx-mcp-server/src/lib/nx-mcp-server-wrapper.ts b/libs/nx-mcp/nx-mcp-server/src/lib/nx-mcp-server-wrapper.ts
@@ -130,7 +130,7 @@ export class NxMcpServerWrapper {
       telemetry,
       logger,
     );
-    logger?.log('Registering all Nx MCP tools');
+    logger?.debug?.('Registering all Nx MCP tools');
 
     server.server.server.setRequestHandler(
       SetLevelRequestSchema,
@@ -347,7 +347,7 @@ export class NxMcpServerWrapper {
       return;
     }
 
-    this.logger.log(
+    this.logger.debug?.(
       'Starting periodic tool condition monitoring (5 times, 10-second intervals)',
     );
     this.periodicMonitoringCount = 0;
@@ -371,7 +371,7 @@ export class NxMcpServerWrapper {
     if (this.periodicMonitoringTimer) {
       clearInterval(this.periodicMonitoringTimer);
       this.periodicMonitoringTimer = undefined;
-      this.logger.log('Stopped periodic tool condition monitoring');
+      this.logger.debug?.('Stopped periodic tool condition monitoring');
     }
   }
 
diff --git a/libs/nx-mcp/nx-mcp-server/src/lib/tools/nx-cloud.ts b/libs/nx-mcp/nx-mcp-server/src/lib/tools/nx-cloud.ts
@@ -112,7 +112,7 @@ export function registerNxCloudTools(
     nxCloudTaskDetails(workspacePath, logger, telemetry),
   );
 
-  logger.log('Registered Nx Cloud tools');
+  logger.debug?.('Registered Nx Cloud tools');
 }
 
 export const renderCipeDetails = (cipe: CIPEInfo): string => {
diff --git a/libs/nx-mcp/nx-mcp-server/src/lib/tools/nx-core.ts b/libs/nx-mcp/nx-mcp-server/src/lib/tools/nx-core.ts
@@ -99,5 +99,5 @@ export function registerNxCoreTools(
     },
   );
 
-  logger.log('Registered Nx core tools');
+  logger.debug?.('Registered Nx core tools');
 }
diff --git a/libs/nx-mcp/nx-mcp-server/src/lib/tools/nx-ide.ts b/libs/nx-mcp/nx-mcp-server/src/lib/tools/nx-ide.ts
@@ -189,5 +189,5 @@ export function registerNxIdeTools(
     },
   );
 
-  logger.log('Registered Nx IDE tools');
+  logger.debug?.('Registered Nx IDE tools');
 }
diff --git a/libs/nx-mcp/nx-mcp-server/src/lib/tools/nx-tasks.ts b/libs/nx-mcp/nx-mcp-server/src/lib/tools/nx-tasks.ts
@@ -45,7 +45,7 @@ export function registerNxTaskTools(
     nxCurrentlyRunningTaskOutput(telemetry, ideProvider),
   );
 
-  logger.log('Registered Nx task tools');
+  logger.debug?.('Registered Nx task tools');
 }
 
 const nxCurrentlyRunningTasksDetails =
diff --git a/libs/nx-mcp/nx-mcp-server/src/lib/tools/nx-workspace.ts b/libs/nx-mcp/nx-mcp-server/src/lib/tools/nx-workspace.ts
@@ -596,7 +596,7 @@ ${targetDescriptions}`;
     },
   );
 
-  logger.log('Registered Nx workspace tool');
+  logger.debug?.('Registered Nx workspace tool');
 }
 
 export function getTokenOptimizedToolResult(
diff --git a/libs/shared/npm/src/lib/workspace-dependencies.spec.ts b/libs/shared/npm/src/lib/workspace-dependencies.spec.ts
@@ -83,6 +83,7 @@ describe('workspace-dependencies', () => {
       expect(
         await importWorkspaceDependency('node_modules/nx/src/utils.js', {
           log: logMock,
+          debug: logMock,
         }),
       ).toEqual({ utilString: 'util-string' });
       expect(logMock).toHaveBeenCalledWith(
@@ -102,6 +103,7 @@ describe('workspace-dependencies', () => {
       expect(
         await importWorkspaceDependency('node_modules\\nx\\src\\utils.js', {
           log: logMock,
+          debug: logMock,
         }),
       ).toEqual({ utilString: 'util-string' });
       expect(logMock).toHaveBeenCalledWith(
diff --git a/libs/shared/npm/src/lib/workspace-dependencies.ts b/libs/shared/npm/src/lib/workspace-dependencies.ts
@@ -88,7 +88,7 @@ export function importWorkspaceDependency<T>(
   // eslint-disable-next-line @typescript-eslint/no-var-requires
   const imported = require(importPath);
 
-  logger?.log(`Using local Nx package at ${importPath}`);
+  logger?.debug?.(`Using local Nx package at ${importPath}`);
 
   return imported;
 }
diff --git a/libs/shared/utils/src/lib/loadRootEnvFiles.ts b/libs/shared/utils/src/lib/loadRootEnvFiles.ts
@@ -9,15 +9,15 @@ import { join } from 'path';
  * - .env.local
  */
 export function loadRootEnvFiles(
-  root: string,
+  workspacePath: string,
   targetEnv: NodeJS.ProcessEnv = process.env,
 ): NodeJS.ProcessEnv {
   let expandedEnv: NodeJS.ProcessEnv = {
     ...targetEnv,
   };
   for (const file of ['.local.env', '.env.local', '.env']) {
     const myEnv = loadDotEnvFile({
-      path: join(root, file),
+      path: join(workspacePath, file),
       processEnv: targetEnv,
       override: true,
     });
diff --git a/libs/shared/utils/src/lib/logger.ts b/libs/shared/utils/src/lib/logger.ts
@@ -1,7 +1,9 @@
 export interface Logger {
   log(message: string, ...args: any[]): void;
+  debug?(message: string, ...args: any[]): void;
 }
 
 export const consoleLogger: Logger = {
   log: console.log,
+  debug: console.log,
 };
diff --git a/libs/shared/utils/src/lib/provenance.ts b/libs/shared/utils/src/lib/provenance.ts
@@ -1,12 +1,13 @@
 import { exec } from 'node:child_process';
 import { promisify } from 'node:util';
+import { loadRootEnvFiles } from './loadRootEnvFiles';
 
-/**
- * Checks the provenance of the latest version of Nx from the npm registry.
- * Returns true if the provenance is valid, otherwise returns a string describing the failure reason.
- */
-export async function nxLatestProvenanceCheck(): Promise<true | string> {
-  if (process.env.NX_SKIP_PROVENANCE_CHECK === 'true') {
+export async function nxLatestProvenanceCheck(
+  workspacePath?: string,
+): Promise<true | string> {
+  const env = workspacePath ? loadRootEnvFiles(workspacePath) : process.env;
+
+  if (env.NX_SKIP_PROVENANCE_CHECK === 'true') {
     return true;
   }
   try {
diff --git a/libs/vscode/configuration/src/lib/configuration-keys.ts b/libs/vscode/configuration/src/lib/configuration-keys.ts
@@ -11,7 +11,7 @@ export const GLOBAL_CONFIG_KEYS = [
   'showNodeVersionOnStartup',
   'nxWorkspacePath',
   'nxCloudNotifications',
-  'debugMode',
+  'enableDebugLogging',
   'mcpPort',
 ] as const;
 
@@ -28,7 +28,7 @@ export type GlobalConfig = {
   showNodeVersionOnStartup: boolean;
   nxWorkspacePath: string;
   nxCloudNotifications: 'all' | 'errors' | 'none';
-  debugMode: boolean;
+  enableDebugLogging: boolean;
   mcpPort: number | undefined;
 };
 
diff --git a/libs/vscode/lsp-client/src/nxls-client.ts b/libs/vscode/lsp-client/src/nxls-client.ts
diff --git a/libs/vscode/lsp-client/tsconfig.json b/libs/vscode/lsp-client/tsconfig.json
diff --git a/libs/vscode/lsp-client/tsconfig.lib.json b/libs/vscode/lsp-client/tsconfig.lib.json
diff --git a/libs/vscode/mcp/src/lib/periodic-ai-check.ts b/libs/vscode/mcp/src/lib/periodic-ai-check.ts
diff --git a/libs/vscode/nx-cloud-view/src/get-cloud-onboarding-url.ts b/libs/vscode/nx-cloud-view/src/get-cloud-onboarding-url.ts
diff --git a/libs/vscode/output-channels/src/lib/output-channels.ts b/libs/vscode/output-channels/src/lib/output-channels.ts
diff --git a/libs/vscode/output-channels/tsconfig.json b/libs/vscode/output-channels/tsconfig.json
diff --git a/libs/vscode/output-channels/tsconfig.lib.json b/libs/vscode/output-channels/tsconfig.lib.json
diff --git a/libs/vscode/tasks/src/lib/cli-task.ts b/libs/vscode/tasks/src/lib/cli-task.ts

Original file line number	Diff line number	Diff line change
`@@ -1078,6 +1078,11 @@`
`1078`	`1078`	`"type": "number",`
`1079`	`1079`	`"scope": "resource",`
`1080`	`1080`	`"description": "Fixed port for the Nx MCP server. If set to 0, a random available port will be used."`
	`1081`	`+ },`
	`1082`	`+ "nxConsole.enableDebugLogging": {`
	`1083`	`+ "type": "boolean",`
	`1084`	`+ "default": false,`
	`1085`	`+ "description": "Enable debug logging in Nx Console output channels and the Nx Language Server."`
`1081`	`1086`	`}`
`1082`	`1087`	`}`
`1083`	`1088`	`},`