Alias AI

Alias AI is a Visual Studio Code extension powered by AI that helps you rename variables, functions, and classes to cleaner, more professional names. It analyzes your code, provides multiple context-aware suggestions, and ensures your code is easier to understand and maintain.

🔗 Visit the official website for more details: Alias AI Website

Features

• 🧠 AI-Powered Suggestions: Get better, context-aware names for variables, functions, and classes.
• 📊 Inline Suggestions: View multiple naming suggestions for each entity in an intuitive dropdown.
• 🖱️ Highlight and Navigate: Click on variable names in the suggestions panel to locate and highlight them in your code.
• ✅ Apply Changes Effortlessly: Approve and apply the suggested names directly from the UI.
• 🔄 Real-Time Feedback: Automatically analyzes and updates suggestions as you work.
• 🔒 Secure API Key Storage: Use VS Code's secret storage to securely store your OpenAI API key.
• 🌐 Multi-Language Support: Works seamlessly with JavaScript, TypeScript, Python, Java, and C++ code.

Prerequisites

To use Alias AI, you will need an OpenAI API key. The API key enables the extension to communicate with OpenAI's servers and provide AI-powered suggestions.

How to Install

1. Open Visual Studio Code.
2. Go to the Extensions View by clicking the Extensions icon in the Activity Bar on the side of the window.
3. Search for Alias AI in the Extensions Marketplace.
4. Click Install to add the extension to your editor.
5. Reload VS Code if prompted.

How to Obtain an OpenAI API Key

1. Visit the OpenAI platform.
2. Sign in or create an OpenAI account.
3. Navigate to the API Keys section under your account settings.
4. Click Create New Key to generate an API key.
5. Copy the key to a secure location. You will use this key to set up Alias AI.

Setting Up Your OpenAI API Key

To use Alias AI, you'll need to configure your OpenAI API key in the extension. Follow these steps:

1. Press Ctrl+Shift+P (or Cmd+Shift+P on macOS) in VS Code to open the Command Palette.
2. Search for and select Alias AI: Set API Key.
3. Enter your OpenAI API key when prompted and press Enter.
4. You’ll see a confirmation message once the key is securely stored.

How to Use

1. Open a Code File

• Open a supported file (JavaScript, TypeScript, Python, Java, or C++) in Visual Studio Code.

2. Trigger the Command

• Press Ctrl+Shift+P (or Cmd+Shift+P on macOS) to open the Command Palette.
• Search for and select Alias AI: Rename Variables.

3. View AI Suggestions

• The extension analyzes your code and generates a Suggestions Panel listing all variables, functions, and classes with AI-suggested names.
• Each suggestion has a dropdown menu with multiple name options.

4. Highlight Variables in Your Code

• Click on a variable name in the panel to locate and highlight it in your code.

5. Approve Changes

• Select the desired name for each variable, function, or class from the dropdown.
• Check the box for the items you want to approve.
• Click the Confirm button to apply the changes directly to your code.

6. Cancel if Needed

• Click the Cancel button to discard changes and keep your code untouched.

Example Usage

Input Code:

const x = 42;
function doStuff() {
    console.log(x);
}
const obj = { a: 1, b: 2 };

Output Code (After Applying Suggestions):

const count = 42;
function logCount() {
    console.log(count);
}
const data = { a: 1, b: 2 };

Troubleshooting

• No API Key Found:
  Ensure you have set your OpenAI API key using the Alias AI: Set API Key command. If you haven't, press Ctrl+Shift+P (or Cmd+Shift+P on macOS), search for Alias AI: Set API Key, and enter your API key.

• Suggestions Not Appearing:
  Ensure your code is saved and contains variables, functions, or classes that Alias AI can analyze. If the problem persists, check the console logs in the Output panel for more details (select "Alias AI" in the dropdown).

• Error During API Communication:
  Double-check your OpenAI API key and ensure you have an active internet connection. If your API key has expired or is invalid, update it using the Alias AI: Set API Key command.

Feedback and Support

If you encounter any issues, have suggestions, or need help, feel free to reach out to us directly through the Visual Studio Code Marketplace page.

We’re here to help and continuously improve Alias AI! 🎉