Merge pull request #53 from DeepCodeAI/dashboard_dc_ignore

Added dcignore node to HELP section and command palette.

Author: Arvi3d

package-lock.json

@@ -168,6 +168,10 @@
         {
           "command": "deepcode.login",
           "when": "!deepcode:loggedIn"
+        },
+        {
+          "command": "deepcode.dcignore",
+          "when": "!deepcode:error && deepcode:loggedIn && deepcode:uploadApproved && deepcode:workspaceFound"
         }
       ]
     },
@@ -184,7 +188,13 @@
       },
       {
         "command": "deepcode.login",
-        "title": "DeepCode login"
+        "title": "DeepCode login",
+        "icon": "$(log-in)"
+      },
+      {
+        "command": "deepcode.dcignore",
+        "title": "DeepCode create dcignore file",
+        "icon": "$(new-file)"
       }
     ]
   },
@@ -215,6 +225,7 @@
   },
   "dependencies": {
     "@deepcode/tsc": "^1.3.0",
+    "@deepcode/dcignore": "^1.0.2",
     "@types/lodash": "^4.14.159",
     "@types/mz": "^2.7.1",
     "ignore": "^5.1.8",

package.json

@@ -7,12 +7,13 @@ import DeepCodeLib from "./lib/modules/DeepCodeLib";
 import {
   DEEPCODE_START_COMMAND, 
   DEEPCODE_SETTINGS_COMMAND,
+  DEEPCODE_DCIGNORE_COMMAND,
   DEEPCODE_LOGIN,
   DEEPCODE_APPROVE,
   DEEPCODE_OPEN_BROWSER,
   DEEPCODE_OPEN_LOCAL,
 } from "./constants/commands";
-import { openDeepcodeSettingsCommand } from "./utils/vscodeCommandsUtils";
+import { openDeepcodeSettingsCommand, createDCIgnoreCommand } from "./utils/vscodeCommandsUtils";
 import { errorsLogs } from "./messages/errorsServerLogMessages";
 
 import {
@@ -108,6 +109,13 @@ class DeepCodeExtension extends DeepCodeLib implements DeepCode.ExtensionInterfa
       )
     );
 
+    context.subscriptions.push(
+      vscode.commands.registerCommand(
+        DEEPCODE_DCIGNORE_COMMAND,
+        createDCIgnoreCommand
+      )
+    );
+
     vscode.window.registerTreeDataProvider(
       DEEPCODE_VIEW_SUPPORT, 
       new SupportProvider(this)

src/deepcode/DeepCodeExtension.ts

@@ -8,6 +8,7 @@ export const DEEPCODE_LOGIN = "deepcode.login";
 export const DEEPCODE_APPROVE = "deepcode.approve";
 export const DEEPCODE_SETTINGS_COMMAND = "deepcode.settings";
 export const DEEPCODE_IGNORE_ISSUES_COMMAND = "deepcode.ignoreissues";
+export const DEEPCODE_DCIGNORE_COMMAND = "deepcode.dcignore";
 export const DEEPCODE_OPEN_BROWSER = "deepcode.open";
 export const DEEPCODE_OPEN_LOCAL = "deepcode.show";
 

src/deepcode/constants/commands.ts

@@ -1,7 +1,9 @@
+import * as vscode from "vscode";
 import * as crypto from "crypto";
 import * as nodePath from "path";
 import { Buffer } from "buffer";
 import { fs } from "mz";
+import { CustomDCIgnore, DefaultDCIgnore } from "@deepcode/dcignore";
 import {
   HASH_ALGORITHM,
   ENCODE_TYPE,
@@ -12,7 +14,6 @@ import {
 } from "../constants/filesConstants";
 import { ALLOWED_PAYLOAD_SIZE } from "../constants/general";
 import DeepCode from "../../interfaces/DeepCodeInterfaces";
-import { ExclusionFilter } from "../utils/ignoreUtils";
 
 // The file limit was hardcoded to 2mb but seems to be a function of ALLOWED_PAYLOAD_SIZE
 // TODO what exactly is transmitted eventually and what is a good exact limit?
@@ -181,3 +182,16 @@ export const splitPayloadIntoChunks = (
 
   return { chunks: true, payload: chunkedPayload };
 };
+
+export const createDCIgnore = async (
+  path: string,
+  custom: boolean,
+) => {
+  const content: Buffer =  Buffer.from(custom ? CustomDCIgnore : DefaultDCIgnore);
+  const filePath = `${path}/.dcignore`;
+  const openPath = vscode.Uri.file(filePath);
+  // We don't want to override the dcignore file with an empty one.
+  if (!custom || !fs.existsSync(filePath)) await vscode.workspace.fs.writeFile(openPath, content);
+  const doc = await vscode.workspace.openTextDocument(openPath);
+  vscode.window.showTextDocument(doc);
+};

src/deepcode/utils/filesUtils.ts

@@ -5,16 +5,23 @@ import {
   DEEPCODE_CONTEXT_PREFIX,
   DEEPCODE_OPEN_BROWSER,
 } from "../constants/commands";
+import { createDCIgnore } from "./filesUtils"
 
 export const openDeepcodeSettingsCommand = async (): Promise<void> => {
   await vscode.commands.executeCommand(VSCODE_GO_TO_SETTINGS_COMMAND, DEEPCODE_EXTENSION_NAME);
 };
 
 export const setContext = async (key: string, value: unknown): Promise<void> => {
-  console.log("DeepCode context",key, value);
+  console.log("DeepCode context", key, value);
   await vscode.commands.executeCommand('setContext', `${DEEPCODE_CONTEXT_PREFIX}${key}`, value);
 };
 
 export const viewInBrowser = async (url: string): Promise<void> => {
   await vscode.commands.executeCommand(DEEPCODE_OPEN_BROWSER, url);
-};
+};
+
+export const createDCIgnoreCommand = (custom = false, path?: string): void => {
+  path = path || vscode.workspace.rootPath;
+  if (!path) return;
+  createDCIgnore(path, custom).catch(console.error);
+};

src/deepcode/utils/vscodeCommandsUtils.ts

@@ -1,6 +1,7 @@
 import { TreeItemCollapsibleState, ThemeIcon } from 'vscode';
 import { NodeProvider } from './NodeProvider';
 import { Node } from './Node';
+import { DEEPCODE_DCIGNORE_COMMAND } from "../constants/commands";
 
 export class SupportProvider extends NodeProvider {
   getRootChildren(): Node[] {
@@ -21,15 +22,36 @@ export class SupportProvider extends NodeProvider {
             link: "https://www.youtube.com/watch?v=NIDeVYLWkMI"
           }),
           new Node({
-            text: "2. How to ignore files and directories?",
-            icon: new ThemeIcon('file-text'),
-            link: "https://deepcode.freshdesk.com/support/solutions/articles/60000531055-how-can-i-ignore-files-or-directories-"
-          }),
-          new Node({
-            text: "3. How to ignore issues within the code?",
+            text: "2. How to ignore issues within the code?",
             icon: new ThemeIcon('play'),
             link: "https://www.youtube.com/watch?v=sjDuDqUy7pw"
           }),
+          new Node({
+            text: "3. How to ignore files and directories?",
+            icon: new ThemeIcon('file-text'),
+            link: "https://deepcode.freshdesk.com/support/solutions/articles/60000531055-how-can-i-ignore-files-or-directories-",  
+            collapsed: TreeItemCollapsibleState.Expanded,
+            children: [
+              new Node({
+                text: "Add default .dcignore file to your workspace",
+                icon: new ThemeIcon('new-file'),
+                command: {
+                  command: DEEPCODE_DCIGNORE_COMMAND,
+                  title: '',
+                  arguments: [],
+                }
+              }),
+              new Node({
+                text: "Add a custom .dcignore file to your workspace",
+                icon: new ThemeIcon('new-file'),
+                command: {
+                  command: DEEPCODE_DCIGNORE_COMMAND,
+                  title: '',
+                  arguments: [true],
+                }
+              }),
+            ]
+          }),
         ]
       }),
       new Node({