Merge pull request #382 from mre/feat/377

Saved snippets searching

Author: VladBrok

README.md

@@ -121,6 +121,10 @@ Saved snippets are displayed in IntelliSense
 
 ![Preview](https://raw.githubusercontent.com/mre/vscode-snippet/master/contrib/snippets-storage/intellisense.gif)
 
+### Searching for saved snippets
+
+![Preview](https://raw.githubusercontent.com/mre/vscode-snippet/master/contrib/snippets-storage/search.gif)
+
 ## Contributing
 
 See [CONTRIBUTING.md](./CONTRIBUTING.md)

contrib/snippets-storage/search.gif

@@ -2,7 +2,7 @@
   "name": "snippet",
   "displayName": "Snippet",
   "description": "Insert a snippet from cht.sh for Python, JavaScript, Ruby, C#, Go, Rust (and any other language)",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "publisher": "vscode-snippet",
   "engines": {
     "vscode": "^1.74.0"

package-lock.json

@@ -4,10 +4,13 @@ import { query } from "./query";
 import { encodeRequest } from "./provider";
 import snippet from "./snippet";
 import { SnippetsTreeProvider, SnippetsTreeItem } from "./snippetsTreeProvider";
+import SnippetsStorage from "./snippetsStorage";
+import languages from "./languages";
 
 export interface Request {
   language: string;
   query: string;
+  savedSnippetContent?: string;
 }
 
 const loadingStatus = vscode.window.createStatusBarItem(
@@ -20,98 +23,116 @@ export async function findWithProvider(
   userQuery: string,
   verbose: boolean,
   number: number,
-  openInNewEditor = true
+  openInNewEditor = true,
+  savedSnippetContent?: string
 ) {
   let doc: vscode.TextDocument | null = null;
 
-  loadingStatus.show();
-  try {
-    const uri = encodeRequest(userQuery, language, verbose, number);
+  if (!savedSnippetContent) {
+    loadingStatus.show();
+    try {
+      const uri = encodeRequest(userQuery, language, verbose, number);
 
-    // Calls back into the provider
-    doc = await vscode.workspace.openTextDocument(uri);
-  } finally {
-    loadingStatus.hide();
-  }
+      // Calls back into the provider
+      doc = await vscode.workspace.openTextDocument(uri);
+    } finally {
+      loadingStatus.hide();
+    }
 
-  try {
-    doc = await vscode.languages.setTextDocumentLanguage(doc, language);
-  } catch (e) {
-    console.log(`Cannot set document language to ${language}: ${e}`);
+    try {
+      doc = await vscode.languages.setTextDocumentLanguage(doc, language);
+    } catch (e) {
+      console.log(`Cannot set document language to ${language}: ${e}`);
+    }
   }
+
   const editor = vscode.window.activeTextEditor;
 
-  // Open in new editor in case the respective config flag is set to true
+  // Open in new editor in case there is no saved snippet content and the respective config flag is set to true
   // or there is no open user-created editor where we could paste the snippet in.
-  if (openInNewEditor || !editor || editor.document.uri.scheme == "snippet") {
+  if (
+    !savedSnippetContent &&
+    (openInNewEditor || !editor || editor.document.uri.scheme == "snippet")
+  ) {
     await vscode.window.showTextDocument(doc, {
       viewColumn: vscode.ViewColumn.Two,
       preview: true,
       preserveFocus: false,
     });
   } else {
-    const snippet = new vscode.SnippetString(doc.getText());
+    const text = savedSnippetContent ? savedSnippetContent : doc.getText();
+    const snippet = new vscode.SnippetString(text);
     const success = await editor.insertSnippet(snippet);
     if (!success) {
       vscode.window.showInformationMessage("Error while opening snippet.");
     }
   }
 }
 
-export async function getInput(): Promise<Request> {
+export async function getInput(
+  snippetsStorage: SnippetsStorage
+): Promise<Request> {
   const language = await getLanguage();
-  const userQuery = await query(language);
-  return { language, query: userQuery };
+  const userQuery = await query(language, snippetsStorage);
+  return {
+    language,
+    query: userQuery.input,
+    savedSnippetContent: userQuery.savedSnippetContent,
+  };
 }
 
-export async function findForLanguage() {
+export async function findForLanguage(snippetsStorage: SnippetsStorage) {
   const language = await pickLanguage();
-  const userQuery = await query(language);
+  const userQuery = await query(language, snippetsStorage);
   await findWithProvider(
     language,
-    userQuery,
+    userQuery.input,
     snippet.getVerbose(),
     0,
-    getConfig("openInNewEditor")
+    getConfig("openInNewEditor"),
+    userQuery.savedSnippetContent
   );
 }
 
-export async function findDefault() {
-  const request = await getInput();
+export async function findDefault(snippetsStorage: SnippetsStorage) {
+  const request = await getInput(snippetsStorage);
   await findWithProvider(
     request.language,
     request.query,
     snippet.getVerbose(),
     0,
-    getConfig("openInNewEditor")
+    getConfig("openInNewEditor"),
+    request.savedSnippetContent
   );
 }
 
-export async function findInplace() {
-  const request = await getInput();
+export async function findInplace(snippetsStorage: SnippetsStorage) {
+  const request = await getInput(snippetsStorage);
   await findWithProvider(
     request.language,
     request.query,
     snippet.getVerbose(),
     0,
-    false
+    false,
+    request.savedSnippetContent
   );
 }
 
-export async function findInNewEditor() {
-  const request = await getInput();
+export async function findInNewEditor(snippetsStorage: SnippetsStorage) {
+  const request = await getInput(snippetsStorage);
   await findWithProvider(
     request.language,
     request.query,
     snippet.getVerbose(),
     0,
-    true
+    true,
+    request.savedSnippetContent
   );
 }
 
-export async function showNextAnswer() {
+export async function showNextAnswer(snippetsStorage: SnippetsStorage) {
   if (!snippet.getCurrentQuery()) {
-    return await findDefault();
+    return await findDefault(snippetsStorage);
   }
   const answerNumber = snippet.getNextAnswerNumber();
   await findWithProvider(
@@ -123,9 +144,9 @@ export async function showNextAnswer() {
   );
 }
 
-export async function showPreviousAnswer() {
+export async function showPreviousAnswer(snippetsStorage: SnippetsStorage) {
   if (!snippet.getCurrentQuery()) {
-    return await findDefault();
+    return await findDefault(snippetsStorage);
   }
   const answerNumber = snippet.getPreviousAnswerNumber();
   if (answerNumber == null) {
@@ -204,8 +225,12 @@ export function saveSnippet(treeProvider: SnippetsTreeProvider) {
       const defaultLabel = content.substring(0, 100);
       const fileName = editor.document.fileName;
       const indexOfLastDot = fileName.lastIndexOf(".");
+      const extensionByLangId =
+        languages.getExtensions(editor.document.languageId)[0] || "";
       const fileExtension =
-        indexOfLastDot === -1 ? "" : fileName.slice(indexOfLastDot);
+        indexOfLastDot === -1
+          ? extensionByLangId
+          : fileName.slice(indexOfLastDot);
 
       const nameInputOptions: vscode.InputBoxOptions = {
         ignoreFocusOut: false,

package.json

@@ -16,27 +16,27 @@ export function activate(ctx: vscode.ExtensionContext) {
   const snippetsTreeProvider = new SnippetsTreeProvider(ctx, snippetsStorage);
   new CompletionManager(ctx, snippetsStorage);
 
-  vscode.commands.registerCommand("snippet.find", endpoints.findDefault);
-  vscode.commands.registerCommand(
-    "snippet.findForLanguage",
-    endpoints.findForLanguage
+  vscode.commands.registerCommand("snippet.find", () =>
+    endpoints.findDefault(snippetsStorage)
   );
-  vscode.commands.registerCommand("snippet.findInplace", endpoints.findInplace);
-  vscode.commands.registerCommand(
-    "snippet.findInNewEditor",
-    endpoints.findInNewEditor
+  vscode.commands.registerCommand("snippet.findForLanguage", () =>
+    endpoints.findForLanguage(snippetsStorage)
+  );
+  vscode.commands.registerCommand("snippet.findInplace", () =>
+    endpoints.findInplace(snippetsStorage)
+  );
+  vscode.commands.registerCommand("snippet.findInNewEditor", () =>
+    endpoints.findInNewEditor(snippetsStorage)
   );
   vscode.commands.registerCommand(
     "snippet.findSelectedText",
     endpoints.findSelectedText
   );
-  vscode.commands.registerCommand(
-    "snippet.showPreviousAnswer",
-    endpoints.showPreviousAnswer
+  vscode.commands.registerCommand("snippet.showPreviousAnswer", () =>
+    endpoints.showPreviousAnswer(snippetsStorage)
   );
-  vscode.commands.registerCommand(
-    "snippet.showNextAnswer",
-    endpoints.showNextAnswer
+  vscode.commands.registerCommand("snippet.showNextAnswer", () =>
+    endpoints.showNextAnswer(snippetsStorage)
   );
   vscode.commands.registerCommand(
     "snippet.toggleComments",

src/endpoints.ts

@@ -0,0 +1,20 @@
+import * as vscode from "vscode";
+
+class Languages {
+  constructor(private readonly fileExtensions = new Map<string, string[]>()) {
+    for (const extension of vscode.extensions.all) {
+      const languages = extension.packageJSON.contributes.languages;
+      if (languages) {
+        for (const lang of languages) {
+          fileExtensions.set(lang.id, lang.extensions);
+        }
+      }
+    }
+  }
+
+  getExtensions(languageId: string): string[] {
+    return this.fileExtensions.get(languageId) || [];
+  }
+}
+
+export default new Languages();

src/extension.ts

@@ -2,8 +2,12 @@
 
 import * as vscode from "vscode";
 import { cache } from "./cache";
+import SnippetsStorage from "./snippetsStorage";
+import languages from "./languages";
 
-function quickPickCustom(items: vscode.QuickPickItem[]): Promise<string> {
+function quickPickCustom(
+  items: vscode.QuickPickItem[]
+): Promise<string | vscode.QuickPickItem> {
   return new Promise((resolve) => {
     const quickPick = vscode.window.createQuickPick();
     quickPick.title = 'Enter keywords for snippet search (e.g. "read file")';
@@ -14,9 +18,9 @@ function quickPickCustom(items: vscode.QuickPickItem[]): Promise<string> {
     });
 
     quickPick.onDidAccept(() => {
-      let search = "";
+      let search: string | vscode.QuickPickItem = "";
       if (quickPick.activeItems.length) {
-        search = quickPick.activeItems[0]["label"];
+        search = quickPick.activeItems[0];
       } else {
         search = quickPick.value;
       }
@@ -27,24 +31,56 @@ function quickPickCustom(items: vscode.QuickPickItem[]): Promise<string> {
   });
 }
 
-export async function query(language: string): Promise<string> {
+export interface QueryResult {
+  input: string;
+  savedSnippetContent?: string;
+}
+
+export async function query(
+  language: string,
+  snippetsStorage: SnippetsStorage
+): Promise<QueryResult> {
   const suggestions = new Set(
     cache.state.get<string[]>(`snippet_suggestions_${language}`, [])
   );
 
   const suggestionsQuickItems: Array<vscode.QuickPickItem> = [];
+  const languageFileExtensions = languages.getExtensions(language);
+  const savedSnippetDescription = "[saved snippet]";
+
+  for (const snippet of snippetsStorage.getSnippets()) {
+    if (languageFileExtensions.includes(snippet.data.fileExtension)) {
+      suggestionsQuickItems.push({
+        label: snippet.data.label,
+        detail: snippet.data.content,
+        description: savedSnippetDescription,
+      });
+    }
+  }
+
   for (const suggestion of suggestions) {
     const tempQuickItem: vscode.QuickPickItem = {
       label: suggestion,
       description: "",
     };
     suggestionsQuickItems.push(tempQuickItem);
   }
-  const input = await quickPickCustom(suggestionsQuickItems);
-  suggestions.add(input);
-  cache.state.update(
-    `snippet_suggestions_${language}`,
-    [...suggestions].sort()
-  );
-  return input;
+
+  const selectedItem = await quickPickCustom(suggestionsQuickItems);
+  const input =
+    typeof selectedItem === "string" ? selectedItem : selectedItem.label;
+  const savedSnippetContent =
+    typeof selectedItem === "string" ||
+    selectedItem.description !== savedSnippetDescription
+      ? undefined
+      : selectedItem.detail;
+
+  if (!savedSnippetContent) {
+    suggestions.add(input);
+    cache.state.update(
+      `snippet_suggestions_${language}`,
+      [...suggestions].sort()
+    );
+  }
+  return { input, savedSnippetContent };
 }