TechComms - SEO Tools Extension

This VS Code extension allows you to automatically generate meta descriptions for HTML and Markdown files. It supports both single file processing (for the currently active file in the editor) and batch processing (for all .md and .html files in a selected folder).

Features

1. Single File Meta Description:

   • Right-click on an open file (Markdown or HTML) in the editor and select "Generate Meta Description".
   • The extension will check if the file contains frontmatter with a title: field and if a description: is already present.
   • If no description is found, it generates a meta description using OpenAI's GPT-4 model and inserts it into the frontmatter.

2. Batch Meta Description:

   • Right-click on a folder in the Explorer and select "Generate Meta Description Batch".
   • The extension will process all .md and .html files within the folder and its subfolders.
   • It will only process files that contain frontmatter with a title: field and no existing description: field.
   • A progress indicator shows how many files have been processed.

3. Validation:

   • The extension validates that each file has frontmatter and contains a title:, and does not already have a description:.
   • Files that do not meet these criteria are skipped.

4. Progress Indicators:

   • During batch processing, a progress bar will show the percentage of files processed, indicating how many .md and .html files had descriptions inserted.

5. API Key Management:

   • The OpenAI API key is securely stored in VS Code's globalState and persists across sessions.
   • You can reset the API key using the "Add/Reset OpenAI API Key" command.

Prerequisites

To use this extension, you need the following:

• OpenAI API Key: You must have an OpenAI API key to generate meta descriptions.

Installation

1. Install the Extension:

   • Open Visual Studio Code.
   • Go to the Extensions view by clicking on the Extensions icon in the Activity Bar on the side of the window or by pressing Ctrl+Shift+X.
   • Search for "TechComms - SEO AI Tools" and install the extension.
   • Alternatively, you can install it directly from the Visual Studio Code Marketplace.

2. Set Up OpenAI API Key:

   • After installing the extension, open the Command Palette (Ctrl+Shift+P).
   • Search for and select "Add/Reset OpenAI API Key".
   • Enter your OpenAI API key when prompted. The key will be securely stored in VS Code's globalState.

Usage

Single File Processing

1. Open a .md or .html file in the editor.
2. Right-click on the file, and select "Generate Meta Description Single" from the context menu.
3. The extension will check if the file has valid frontmatter and does not already contain a description.
4. If no description is present, the extension will generate one using OpenAI's GPT-4 model and insert it into the frontmatter.

Batch File Processing

1. In the Explorer view, right-click on a folder that contains .md and .html files.
2. Select "Generate Meta Description Batch".
3. The extension will process all the .md and .html files in the folder (and subfolders) and insert descriptions into valid files.
4. The progress bar will update as files are processed.

Add/Reset OpenAI API Key

1. Open the Command Palette (Ctrl+Shift+P).
2. Search for and select "Add/Reset OpenAI API Key".
3. The extension will clear the stored API key and prompt you to enter a new one.

Progress Reporting

• During batch processing, the extension shows progress in a notification with the following format:

  2/10 markdown file(s) and 1/5 html file(s) description inserted
  

Notes

• Frontmatter Requirements: Files must contain valid frontmatter with a title: field and no existing description: field to be processed.
• Supported File Types: The extension works with .md (Markdown) and .html (HTML) files.