Merge pull request #165 from Ackee-Blockchain/ver/1.19.2

Ver/1.19.2

Author: soyrubio

.gitignore

@@ -6,4 +6,5 @@ node_modules
 env.ts
 .DS_Store
 .todo
-.vscode
+.vscode
+.wake

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

package.json

@@ -639,6 +639,16 @@
                 "command": "Tools-for-Solidity.sake.copyFromResults",
                 "title": "Solidity: Copy From Results",
                 "icon": "$(copy)"
+            },
+            {
+                "command": "Tools-for-Solidity.detections.toggle_show_ignored",
+                "title": "Show Ignored Detections",
+                "icon": "$(eye)"
+            },
+            {
+                "command": "Tools-for-Solidity.detections.toggle_hide_ignored",
+                "title": "Hide Ignored Detections",
+                "icon": "$(eye-closed)"
             }
         ],
         "viewsContainers": {
@@ -694,6 +704,16 @@
                     "when": "view == wake-detections",
                     "group": "navigation@3"
                 },
+                {
+                    "command": "Tools-for-Solidity.detections.toggle_show_ignored",
+                    "when": "view == wake-detections && !wake.detections.showIgnored",
+                    "group": "navigation@4"
+                },
+                {
+                    "command": "Tools-for-Solidity.detections.toggle_hide_ignored",
+                    "when": "view == wake-detections && wake.detections.showIgnored",
+                    "group": "navigation@4"
+                },
                 {
                     "submenu": "tools-for-solidity.detections.group",
                     "when": "view == wake-detections",

resources/walkthrough/sake.png

@@ -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/commands.ts

@@ -12,6 +12,7 @@ export class WakeTreeDataProvider extends BaseTreeProvider {
     groupBy: GroupBy = GroupBy.IMPACT;
     filterImpact: Impact = Impact.INFO;
     filterConfidence: Confidence = Confidence.LOW;
+    showIgnored: boolean = false;
 
     constructor(context : vscode.ExtensionContext){
         super(context);
@@ -22,14 +23,17 @@ export class WakeTreeDataProvider extends BaseTreeProvider {
         let groupByConfig = this.context.workspaceState.get("detections.groupBy")
         let filterImpactConfig = this.context.workspaceState.get("detections.filterImpact")
         let filterConfidenceConfig = this.context.workspaceState.get("detections.filterConfidence")
+        let showIgnoredConfig = this.context.workspaceState.get("detections.showIgnored", false)
 
         if (groupByConfig !== undefined) this.groupBy = GroupBy[groupByConfig as keyof typeof GroupBy];
         if (filterImpactConfig !== undefined) this.filterImpact = Impact[filterImpactConfig as keyof typeof Impact];
         if (filterConfidenceConfig !== undefined) this.filterConfidence = Confidence[filterConfidenceConfig as keyof typeof Confidence];
+        this.showIgnored = showIgnoredConfig;
 
         vscode.commands.executeCommand('setContext', 'detections.group', GroupBy[this.groupBy]);
         vscode.commands.executeCommand('setContext', 'detections.filterImpact', Impact[this.filterImpact]);
         vscode.commands.executeCommand('setContext', 'detections.filterConfidence', Confidence[this.filterConfidence]);
+        vscode.commands.executeCommand('setContext', 'wake.detections.showIgnored', this.showIgnored);
     }
 
     getRoot(diagnostic: WakeDiagnostic): string {
@@ -147,6 +151,11 @@ export class WakeTreeDataProvider extends BaseTreeProvider {
     }
 
     filterDetections(detection: WakeDetection): boolean {
+        // Filter out ignored detections unless showIgnored is true
+        if (!this.showIgnored && detection.diagnostic.data.ignored) {
+            return false;
+        }
+
         var filterImpact = true;
         var filterConfidence = true;
 
@@ -204,6 +213,11 @@ export class WakeTreeDataProvider extends BaseTreeProvider {
         this.context.workspaceState.update("detections.filterConfidence", Confidence[minConfidence]).then(() => this.refresh());
         vscode.commands.executeCommand('setContext', 'detections.filterConfidence', Confidence[minConfidence]);
     }
+
+    setShowIgnored(showIgnored: boolean) {
+        this.showIgnored = showIgnored;
+        this.context.workspaceState.update("detections.showIgnored", showIgnored).then(() => this.refresh());
+    }
 }
 
 export enum GroupBy {

src/detections/WakeTreeDataProvider.ts

@@ -38,7 +38,7 @@ import waitPort = require('wait-port');
 import { GroupBy, Impact, Confidence } from './detections/WakeTreeDataProvider';
 import { SolcTreeDataProvider } from './detections/SolcTreeDataProvider';
 import { WakeTreeDataProvider } from './detections/WakeTreeDataProvider';
-import { Detector, WakeDetection } from './detections/model/WakeDetection';
+import { Detector, WakeDetection, WakeDiagnostic } from './detections/model/WakeDetection';
 import { convertDiagnostics } from './detections/util';
 import { DetectorItem } from './detections/model/DetectorItem';
 import { ClientMiddleware } from './ClientMiddleware';
@@ -65,6 +65,8 @@ let errorHandler: ClientErrorHandler;
 let printers: PrintersHandler;
 let crashlog: string[] = [];
 let graphvizGenerator: GraphvizPreviewGenerator;
+let showIgnoredDetections = false;
+let extensionContext: vscode.ExtensionContext;
 
 //export let log: Log
 
@@ -75,20 +77,28 @@ interface DiagnosticNotification {
     diagnostics: Diagnostic[];
 }
 
+// Store all diagnostics globally so we can refresh visibility
+let allDiagnosticsMap: Map<string, WakeDiagnostic[]> = new Map();
+
 function onNotification(outputChannel: vscode.OutputChannel, detection: DiagnosticNotification) {
-    let diags = detection.diagnostics
-        .map((it) => convertDiagnostics(it))
-        .filter((item) => !item.data.ignored);
-    diagnosticCollection.set(vscode.Uri.parse(detection.uri), diags);
+    let diags = detection.diagnostics.map((it) => convertDiagnostics(it));
+
+    // Store all diagnostics for later filtering
+    allDiagnosticsMap.set(detection.uri, diags);
+
+    // Store filtered diagnostics for VS Code diagnostics panel
+    let visibleDiags = diags.filter((item) => showIgnoredDetections || !item.data.ignored);
+    diagnosticCollection.set(vscode.Uri.parse(detection.uri), visibleDiags);
 
     try {
         let uri = vscode.Uri.parse(detection.uri);
+        // Pass all detections to providers (including ignored ones)
         let wakeDetections = diags
-            .filter((item) => item.source == 'Wake')
+            .filter((item) => item.source === 'Wake')
             .map((it) => new WakeDetection(uri, it));
         wakeProvider?.add(uri, wakeDetections);
         let solcDetections = diags
-            .filter((item) => item.source == 'Wake(solc)')
+            .filter((item) => item.source === 'Wake(solc)')
             .map((it) => new WakeDetection(uri, it));
         solcProvider?.add(uri, solcDetections);
     } catch (err) {
@@ -98,9 +108,18 @@ function onNotification(outputChannel: vscode.OutputChannel, detection: Diagnost
     }
 }
 
+function refreshDiagnosticsVisibility() {
+    // Re-filter all stored diagnostics based on current showIgnoredDetections state
+    for (const [uri, diags] of allDiagnosticsMap) {
+        let visibleDiags = diags.filter((item) => showIgnoredDetections || !item.data.ignored);
+        diagnosticCollection.set(vscode.Uri.parse(uri), visibleDiags);
+    }
+}
+
 // this method is called when your extension is activated
 // your extension is activated the very first time the command is executed
 export async function activate(context: vscode.ExtensionContext) {
+    extensionContext = context;
     const outputChannel = vscode.window.createOutputChannel(
         'Solidity: Output',
         'tools-for-solidity-output'
@@ -236,6 +255,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);
+
     const clientOptions: LanguageClientOptions = {
         documentSelector: [{ scheme: 'file', language: 'solidity' }],
         synchronize: { configurationSection: 'wake' },
@@ -325,7 +347,7 @@ export async function activate(context: vscode.ExtensionContext) {
     client.start();
 
     // Create the Wake status bar item
-    const statusBarProvider = new WakeStatusBarProvider(client);
+    const statusBarProvider = new WakeStatusBarProvider(client, analytics);
 
     analytics.logActivate();
 
@@ -542,6 +564,7 @@ function registerCommands(outputChannel: vscode.OutputChannel, context: vscode.E
             'Tools-for-Solidity.detections.force_rerun_detectors',
             async () => {
                 wakeProvider?.clear();
+                allDiagnosticsMap.clear();
                 vscode.commands.executeCommand('wake.lsp.force_rerun_detectors');
             }
         )
@@ -552,6 +575,7 @@ function registerCommands(outputChannel: vscode.OutputChannel, context: vscode.E
             async () => {
                 solcProvider?.clear();
                 wakeProvider?.clear();
+                allDiagnosticsMap.clear();
                 vscode.commands.executeCommand('wake.lsp.force_recompile');
             }
         )
@@ -652,6 +676,39 @@ function registerCommands(outputChannel: vscode.OutputChannel, context: vscode.E
             );
         })
     );
+
+    // Register commands for toggling ignored detections
+    context.subscriptions.push(
+        vscode.commands.registerCommand('Tools-for-Solidity.detections.toggle_show_ignored', () => {
+            showIgnoredDetections = true;
+            vscode.commands.executeCommand('setContext', 'wake.detections.showIgnored', true);
+
+            // Update tree provider (which also saves to workspaceState)
+            wakeProvider?.setShowIgnored(true);
+
+            // Refresh diagnostics panel by re-processing existing detections
+            refreshDiagnosticsVisibility();
+        })
+    );
+
+    context.subscriptions.push(
+        vscode.commands.registerCommand('Tools-for-Solidity.detections.toggle_hide_ignored', () => {
+            showIgnoredDetections = false;
+            vscode.commands.executeCommand('setContext', 'wake.detections.showIgnored', false);
+
+            // Update tree provider (which also saves to workspaceState)
+            wakeProvider?.setShowIgnored(false);
+
+            // Refresh diagnostics panel by re-processing existing detections
+            refreshDiagnosticsVisibility();
+        })
+    );
+}
+
+function registerFormatter(context: vscode.ExtensionContext) {
+    context.subscriptions.push(
+        vscode.languages.registerDocumentFormattingEditProvider('solidity', new PrettierFormatter())
+    );
 }
 
 function registerFormatter(context: vscode.ExtensionContext) {
@@ -668,7 +725,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;
@@ -704,6 +761,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');
@@ -712,6 +777,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);

src/extension.ts

@@ -3,12 +3,16 @@ import { SakeContext } from '../sake/context';
 import { LanguageClient, State } from 'vscode-languageclient/node';
 import { restartWakeClient } from '../commands';
 import { MarkdownString } from 'vscode';
+import { Analytics } from '../Analytics';
 
 export class WakeStatusBarProvider {
     // private static instance: WakeStatusBarProvider;
     private _statusBarItem!: vscode.StatusBarItem;
 
-    constructor(private client: LanguageClient) {
+    constructor(
+        private client: LanguageClient,
+        private analytics: Analytics
+    ) {
         this._initializeStatusBar();
         this._initializeCommands();
         this.client.onDidChangeState((state) => {
@@ -35,24 +39,26 @@ export class WakeStatusBarProvider {
         this._statusBarItem.command = undefined;
         this._statusBarItem.show();
 
+        const version = this.analytics.wakeVersion || '';
+        const versionText = version ? ` v${version}` : '';
+
         switch (this.client.state) {
             case State.Running:
                 // this._statusBarItem.hide()
-                this._statusBarItem.text = '$(check-all) Wake';
-                this._statusBarItem.tooltip = 'Wake LSP is running';
+                this._statusBarItem.text = `$(check-all) Wake${versionText}`;
+                this._statusBarItem.tooltip = `Wake LSP is running${version ? ` (version ${version})` : ''}`;
                 break;
             case State.Stopped:
-                this._statusBarItem.text = '$(refresh) Wake';
-                this._statusBarItem.tooltip =
-                    'Cannot connect to Wake LSP required by Solidity (Wake).\nClick to restart client.';
+                this._statusBarItem.text = `$(refresh) Wake${versionText}`;
+                this._statusBarItem.tooltip = `Cannot connect to Wake LSP required by Solidity (Wake)${version ? ` (version ${version})` : ''}.\nClick to restart client.`;
                 this._statusBarItem.backgroundColor = new vscode.ThemeColor(
                     'statusBarItem.errorBackground'
                 );
                 this._statusBarItem.command = 'Tools-for-Solidity.wake.restart_client';
                 break;
             case State.Starting:
-                this._statusBarItem.text = '$(sync~spin) Wake';
-                this._statusBarItem.tooltip = 'Connecting to Wake LSP...';
+                this._statusBarItem.text = `$(sync~spin) Wake${versionText}`;
+                this._statusBarItem.tooltip = `Connecting to Wake LSP...${version ? ` (version ${version})` : ''}`;
                 break;
             default:
                 this._statusBarItem.hide();