Merge pull request #53 from codiga/feat/suggest-codiga-file

feat: suggest codiga.yml file

Author: juli1

.gitignore

@@ -5,3 +5,4 @@ node_modules
 *.vsix
 .DS_Store
 *~
+webview

src/constants.ts

@@ -1,3 +1,5 @@
+import { Language } from "./graphql-api/types";
+
 export const GRAPHQL_ENDPOINT_PROD = "https://api.codiga.io/graphql";
 export const GRAPHQL_ENDPOINT_STAGING = "https://api-staging.codiga.io/graphql";
 
@@ -7,6 +9,9 @@ export const MESSAGE_STARTUP_SHOW_SHORTCUTS = "View Shortcuts";
 export const MESSAGE_STARTUP_SHOW_SNIPPETS = "Search Snippets";
 export const MESSAGE_STARTUP_DO_NOT_SHOW_AGAIN = "Do not show again";
 
+export const VALUE_STRING_TRUE = "true";
+export const VALUE_STRING_FALSE = "false";
+
 export const DIAGNOSTIC_CODE = "codiga";
 export const DIAGNOSTIC_SOURCE = "Codiga";
 export const LEARN_MORE_COMMAND = "CODIGA_LEARN_MORE";
@@ -68,3 +73,21 @@ export const ELEMENT_CHECKED_TO_ENTITY_CHECKED: Map<string, string> = new Map([
   [ELEMENT_CHECKED_IMPORT, ROSIE_ENTITY_IMPORT],
   [ELEMENT_CHECKED_ASSIGNMENT, ROSIE_ENTITY_ASSIGNMENT],
 ]);
+
+export const INFO_MESSAGE_CODIGA_FILE_KEY = "ignoreCodigaFile";
+export const INFO_MESSAGE_CODIGA_FILE =
+  "Check for security, code style in your Python code with Codiga";
+export const INFO_MESSAGE_CODIGA_FILE_ACTION_CREATE =
+  "Create a codiga.yml file to check code";
+export const INFO_MESSAGE_CODIGA_FILE_ACTION_IGNORE = "Never remind me";
+
+export const DEFAULT_PYTHON_RULESET_CONFIG = `
+rulesets:
+  - python-security
+  - python-best-practices
+  - python-code-style
+`.trim();
+
+export const ROSIE_SUPPORTED_LANGUAGES = [Language.Python];
+
+export const ROSIE_LANGUAGE_DETECT_MAX_RESULTS = 1;

src/extension.ts

@@ -46,6 +46,7 @@ import {
   IgnoreViolation,
   ignoreViolation,
 } from "./diagnostics/ignore-violation";
+import { checkCodigaFileSuggestion } from "./utils/startupUtils";
 
 // this method is called when your extension is activated
 // your extension is activated the very first time the command is executed
@@ -226,6 +227,8 @@ export async function activate(context: vscode.ExtensionContext) {
     context.subscriptions.push(codeCompletionProvider);
   });
 
+  await checkCodigaFileSuggestion();
+
   /**
    * Finally, attempt to get the current user. If the current user
    * does not show, we propose to configure the API keys.

src/rosie/rosieUtils.ts

@@ -0,0 +1,44 @@
+import * as vscode from "vscode";
+import { Extension } from "vscode";
+
+import {
+  ROSIE_LANGUAGE_DETECT_MAX_RESULTS,
+  ROSIE_SUPPORTED_LANGUAGES,
+} from "../constants";
+import { LANGUAGE_TO_EXTENSION } from "../utils/fileUtils";
+
+/**
+ * find out if the workspace contains files of
+ * languages that rosie supports
+ * @returns boolean
+ */
+export async function isRosieLanguageDetected(): Promise<boolean> {
+  /**
+   * get an array of extensions (with the . removed)
+   * for all supported rosie languages
+   */
+  const rosieSupportedExtensions = ROSIE_SUPPORTED_LANGUAGES.reduce(
+    (acc, cVal) => {
+      return [...acc, ...LANGUAGE_TO_EXTENSION[cVal]];
+    },
+    [] as string[]
+  ).map((extension) => extension.substring(1));
+
+  /**
+   * look through the workspace/files to see if
+   * it's using a language that codiga/rosie supports
+   * TODO - detect which languages are used to
+   *        improve ruleset suggestion
+   */
+  const shouldSuggestCodiga = await vscode.workspace
+    .findFiles(
+      `**/*.{${rosieSupportedExtensions.join(",")}}`,
+      "node_modules",
+      ROSIE_LANGUAGE_DETECT_MAX_RESULTS
+    )
+    .then(
+      (files) => files && files.length === ROSIE_LANGUAGE_DETECT_MAX_RESULTS
+    );
+
+  return shouldSuggestCodiga;
+}

src/utils/fileUtils.ts

@@ -1,3 +1,4 @@
+import * as fs from "fs";
 import * as vscode from "vscode";
 import { Language } from "../graphql-api/types";
 const pathModule = require("path");
@@ -29,6 +30,7 @@ const EXTENSION_TO_LANGUAGE: Record<string, Language> = {
   ".php4": Language.Php,
   ".php5": Language.Php,
   ".php": Language.Php,
+  ".ipynb": Language.Python,
   ".py": Language.Python,
   ".py3": Language.Python,
   ".pm": Language.Perl,
@@ -51,6 +53,22 @@ const EXTENSION_TO_LANGUAGE: Record<string, Language> = {
   ".yaml": Language.Yaml,
 };
 
+/**
+ * converts the EXTENSION_TO_LANGUAGE object into:
+ * { [Language]: extension-strings[] }
+ * used to get all extensions for a language
+ */
+export const LANGUAGE_TO_EXTENSION = Object.entries(
+  EXTENSION_TO_LANGUAGE
+).reduce((acc, [extension, language]) => {
+  if (acc[language]) {
+    acc[language].push(extension);
+  } else {
+    acc[language] = [extension];
+  }
+  return acc;
+}, {} as { [key in Language]: string[] });
+
 export function getBasename(filename: string): string | undefined {
   const parsedFilename: any = pathModule.parse(filename);
   const basename: string | undefined = parsedFilename.base;
@@ -190,3 +208,33 @@ export function insertIndentSize(size: number, tabSize: number) {
     .fill("\t")
     .join("");
 }
+
+/**
+ * creates a Uri for the given file, if workspaces are present
+ * @param fileLocation string - from root
+ * @returns vscode.Uri | null
+ */
+export default function getFileUri(fileLocation: string): vscode.Uri | null {
+  const workspaceFolder = vscode.workspace.workspaceFolders;
+  /**
+   * if no workspaces are open or the length is zero,
+   * then the file cannot exist, so we return null
+   */
+  if (!workspaceFolder || workspaceFolder.length === 0) {
+    return null;
+  }
+  return vscode.Uri.joinPath(workspaceFolder[0].uri, fileLocation);
+}
+
+/**
+ * checks if a file exists in the location given
+ * @param fileLocation string - from root
+ * @returns boolean
+ */
+export function doesFileExist(fileLocation: string): boolean {
+  const fileUri = getFileUri(fileLocation);
+  if (!fileUri) {
+    return false;
+  }
+  return fs.existsSync(fileUri.fsPath);
+}

src/utils/startupUtils.ts

@@ -0,0 +1,53 @@
+import * as vscode from "vscode";
+import {
+  CODIGA_RULES_FILE,
+  DEFAULT_PYTHON_RULESET_CONFIG,
+  INFO_MESSAGE_CODIGA_FILE,
+  INFO_MESSAGE_CODIGA_FILE_ACTION_CREATE,
+  INFO_MESSAGE_CODIGA_FILE_ACTION_IGNORE,
+  INFO_MESSAGE_CODIGA_FILE_KEY,
+  VALUE_STRING_TRUE,
+} from "../constants";
+import { isRosieLanguageDetected } from "../rosie/rosieUtils";
+import getFileUri, { doesFileExist } from "./fileUtils";
+import { getFromLocalStorage, setToLocalStorage } from "./localStorage";
+
+/**
+ * checks whether we should suggest a codiga.yml file
+ * for this user's workspace
+ */
+export async function checkCodigaFileSuggestion() {
+  /**
+   * check if
+   * - the user has ignore this warning before
+   * - if there's a codiga.yml file present
+   * - if the workspace contains languages that rosie supports
+   */
+  if (
+    getFromLocalStorage(INFO_MESSAGE_CODIGA_FILE_KEY) !== VALUE_STRING_TRUE &&
+    !doesFileExist(CODIGA_RULES_FILE) &&
+    (await isRosieLanguageDetected())
+  ) {
+    vscode.window
+      .showInformationMessage(
+        INFO_MESSAGE_CODIGA_FILE,
+        INFO_MESSAGE_CODIGA_FILE_ACTION_CREATE,
+        INFO_MESSAGE_CODIGA_FILE_ACTION_IGNORE
+      )
+      .then(async (selectedItem) => {
+        if (selectedItem === INFO_MESSAGE_CODIGA_FILE_ACTION_CREATE) {
+          const codigaUri = getFileUri(CODIGA_RULES_FILE);
+          if (codigaUri) {
+            const codigaFileContent = Buffer.from(
+              DEFAULT_PYTHON_RULESET_CONFIG,
+              "utf-8"
+            );
+            await vscode.workspace.fs.writeFile(codigaUri, codigaFileContent);
+          }
+        }
+        if (selectedItem === INFO_MESSAGE_CODIGA_FILE_ACTION_IGNORE) {
+          setToLocalStorage(INFO_MESSAGE_CODIGA_FILE_KEY, VALUE_STRING_TRUE);
+        }
+      });
+  }
+}