chore: Added commands to toggle Lock File Parsing in the title bar. (#…

…124) * chore: Added commands to toggle Lock File Parsing in the title bar. * chore: Toggle Lock File Parsing commands added to title bar * chore: Update lock file parsing commands to use language-specific settings * chore: Changed some naming
filllabs · Sep 5, 2024 · d266aee · d266aee
1 parent f10635f
commit d266aee
Show file tree

Hide file tree

Showing 13 changed files with 178 additions and 11 deletions.
diff --git a/vscode/CHANGELOG.md b/vscode/CHANGELOG.md
@@ -4,6 +4,14 @@ All notable changes to the "dependi" extension will be documented in this file.
 
 ## [v0.7.9](https://github.com/filllabs/dependi/compare/v0.7.8...v0.7.9)
 
+### New Features
+
+- Commands to toggle Lock File Parsing in the title bar.
+  - ![Lock Icon](https://www.dependi.io/screenshots/lock.png)  Lock File Parsing enabled.
+  - ![Unlock Icon](https://www.dependi.io/screenshots/unlock.png)  Lock File Parsing disabled.
+  - ![Doc-Lock Icon](https://www.dependi.io/screenshots/lock-doc.png)  A lock file has been found and parsed.
+
+
 ### Improvements
 
 - New advanced vulnerability report. (_Only for [Pro](https://dependi.io) version._)

diff --git a/vscode/package.json b/vscode/package.json
@@ -137,6 +137,21 @@
     ],
     "menus": {
       "editor/title": [
+        {
+          "when": "dependi.hasLockFile && resourceFilename != 'go.mod' && resourceFilename != 'requirements.txt'",
+          "command": "dependi.commands.lockFileParsed",
+          "group": "navigation"
+        },
+        {
+          "when": "!dependi.hasLockFile && dependi.isLockFileEnabled && resourceFilename in dependi.supportedFiles && resourceFilename != 'go.mod' && resourceFilename != 'requirements.txt'",
+          "command": "dependi.commands.disableLockFileParsing",
+          "group": "navigation"
+        },
+        {
+          "when": "!dependi.hasLockFile && !dependi.isLockFileEnabled && resourceFilename in dependi.supportedFiles && resourceFilename != 'go.mod' && resourceFilename != 'requirements.txt'",
+          "command": "dependi.commands.enableLockFileParsing",
+          "group": "navigation"
+        },
         {
           "when": "resourceFilename in dependi.supportedFiles",
           "command": "dependi.commands.vulnerability.report",
@@ -200,6 +215,27 @@
           "dark": "./icons/vuln-rep-dark.svg",
           "light": "./icons/vuln-rep-light.svg"
         }
+      },
+      {
+        "command": "dependi.commands.enableLockFileParsing",
+        "title": "Enable Lock File Parsing",
+        "category": "Dependi",
+        "icon": "$(unlock)"
+      },
+      {
+        "command": "dependi.commands.disableLockFileParsing",
+        "title": "Disable Lock File Parsing",
+        "category": "Dependi",
+        "icon": "$(lock)"
+      },
+      {
+        "command": "dependi.commands.lockFileParsed",
+        "title": "Disable Lock File Parsing",
+        "category": "Dependi",
+        "icon": {
+          "dark": "./icons/lock-doc-dark.svg",
+          "light": "./icons/lock-doc-light.svg"
+        }
       }
     ],
     "configuration": [

diff --git a/vscode/src/commands/lock-file/disableLockFileParsing.ts b/vscode/src/commands/lock-file/disableLockFileParsing.ts
@@ -0,0 +1,33 @@
+import { commands, TextEditor, TextEditorEdit, workspace } from "vscode";
+import { Configs } from "../../config";
+import listener from "../../core/listeners";
+import { CurrentLanguage, Language } from "../../core/Language";
+const config = workspace.getConfiguration("dependi");
+
+export const disableLockFileParsing = commands.registerTextEditorCommand(
+  Configs.DISABLE_LOCK_FILE_PARSING,
+  (editor: TextEditor, edit: TextEditorEdit, info) => {
+    if (editor) {
+      switch (CurrentLanguage) {
+        case Language.Rust:
+          config.update(Configs.RUST_ENABLED_LOCK_FILE, false);
+          break;
+        case Language.JS:
+          config.update(Configs.NPM_ENABLED_LOCK_FILE, false);
+          break;
+        case Language.PHP:
+          config.update(Configs.PHP_ENABLED_LOCK_FILE, false);
+          break;
+        case Language.Python:
+          config.update(Configs.PYTHON_ENABLED_LOCK_FILE, false);
+          break;
+        default:
+          break;
+      }
+      commands.executeCommand("setContext", "dependi.isLockFileEnabled", false);
+      setTimeout(() => {
+        listener(editor);
+      }, 1000);
+    }
+  }
+);
diff --git a/vscode/src/commands/lock-file/enableLockFileParsing.ts b/vscode/src/commands/lock-file/enableLockFileParsing.ts
@@ -0,0 +1,34 @@
+import { commands, TextEditor, TextEditorEdit, workspace } from "vscode";
+import listener from "../../core/listeners";
+import { Configs } from "../../config";
+import { CurrentLanguage, Language } from "../../core/Language";
+
+const config = workspace.getConfiguration("dependi");
+
+export const enableLockFileParsing = commands.registerTextEditorCommand(
+  Configs.ENABLE_LOCK_FILE_PARSING,
+  (editor: TextEditor, edit: TextEditorEdit, info) => {
+    if (editor) {
+      switch (CurrentLanguage) {
+        case Language.Rust:
+          config.update(Configs.RUST_ENABLED_LOCK_FILE, true);
+          break;
+        case Language.JS:
+          config.update(Configs.NPM_ENABLED_LOCK_FILE, true);
+          break;
+        case Language.PHP:
+          config.update(Configs.PHP_ENABLED_LOCK_FILE, true);
+          break;
+        case Language.Python:
+          config.update(Configs.PYTHON_ENABLED_LOCK_FILE, true);
+          break;
+        default:
+          break;
+      }
+      commands.executeCommand("setContext", "dependi.isLockFileEnabled", true);
+      setTimeout(() => {
+        listener(editor);
+      }, 1000);
+    }
+  }
+);
diff --git a/vscode/src/commands/lock-file/lockFileParsed.ts b/vscode/src/commands/lock-file/lockFileParsed.ts
@@ -0,0 +1,36 @@
+import { commands, TextEditor, TextEditorEdit, workspace } from "vscode";
+import listener from "../../core/listeners";
+import { Configs } from "../../config";
+import { CurrentLanguage, Language } from "../../core/Language";
+
+const config = workspace.getConfiguration("dependi");
+
+export const lockFileParsed = commands.registerTextEditorCommand(
+  Configs.LOCK_FILE_PARSED,
+  (editor: TextEditor, edit: TextEditorEdit, info) => {
+    if (editor) {
+      switch (CurrentLanguage) {
+        case Language.Rust:
+          config.update(Configs.RUST_ENABLED_LOCK_FILE, false);
+          break;
+        case Language.JS:
+          config.update(Configs.NPM_ENABLED_LOCK_FILE, false);
+          break;
+        case Language.PHP:
+          config.update(Configs.PHP_ENABLED_LOCK_FILE, false);
+          break;
+        case Language.Python:
+          config.update(Configs.PYTHON_ENABLED_LOCK_FILE, false);
+          break;
+        default:
+          break;
+      }
+
+      commands.executeCommand("setContext", "dependi.hasLockFile", false);
+      commands.executeCommand("setContext", "dependi.isLockFileEnabled", false);
+      setTimeout(() => {
+        listener(editor);
+      }, 1000);
+    }
+  }
+);
diff --git a/vscode/src/config.ts b/vscode/src/config.ts
@@ -67,6 +67,9 @@ export enum Configs {
   // CREATE_CHANGELOG = `${DEPENDI}createChangelog`,
   UPDATE_ALL = `${DEPENDI}commands.updateAll`,
   RETRY = `${DEPENDI}commands.retry`,
+  ENABLE_LOCK_FILE_PARSING = `${DEPENDI}commands.enableLockFileParsing`,
+  DISABLE_LOCK_FILE_PARSING = `${DEPENDI}commands.disableLockFileParsing`,
+  LOCK_FILE_PARSED = `${DEPENDI}commands.lockFileParsed`,
 
 
   //Storage

diff --git a/vscode/src/core/Language.ts b/vscode/src/core/Language.ts
@@ -1,6 +1,7 @@
 import path from 'path';
 import { sendTelemetry } from '../api/telemetry/telemetry';
-import { env } from 'vscode';
+import { commands, env } from 'vscode';
+import { Settings } from '../config';
 
 export enum Language {
     None = 0,
@@ -30,25 +31,27 @@ export function setLanguage(file?: string) {
     const filename = path.basename(file);
     switch (filename.toLowerCase()) {
         case "cargo.toml":
-            return setLanguageConfig(Language.Rust, "rust", filename, OCVEnvironment.Cratesio);
+            return setLanguageConfig(Language.Rust, "rust", filename, OCVEnvironment.Cratesio, Settings.rust.lockFileEnabled);
         case "go.mod":
             return setLanguageConfig(Language.Golang, "go", filename, OCVEnvironment.Go);
         case "package.json":
-            return setLanguageConfig(Language.JS, "npm", filename, OCVEnvironment.Npm);
+            return setLanguageConfig(Language.JS, "npm", filename, OCVEnvironment.Npm, Settings.npm.lockFileEnabled);
         case "requirements.txt":
             return setLanguageConfig(Language.Python, "python", filename, OCVEnvironment.Pypi);
         case "composer.json":
-            return setLanguageConfig(Language.PHP, "php", filename, OCVEnvironment.Packagist);
+            return setLanguageConfig(Language.PHP, "php", filename, OCVEnvironment.Packagist, Settings.php.lockFileEnabled);
         case "pyproject.toml":
-            return setLanguageConfig(Language.Python, "python", filename, OCVEnvironment.Pypi);
+            return setLanguageConfig(Language.Python, "python", filename, OCVEnvironment.Pypi, Settings.python.lockFileEnabled);
     }
 };
 
-function setLanguageConfig(language: Language, config: string, filename: string, OCVenv: OCVEnvironment) {
+function setLanguageConfig(language: Language, config: string, filename: string, OCVenv: OCVEnvironment, isLockFileEnabled?: boolean) {
     CurrentLanguage = language;
     CurrentLanguageConfig = config;
     CurrentEnvironment = OCVenv;
     if (env.isTelemetryEnabled) 
         sendTelemetry({FileName: filename})
+    if (isLockFileEnabled !== undefined)
+        commands.executeCommand("setContext", "dependi.isEnableLockParsing", isLockFileEnabled);
     return language;
 }
diff --git a/vscode/src/core/parsers/JsonParser.ts b/vscode/src/core/parsers/JsonParser.ts
@@ -1,4 +1,4 @@
-import { TextDocument, TextLine, window } from "vscode";
+import { commands, TextDocument, TextLine, window } from "vscode";
 import Item from "../Item";
 import { isQuote, shouldIgnoreLine } from "./utils";
 import { Settings } from "../../config";
@@ -82,6 +82,7 @@ export class JsonParser {
         const fileContent = fs.readFileSync(lockFilePath, "utf8");
         const LockFileParser = this.lockParser;
         item = LockFileParser.parse(fileContent, item);
+        commands.executeCommand("setContext", "dependi.hasLockFile", true); 
       }
     } catch (err) {
       console.error(err);

diff --git a/vscode/src/core/parsers/TomlParser.ts b/vscode/src/core/parsers/TomlParser.ts
@@ -1,4 +1,4 @@
-import { TextDocument, TextLine, window } from "vscode";
+import { commands, TextDocument, TextLine, window } from "vscode";
 import Item from "../Item";
 import { Parser } from "./parser";
 import { isQuote, shouldIgnoreLine } from "./utils";
@@ -286,6 +286,7 @@ function parseLockFile(item: Item[]): Item[] {
       const fileContent = fs.readFileSync(lockFilePath, "utf8");
       const LockFileParser = new TomlLockFileParser();
       item = LockFileParser.parse(fileContent, item);
+      commands.executeCommand("setContext", "dependi.hasLockFile", true); 
     }
   } catch (err) {
     console.error(err);

diff --git a/vscode/src/extension.ts b/vscode/src/extension.ts
@@ -21,6 +21,10 @@ import listener from "./core/listeners";
 import { ChangelogPanel } from "./panels/ChangelogPanel";
 import { WelcomePagePanel } from "./panels/WelcomePanel";
 import { ExtensionStorage } from "./storage";
+import { disableLockFileParsing } from "./commands/lock-file/disableLockFileParsing";
+import { enableLockFileParsing } from "./commands/lock-file/enableLockFileParsing";
+import { lockFileParsed } from "./commands/lock-file/lockFileParsed";
+
 
 export var Logger: OutputChannel;
 
@@ -83,6 +87,9 @@ export function activate(context: ExtensionContext) {
   context.subscriptions.push(updateAll);
   context.subscriptions.push(generateVulnerabilityReport(context));
   context.subscriptions.push(generateCurrentVulnReport(context));
+  context.subscriptions.push(disableLockFileParsing);
+  context.subscriptions.push(enableLockFileParsing);
+  context.subscriptions.push(lockFileParsed);
 }
 
 export function deactivate() {

diff --git a/vscode/src/icons/lock-doc-dark.svg b/vscode/src/icons/lock-doc-dark.svg
diff --git a/vscode/src/icons/lock-doc-light.svg b/vscode/src/icons/lock-doc-light.svg
diff --git a/vscode/src/webviews/utils.ts b/vscode/src/webviews/utils.ts
@@ -1,10 +1,13 @@
 export function markdownToHTML(markdown: string): string {
-  // Convert links to HTML
+  // Convert images to HTML
   let html = markdown.replace(
-    /\[([^\]]+)\]\(([^)]+)\)/g,
-    '<a href="$2">$1</a>'
+    /!\[([^\]]+)\]\(([^)]+)\)/g,
+    '<img src="$2" alt="$1">'
   );
 
+  // Convert links to HTML
+  html = html.replace(/\[([^\]]+)\]\(([^)]+)\)/g, '<a href="$2">$1</a>');
+
   // Convert headings to HTML"
   html = html.replace(/^#\s(.*)$/gm, "<h1>$1</h1>");
   html = html.replace(/^##\s(.*)$/gm, "<h2>$1</h2>");