fix: refactored whole extension

- documented complex functions
- documented all files
- added License into entry point ifle
- removed useless code

Author: Giovanni D'Andrea

codeishot_extension/package.json

@@ -51,13 +51,18 @@
       }
     ],
     "configuration": {
-      "type": "string",
+      "type": "object",
       "title": "Codeishot",
       "properties": {
           "jwt": {
               "type": "string",
               "default": "",
               "description": "Token to login into codeishot."
+          },
+          "Authentication": {
+            "type": "boolean",
+            "default": false,
+            "description": "Choose whether to authenticate the snippets or not."
           }
       }
   }

codeishot_extension/src/axiosPlugin.ts

@@ -1,12 +1,13 @@
 /**
- * Ported from vue axios plugin.
- * Needs to:
- * - Use the extension configuration instead of authStore
- * - Change the import.meta
+ * This file is a Typescript module that uses Axios, a Promise-based HTTP client, to make HTTP requests.
+ * It creates an Axios instance with custom configurations, such as base URL,
+ * timeout, headers, etc. It also defines an interceptor to add a bearer token
+ * to the request headers if the user is authenticated.
+ * Finally, it exports the configured Axios instance as a default export.
  */
-
 import axios from "axios";
-import { getTokenFromConfiguration } from "./login";
+import { getTokenFromConfiguration } from "./utils";
+import { isAuthApproved } from "./preferences";
 
 const fetch = axios.create({
   baseURL: process.env.API_BASE_URL || "https://api.codeishot.com",
@@ -25,8 +26,9 @@ fetch.interceptors.request.use(
     // Check if the user tokens are stored to apply the bearer on the headers,
     // Otherwise the request is not authenticated.
     const token = getTokenFromConfiguration();
+    const isAuthApprvd = isAuthApproved();
 
-    if (token) {
+    if (token && isAuthApprvd) {
       config.headers.Authorization = `Bearer ${token}`;
     }
     return config;

codeishot_extension/src/commands.ts

@@ -0,0 +1,62 @@
+/**
+ * This file is a TypeScript module for a Visual Studio Code extension.
+ * It imports various components from the VS Code API and other custom modules.
+ * It defines two commands: one for logging in and another for creating a code snippet.
+ * The createSnippetCommand retrieves the selected text from the editor, creates a snippet
+ * object with metadata, posts it to a server, and handles the response.
+ */
+
+import { commands, window, type Disposable } from "vscode";
+import {
+  getSelectedText,
+  getCurrentFileName,
+  getLanguageIdentifier,
+  type PostData,
+  postSnippet,
+  handlePostResponse,
+} from "./snippets";
+import { login } from "./login";
+
+export const loginCommand: Disposable = commands.registerCommand(
+  "extension.login",
+  () => {
+    login();
+  }
+);
+
+/**
+ * Defines a command called "extension.postSnippet" in a Visual Studio Code extension.
+ * When executed, it retrieves the currently active text editor, checks if there is text selected,
+ * constructs a snippet object with metadata like title, code, language, and style,
+ * then posts this data to a server asynchronously. If successful, it handles the response;
+ * otherwise, it shows an error message.
+ */
+export const createSnippetCommand: Disposable = commands.registerCommand(
+  "extension.postSnippet",
+  async () => {
+    const editor = window.activeTextEditor;
+    if (!editor) {
+      window.showErrorMessage("No editor found");
+      return;
+    }
+
+    const text = getSelectedText(editor); // get the selected buffer text
+    if (!text) {
+      return;
+    }
+
+    const postData: PostData = {
+      title: getCurrentFileName() || "untitled",
+      code: text,
+      language: getLanguageIdentifier() || "python",
+      style: "androidstudio",
+    };
+
+    try {
+      const data = await postSnippet(postData);
+      await handlePostResponse(data);
+    } catch (error: any) {
+      window.showErrorMessage("Error: " + error.message);
+    }
+  }
+);

codeishot_extension/src/config.ts

@@ -1,8 +1,16 @@
+/**
+ * This file handles all configurations for the extension
+ */
+
 const headers = {
   accept: "application/json",
   contentType: "application/json",
   userAgent: "codeishot/1.0.0",
   // 'X-CSRFTOKEN': csrfToken,
 };
 
-export { headers };
+const UI_BASE_URL: string = process.env.UI_BASE_URL || "https://codeishot.com";
+const UI_BASE_URL_LOGIN: string =
+  process.env.UI_BASE_URL || "https://codeishot.com/login?type=vscode";
+
+export { headers, UI_BASE_URL, UI_BASE_URL_LOGIN };

codeishot_extension/src/customs.ts

@@ -1,3 +1,7 @@
+/**
+ * Defines Custom data types and some of their implementations.
+ */
+
 import type {
   AxiosResponse,
   InternalAxiosRequestConfig,

codeishot_extension/src/extension.ts

@@ -1,166 +1,37 @@
-import * as vscode from "vscode";
-import * as path from "path";
-import { createSnippet } from "./services/codeishotServices";
-import { saveToken, login } from "./login";
-
-const UI_BASE_URL: string = process.env.UI_BASE_URL || "https://codeishot.com";
-
-interface PostData {
-  title: string;
-  code: string;
-  style: string;
-  language: string;
-}
-
-interface Snippet {
-  id: string;
-  title: string;
-  language: string;
-  style: string;
-  code: string;
-  createdAt: string;
-  editedAt: string;
-}
-
-function getSelectedText(editor: vscode.TextEditor): string | null {
-  const selection = editor.selection;
-  const text = editor.document.getText(selection);
-
-  if (!text) {
-    vscode.window.showErrorMessage("No text selected");
-    return null;
-  }
-
-  return text;
-}
-
-function getCurrentFileName(): string | null {
-  const editor = vscode.window.activeTextEditor;
-  if (editor) {
-    const document = editor.document;
-    const fullPath = document.fileName;
-    return path.basename(fullPath);
-  }
-  return null;
-}
-
-function getLanguageIdentifier(): string | null {
-  const editor = vscode.window.activeTextEditor;
-  if (editor) {
-    const languageId = editor.document.languageId;
-    return languageId;
-  }
-  return null;
-}
-
-function checkCreateSnippetStatusCode(status: number, data: PostData) {
-  switch (status) {
-    case 400:
-      vscode.window.showWarningMessage(
-        "This language is not available, sending snippet as a Plain Text"
-      );
-      const newRes = postSnippetWithValidatedData(data);
-      return newRes;
-    case 429:
-      vscode.window.showErrorMessage("Too many requests!");
-      break;
-    default:
-      break;
-  }
-}
-
-async function postSnippet(data: PostData): Promise<Snippet> {
-  let res = await createSnippet(data);
-  if (res.status_code) checkCreateSnippetStatusCode(res.status_code, data);
-  return res.data as Promise<Snippet>;
-}
-
-async function postSnippetWithValidatedData(data: PostData): Promise<Snippet> {
-  let plainTextData: PostData = { ...data };
-  plainTextData.language = "plaintext";
-
-  return await createSnippet(plainTextData)
-    .then((res) => res.data)
-    .catch(() => {
-      vscode.window.showWarningMessage("Please try again!");
-    });
-}
-
-async function handlePostResponse(data: Snippet) {
-  if (data && data.id) {
-    const snippetUrl = `${UI_BASE_URL}/${data.id}`;
-    try {
-      await vscode.env.clipboard.writeText(snippetUrl);
-      vscode.window.showInformationMessage("URL copied to clipboard");
-    } catch (error) {
-      vscode.window.showErrorMessage("Error copying URL: " + error);
-    }
-
-    const infoMessage = await vscode.window.showInformationMessage(
-      snippetUrl,
-      "Open URL"
-    );
-    if (infoMessage === "Open URL") {
-      vscode.env.openExternal(vscode.Uri.parse(snippetUrl));
-    }
-  }
-}
-
-function activate(context: vscode.ExtensionContext) {
-  let disposable = vscode.commands.registerCommand(
-    "extension.postSnippet",
-    async () => {
-      const editor = vscode.window.activeTextEditor;
-      if (!editor) {
-        vscode.window.showErrorMessage("No editor found");
-        return;
-      }
-
-      const text = getSelectedText(editor);
-      if (!text) {
-        return;
-      }
-
-      const postData: PostData = {
-        title: getCurrentFileName() || "untitled",
-        code: text,
-        language: getLanguageIdentifier() || "python",
-        style: "androidstudio",
-      };
-
-      try {
-        const data = await postSnippet(postData);
-        await handlePostResponse(data);
-      } catch (error: any) {
-        vscode.window.showErrorMessage("Error: " + error.message);
-      }
-    }
-  );
-
-  const loginCommand = vscode.commands.registerCommand(
-    "extension.login",
-    () => {
-      login();
-    }
-  );
-
-  context.subscriptions.push(disposable);
+/**
+ * MIT License
+ * Copyright (c) [2024] [Codeishot]
+ * Giovanni D'Andrea => @gdjohn4s
+ * Flavio Adamo => @FlavioAdamo
+ * Gianluca Andretta => @gnlca
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+import { loginCommand, createSnippetCommand } from "./commands";
+import { type ExtensionContext } from "vscode";
+import { loginUriHandler } from "./handlers";
+
+function activate(context: ExtensionContext) {
+  context.subscriptions.push(createSnippetCommand);
   context.subscriptions.push(loginCommand);
-  context.subscriptions.push(
-    // vscode://codeishot.codeishot/login?jwt=<token>
-    // TODO: @Cleanup => Move to another file, maybe `handlers.ts`?
-    vscode.window.registerUriHandler({
-      handleUri(uri: vscode.Uri) {
-        if (uri.path === "/login") {
-          const jwtParam = uri.query.split("=")[1];
-          if (jwtParam) {
-            vscode.window.showInformationMessage("Logged Successfully! ✨");
-            saveToken(jwtParam);
-          }
-        }
-      },
-    })
-  );
+  context.subscriptions.push(loginUriHandler);
 }
 
 function deactivate() {}

codeishot_extension/src/handlers.ts

@@ -0,0 +1,18 @@
+/**
+ * Defines various handlers for this vscode extension.
+ */
+
+import { window, Uri, type Disposable } from "vscode";
+import { updateUserConfiguration } from "./utils";
+
+export const loginUriHandler: Disposable = window.registerUriHandler({
+  handleUri(uri: Uri) {
+    if (uri.path === "/login") {
+      const jwtParam = uri.query.split("=")[1];
+      if (jwtParam) {
+        window.showInformationMessage("Logged Successfully! ✨");
+        updateUserConfiguration(jwtParam);
+      }
+    }
+  },
+});