Speedsearch

Speedsearch is a VS Code extension for indexing and searching files. It allows you to configure folders to index, create and refresh the index, and search for words or phrases in indexed files. The search results are displayed in a custom tree view, allowing users to open files directly by clicking on them.

Features

• Configure Speedsearch: Define the folders to index and where to store the index.
• Index a folder: Create an index for a specified folder.
• Refresh the index: Refresh the existing index to include recent modifications.
• Search for a word or phrase: Search for words or phrases in indexed files.
• Display search results: Display search results in a custom tree view, with file paths and occurrences of searched words.
• Open files from the tree view: Click on files or occurrences in the tree view to open them directly in VS Code at the selected line.

Usage

1. Configure Speedsearch:

   • Command: Configure Speedsearch
   • Description: Opens a Webview panel to configure the folders to index, where to store the index, and whether to search for occurrences.
   • Steps:
     1. Press Ctrl + Shift + P to open the Command Palette.
     2. Type Configure Speedsearch and press Enter.
     3. Enter the folder paths for the folder to index and the folder to store the index.
     4. Check or uncheck the option "Search occurrences" based on your preference.
     5. Click the Save button.

2. Index a folder:

   • Command: Index a folder
   • Description: Creates an index for the specified folder. Displays file processing messages in VS Code.
   • Steps:
     1. Press Ctrl + Shift + P to open the Command Palette.
     2. Type Index a folder and press Enter.
     3. Wait for the indexing process to complete. Progress and file processing messages will be displayed.

3. Refresh the index:

   • Command: Refresh the index
   • Description: Refreshes the existing index to include recent modifications. Displays file processing messages in VS Code.
   • Steps:
     1. Press Ctrl + Shift + P to open the Command Palette.
     2. Type Refresh the index and press Enter.
     3. Wait for the refresh process to complete. Progress and file processing messages will be displayed.

4. Search for a word or phrase:

   • Command: Speedsearch
   • Description: Searches for words or phrases in indexed files and displays the results with occurrences of the searched words.
   • Steps:
     1. Press Ctrl + Shift + P to open the Command Palette.
     2. Type Speedsearch and press Enter.
     3. Enter the word or phrase to search for and press Enter.
     4. The search results will be displayed in the Search Results tree view, with file paths and occurrences of the searched words (if enabled in the configuration).

5. Display search results:

   • The search results are displayed in the Search Results tree view in the VS Code explorer.
   • Click on the Search Results view to expand and see the search results.

6. Open files from the tree view:

   • Click on the files in the Search Results tree view to open them directly in VS Code.
   • Click on the occurrences of the searched words to open the file at the selected line.

Installation

1. Clone the repository or download the source files.
2. Open the folder in VS Code.
3. Install the dependencies:

   npm install