🐛 Fix compilation issues caused by unreliable remappings.txt files in Foundry projects

Author: soyrubio

CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## [1.19.2]
+### Fixes
+- Fixed compilation issues caused by unreliable `remappings.txt` files in Foundry projects
+
+## [1.19.1]
+### Features
+- Added Wake version information to the bottom status bar
+- Implemented filtering for ignored detections in the detections UI
+
+### Improvements
+- Store ignored detections toggle setting in workspace storage for better persistence
+
+### Fixes
+- Fixed state loading issues and disabled autosave by default
+
 ## [1.19.0]
 ### Features
 - Introduced pre-configured chains, such as Ethereum Mainnet and popular L2 networks (Optimism, Arbitrum, Base, Polygon, etc.), significantly streamlining the forking process

src/commands.ts

@@ -92,13 +92,14 @@ export async function importFoundryRemappings(out: vscode.OutputChannel, silent:
     let remappings: string[] = [];
 
     try {
-        // First, try to read from remappings.txt
-        remappings = fs
-            .readFileSync(cwd + '/remappings.txt')
+        // First, try to execute forge from PATH
+        remappings = execFileSync('forge', ['remappings'], {
+            cwd: cwd
+        })
             .toString('utf8')
             .split(/\r?\n/);
     } catch (e) {
-        // If remappings.txt doesn't exist or can't be read, try using forge
+        // If forge is not in PATH, try specific locations
         try {
             remappings = execFileSync(os.homedir() + '/.foundry/bin/forge', ['remappings'], {
                 cwd: cwd
@@ -113,12 +114,20 @@ export async function importFoundryRemappings(out: vscode.OutputChannel, silent:
                     .toString('utf8')
                     .split(/\r?\n/);
             } catch (e) {
-                if (!silent) {
-                    vscode.window.showErrorMessage(
-                        'Failed to find `remappings.txt` file or `forge` executable.'
-                    );
+                // Fall back to reading remappings.txt
+                try {
+                    remappings = fs
+                        .readFileSync(cwd + '/remappings.txt')
+                        .toString('utf8')
+                        .split(/\r?\n/);
+                } catch (e) {
+                    if (!silent) {
+                        vscode.window.showErrorMessage(
+                            'Failed to find `forge` executable or `remappings.txt` file.'
+                        );
+                    }
+                    return;
                 }
-                return;
             }
         }
     }

src/extension.ts

@@ -254,9 +254,9 @@ export async function activate(context: vscode.ExtensionContext) {
     };
     wakeProvider = new WakeTreeDataProvider(context);
     solcProvider = new SolcTreeDataProvider(context);
-    
+
     // Initialize showIgnoredDetections from workspace state (already loaded by WakeTreeDataProvider)
-    showIgnoredDetections = context.workspaceState.get("detections.showIgnored", false);
+    showIgnoredDetections = context.workspaceState.get('detections.showIgnored', false);
 
     const clientOptions: LanguageClientOptions = {
         documentSelector: [{ scheme: 'file', language: 'solidity' }],
@@ -719,7 +719,7 @@ function watchFoundryRemappings() {
 
     const workspace = workspaces[0];
     const fileWatcher = vscode.workspace.createFileSystemWatcher(
-        new vscode.RelativePattern(workspace, 'remappings.txt')
+        new vscode.RelativePattern(workspace, '.gitmodules')
     );
 
     let configWatcher: vscode.Disposable;
@@ -755,6 +755,14 @@ function watchFoundryRemappings() {
         return;
     }
 
+    // Check if this is a Foundry project by looking for .gitmodules or foundry.toml
+    // const gitmodulesPath = path.join(workspace.uri.fsPath, '.gitmodules');
+    // const foundryTomlPath = path.join(workspace.uri.fsPath, 'foundry.toml');
+
+    // if (!fs.existsSync(gitmodulesPath) && !fs.existsSync(foundryTomlPath)) {
+    //     return;
+    // }
+
     // start file system watcher
     fileWatcher.onDidChange(async () => {
         vscode.commands.executeCommand('Tools-for-Solidity.foundry.import_remappings_silent');
@@ -763,6 +771,7 @@ function watchFoundryRemappings() {
         vscode.commands.executeCommand('Tools-for-Solidity.foundry.import_remappings_silent');
     });
     fileWatcher.onDidDelete(async () => {
+        // When .gitmodules is deleted, clear remappings since dependencies are gone
         vscode.workspace
             .getConfiguration('wake.compiler.solc')
             .update('remappings', undefined, vscode.ConfigurationTarget.Workspace);