3.1.0 Unreal source fix

Author: boocs

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Change Log
 
+## [3.1.0] 2025-10-18
+### Fixed
+- Fixed Unreal source files not working correctly (thanks @romantimm)
+### Added
+- Added logging when adding source file to Unreal compile commands
+- Prompt user to remove invalid entry in Unreal's compile_commands.json
+
 ## [3.0.2] 2025-8-30
 ### Fixed
 - (Windows) Polling cl version now works in other languages for 'Set Custom System includes' command

FRONT.md

@@ -7,20 +7,25 @@ This is a local copy of the front facing Docs located here: https://github.com/b
 
 `WARNING`: Extension version `3.0.0+` has breaking changes. To upgrade version `2.0.0+` projects see section:
 
-   - web: [Upgrading Older Projects](https://github.com/boocs/unreal-clangd?tab=readme-ov-file#upgrading-older-projects)
+   -  [Upgrading Older Projects](https://github.com/boocs/unreal-clangd?tab=readme-ov-file#upgrading-older-projects)
 
    - local: [Upgrading Older Projects](#upgrading-older-projects)
 
+
 `note`: Ubuntu users: I started getting this error message wtih 5.6.0 but it still seemed to work.
    - Unable to watch for file changes. Please follow the instructions link to resolve this issue.
    - See [here](https://code.visualstudio.com/docs/setup/linux#_visual-studio-code-is-unable-to-watch-for-file-changes-in-this-large-workspace-error-enospc)
 
+---
+---
+
 # Table of Contents
 - [Updates](#updates)
 - [Important info](#important-info)
 - [Info](#info)
 - [Requirements](#requirements)
-    - [Requirements](#requirements)
+    - [General](#general)
+    - [Windows](#windows)
     - Also see:
          - [Installing correct LLVM (clangd/clang) version](#installing-correct-llvm-clangdclang-version)
          - [Installing correct Libraries (Windows)](#installing-correct-library-versions-windows)
@@ -54,6 +59,12 @@ This is a local copy of the front facing Docs located here: https://github.com/b
 
 ## Updates
 
+### Version 3.1.0
+- Fixed bug in Unreal source file support
+
+#### Version 3.0.2
+- (Windows) Fixed Polling cl version for set custom system includes for non-English languages
+
 #### Version 3.0.1
 - (Windows) Fixed Professional version of Visual Studio not being able to set custom system includes
 
@@ -127,13 +138,16 @@ This extension:
 ---
 
 ## Requirements
-#### General :
+#### General
 - Unreal v5.2+
 - LLVM (clang/clangd) Different Unreal versions requirement different LLVM versions (see below)
 - Unreal project created for VSCode
 - VSCode [clangd](https://marketplace.visualstudio.com/items?itemName=llvm-vs-code-extensions.vscode-clangd) extension (Do not let the VSCode `clangd` extension auto install LLVM)
 - Microsoft [C++ extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools) for its `Building/Debugging` Capability
 
+#### Windows 
+- Powershell 7+
+
 #### Compiler and libraries :
 - Before explanation on getting requirements here are some useful links:
    - [How to install correct LLVM (clangd/clang) version](#installing-correct-llvm-clangdclang-version)

package.json

@@ -2,7 +2,7 @@
   "name": "unreal-clangd",
   "displayName": "Unreal Clangd",
   "description": "Creates clangd project for Unreal 5.2+",
-  "version": "3.0.2",
+  "version": "3.1.0",
   "engines": {
     "vscode": "^1.99.0"
   },

src/extension.ts

@@ -1,16 +1,13 @@
 
-// Wait for 3.1.0
+
+// Wait for 3.2.0
+// ***** Remove prompt to remove invalid entry in Unreal compile_commands.json
 // Better way to backup *.code-workspace file settings?
    // if changed Copy *.code-workspace to .vscode/unreal-clangd?
       // Don't copy if clangd settings are missing from *.code-workspace (meaning uninstalled/not installed or improper refresh)
 // better unreal source support
-	// retry -mode=GenerateClangDatabase
-	// Stopped using it because of:
-		// Errors in response files that needed to be fixed
-		// Would cause you to have to do a full rebuild whenever used
-	// If we use it only for Unreal source files it shouldn't be as bad
-		// Rarely would have to run it
-			// That makes the problems not as bad
+	// retry -mode=GenerateClangDatabase - this only support full source UE so maybe not...
+	// Maybe full source unreal engine soure files only?
 // Create an algo to create a custom rsp file for completionHelper.cpp?
 	// create a 2nd rsp file that lets you add customizations to the first
 	// create algo runs on update compile command
@@ -43,6 +40,7 @@ import { addCompletionHelperToCompileCommands, FILENAME_ADD_COMPLETIONS, FILENAM
 import { isProjectChange, onProjectChange } from './modules/projectChange';
 import { startModifyResponseFiles } from './modules/modifyRspFiles';
 import { startCreateRspMatchers } from './modules/createRspMatchers';
+import { checkUnrealCompileCommands } from './modules/unrealCCChecker';
 
 
 let newSourceFilesDetectionFileWatcher: vscode.FileSystemWatcher | null = null;
@@ -343,6 +341,8 @@ export async function activate(context: vscode.ExtensionContext) {
 		}
     }));
 
+	await checkUnrealCompileCommands();
+
 	const mainWorkspaceFolder = getProjectWorkspaceFolder();
 	if(!mainWorkspaceFolder){
 		console.error(tr.COULDNT_GET_PROJECT_WORKSPACE);

src/libs/consts.ts

@@ -8,7 +8,7 @@ import type { Overwrite } from './indexTypes';
 import type { DocumentOptions, SchemaOptions, ParseOptions, CreateNodeOptions, ToStringOptions} from 'yaml';
 import { EOL } from "node:os";
 
-export const EXTENSION_VERSION = "3.0.2";
+export const EXTENSION_VERSION = "3.1.0";
 export const VALIDATE_UNREAL_VERSIONS: { min: ueHelpers.UnrealVersion, max: ueHelpers.UnrealVersion } =
     { min: { major: 5, minor: 2, patch: 0 }, max: { major: 6, minor: 0, patch: 0 } };  // The unreal versions this extension was created for
 

src/modules/addToUeSourceCC.ts

@@ -8,6 +8,8 @@ import * as ueHelpers from '../libs/ueHelpers';
 import { convertWindowsDriveLetterToUpper, getCompilerFromCompileCommands, getProjectCompileCommandsName, getValidatedCompileCommandObjectsFromUri, writeCompileCommandsFile } from '../libs/projHelpers';
 import { getRspMatchers, restartClangd } from '../shared';
 
+import * as console from '../libs/console';
+
 
 export async function startAddFilesToUESourceCompileCommands( currentDocUri: vscode.Uri) {
 
@@ -76,6 +78,10 @@ async function addFilesToUESourceCompileCommands(
         return;
     }
 
+    const projectUri = ueHelpers.getProjectWorkspaceFolder()?.uri;
+    if(!projectUri){
+        return;
+    }
     const rspPathRelative = getSourceFileRspPathMatch(ueUri, currentDocUri);
 
     if(!rspPathRelative){
@@ -94,11 +100,14 @@ async function addFilesToUESourceCompileCommands(
         return;
     }
 
-    const ueCompileCommand = createUESourceCompileCommand(ueUri, currentDocUri.fsPath, ccCompiler, rspPathRelative);
+    const ueCompileCommand = createUESourceCompileCommand(ueUri, projectUri, currentDocUri.fsPath, ccCompiler, rspPathRelative);
 
     ueSelfCompileCommands.push(ueCompileCommand);
 
     if (friendFileInfo === undefined) {
+        console.log(`Adding file to UE compile commands: ${currentDocUri.fsPath}`);
+        console.log(`   Relative rsp path: ${rspPathRelative}`);
+
         const friendUri: vscode.Uri | undefined = await findFriendUri(currentDocUri);
         if (friendUri) {
             await addFilesToUESourceCompileCommands(ueUri, friendUri, { origCC: ueSelfCompileCommands, compiler: ccCompiler });
@@ -108,6 +117,7 @@ async function addFilesToUESourceCompileCommands(
 
     }
 
+    return;
 }
 
 
@@ -131,7 +141,9 @@ function getSourceFileRspPathMatch( parentUri: vscode.Uri, fileUri: vscode.Uri){
 
     const rspMatcherPaths: {rspPath: string, closeness: number}[] = [];
 
-    for (const matcher of getRspMatchers()) {
+    const rspMatchers = getRspMatchers();
+
+    for (const matcher of rspMatchers) {
         const dirPath = vscode.Uri.joinPath(parentUri, matcher.ueDirRelative);
         const pathTest = nodePath.relative(dirPath.fsPath, fileUri.fsPath);
 
@@ -173,9 +185,9 @@ function getSourceFileRspPathMatch( parentUri: vscode.Uri, fileUri: vscode.Uri){
 }
 
 
-function createUESourceCompileCommand(ueUri: vscode.Uri, file: string, compilerPath: string, rspRelative: string): CompileCommand {
+function createUESourceCompileCommand(ueUri: vscode.Uri, projectUri: vscode.Uri, file: string, compilerPath: string, rspRelative: string): CompileCommand {
     const ccDirectory = vscode.Uri.joinPath(ueUri, consts.FOLDER_NAME_ENGINE, consts.FOLDER_NAME_SOURCE);
-    const rspPath = vscode.Uri.joinPath(ueUri, rspRelative);
+    const rspPath = vscode.Uri.joinPath(projectUri, rspRelative);
 
     return {
         file: convertWindowsDriveLetterToUpper(file),

src/modules/createRspMatchers.ts

@@ -50,7 +50,7 @@ async function createRspMatchers(progress: vscode.Progress<{
             progress.report({increment:increment});
 
             const rspName = nodePath.parse(extraction.uri.fsPath).name.split('.')[0];
-            const rspRelative = nodePath.relative(ueUri.fsPath, extraction.uri.fsPath);
+            const rspRelative = nodePath.relative(projUri.fsPath, extraction.uri.fsPath);
 
             const ueDirPath = nodePath.dirname(extraction.extracted[0]);
             const ueDirRelPath = nodePath.relative(ueUri.fsPath, ueDirPath);

src/modules/unrealCCChecker.ts

@@ -0,0 +1,88 @@
+import * as vscode from 'vscode';
+
+import { getUnrealClangdCompileCommandsUri, getValidatedCompileCommandObjectsFromUri, isFile, writeCompileCommandsFile } from "../libs/projHelpers";
+import { getUnrealUri } from "../libs/ueHelpers";
+import * as console from '../libs/console';
+import type { CompileCommand } from "../libs/types";
+import { restartClangd } from '../shared';
+
+export async function checkUnrealCompileCommands() {
+    console.log("Checking Unreal compile commands...");
+
+    const ueUri = getUnrealUri();
+    if (!ueUri) {
+        return;
+    }
+
+    const ueClangdCCUri = getUnrealClangdCompileCommandsUri(ueUri, { withFileName: true });
+
+    // Get ccs from file
+    const ccs = await getValidatedCompileCommandObjectsFromUri(ueClangdCCUri);
+    if (!ccs) {
+        console.error("Couldn't get Unreal compile commands object");
+        return;
+    }
+
+    // Get ccs with invalid removed or ignored
+    const newCcs = await getCCWithValidResponseFiles(ccs);
+
+    // Don't do anything
+    if (!newCcs) {
+        console.log("No invalid Unreal compile commands found or were ignored.");
+        return;
+    }
+
+    console.log(`Writing fixed Unreal compile commands: ${ueClangdCCUri.fsPath}`);
+    await writeCompileCommandsFile(ueClangdCCUri, undefined, newCcs);
+
+    await restartClangd();
+}
+
+
+async function getCCWithValidResponseFiles(ccs: CompileCommand[]) {
+
+    const returnCompileCommands: CompileCommand[] = [];
+
+    let fileIsDirty = false;
+    let choice: "Remove" | "Remove All" | "Keep" | undefined = undefined;
+
+    for (const cc of ccs) {
+        const rspPath = cc.arguments?.[1].slice(1);
+        if (!rspPath) {
+            continue;
+        }
+
+        if (await isFile(vscode.Uri.file(rspPath))) {
+            returnCompileCommands.push(cc);
+            continue;
+        }
+
+        // Not a file so ask to delete or keep or delete all invalid
+        if (choice !== "Remove All") {
+            console.error(`Unreal CC invalid rsp path found! ${rspPath}`);
+            choice = await vscode.window.showErrorMessage(
+                `Invalid path found in Unreal's compile_commands.json!\n\nRSP Path:\n${rspPath}`,
+                { detail: "What would you like to do with this invalid path?", modal: true },
+                "Remove", "Remove All", "Keep"
+            );
+        }
+
+        if (!choice) {
+            break;
+        }
+
+        if (choice === "Keep") {
+            returnCompileCommands.push(cc);
+            continue;
+        }
+
+        fileIsDirty = true;
+    }
+
+    if (!choice || !fileIsDirty) {
+        return;
+    }
+
+    return returnCompileCommands;
+
+}