/doc

Author: feli0x

src/createCodeSnippet.ts

@@ -8,6 +8,11 @@ import {
 } from "./snippet";
 import * as path from "path";
 
+/**
+ * Creates a code snippet from the selected text in the active text editor.
+ * Prompts the user to enter a name for the snippet and saves it to the workspace's `.vscode/workspace.code-snippets` file.
+ * If a snippet with the same name already exists, prompts the user to either change the name or update the existing snippet.
+ */
 async function createCodeSnippet() {
   const editor = vscode.window.activeTextEditor;
   if (!editor) {

src/extension.ts

@@ -2,6 +2,10 @@ import * as vscode from "vscode";
 import { createCodeSnippet } from "./createCodeSnippet";
 import { updatePrefixSymbol } from "./updatePrefixSymbol";
 
+/**
+ * Activates the extension and registers the `extension.workspaceCodeSnippet` command.
+ * @param context The extension context.
+ */
 export function activate(context: vscode.ExtensionContext) {
   const disposable = vscode.commands.registerCommand(
     "extension.workspaceCodeSnippet",
@@ -10,9 +14,9 @@ export function activate(context: vscode.ExtensionContext) {
 
   context.subscriptions.push(disposable);
 
+  // Update prefix symbol when configuration changes
   vscode.workspace.onDidChangeConfiguration((event) => {
     if (event.affectsConfiguration("prefixSymbol")) {
-      // Update the snippets
       updatePrefixSymbol();
     }
   });

src/snippet.ts

@@ -8,6 +8,11 @@ interface Snippet {
   };
 }
 
+/**
+ * Reads a snippet file and returns a snippet object.
+ * @param snippetFilePath - The path of the file to read.
+ * @returns A Snippet object.
+ */
 async function readSnippetFile(snippetFilePath: string): Promise<Snippet> {
   try {
     const snippetFileContentBuffer = await fs.readFile(snippetFilePath);
@@ -17,6 +22,12 @@ async function readSnippetFile(snippetFilePath: string): Promise<Snippet> {
   }
 }
 
+/**
+ * Writes a snippet object to a file.
+ * @param snippetFilePath - The path of the file to write to.
+ * @param snippet - The snippet object to write to the file.
+ * @throws An error if there was a problem writing the file.
+ */
 async function writeSnippetFile(
   snippetFilePath: string,
   snippet: Snippet
@@ -32,6 +43,14 @@ function sanitizeName(name: string): string {
   return name.replace(/[^a-zA-Z0-9]/g, "-");
 }
 
+/**
+ * Creates a snippet object with the given name, prefix, language ID, and selection.
+ * @param name - The name of the snippet.
+ * @param prefixName - The prefix of the snippet.
+ * @param languageId - The language ID of the snippet.
+ * @param selection - The code snippet.
+ * @returns A Snippet object.
+ */
 function createSnippet(
   name: string,
   prefixName: string,

src/updatePrefixSymbol.ts

@@ -2,8 +2,12 @@ import * as vscode from "vscode";
 import * as path from "path";
 import { Snippet, readSnippetFile, writeSnippetFile } from "./snippet";
 
+/**
+ * Updates the prefix symbol of all snippets in the workspace.code-snippets file.
+ * If the `prefixSymbol` configuration setting is set, replaces all non-alphanumeric characters in the prefix with it.
+ * @returns void
+ */
 function updatePrefixSymbol() {
-  // Get the path to the snippet file
   const workspaceFolder = vscode.workspace.workspaceFolders?.[0];
   if (!workspaceFolder) {
     vscode.window.showErrorMessage("No workspace folder found.");
@@ -15,15 +19,12 @@ function updatePrefixSymbol() {
     "workspace.code-snippets"
   );
 
-  // Read the snippet file
   readSnippetFile(snippetFilePath).then((snippetFileContent) => {
-    // Check if any snippet prefix contains a special character
     const specialCharRegex = /[^a-zA-Z0-9]/g;
     const hasSpecialChar = Object.keys(snippetFileContent).some((key) =>
       specialCharRegex.test(snippetFileContent[key].prefix)
     );
 
-    // Update the snippets
     const newSnippetFileContent: Snippet = {};
     Object.keys(snippetFileContent).forEach((key) => {
       const snippet = snippetFileContent[key];
@@ -41,7 +42,6 @@ function updatePrefixSymbol() {
       newSnippetFileContent[key] = newSnippet;
     });
 
-    // Write the updated snippets to the file
     writeSnippetFile(snippetFilePath, newSnippetFileContent);
   });
 }