diff --git a/package-lock.json b/package-lock.json index dc621efd..decd8214 100644 --- a/package-lock.json +++ b/package-lock.json @@ -4718,10 +4718,6 @@ "safe-buffer": "^5.0.1" } }, - "node_modules/editor-extensions-vscode": { - "resolved": "vscode", - "link": true - }, "node_modules/electron-to-chromium": { "version": "1.5.62", "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.62.tgz", @@ -7440,6 +7436,10 @@ "node": ">=0.10.0" } }, + "node_modules/konveyor-ai": { + "resolved": "vscode", + "link": true + }, "node_modules/leven": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/leven/-/leven-3.1.0.tgz", @@ -12118,8 +12118,9 @@ "version": "0.0.1" }, "vscode": { - "name": "editor-extensions-vscode", + "name": "konveyor-ai", "version": "0.0.4", + "license": "Apache-2.0", "dependencies": { "@types/jsesc": "^3.0.3", "diff": "^7.0.0", diff --git a/vscode/README.md b/vscode/README.md index 8410bb1c..e7ed29f8 100644 --- a/vscode/README.md +++ b/vscode/README.md @@ -1,63 +1,85 @@ -# konveyor-vscode +# Kai VS Code Extension (`kai-vscode`) -This extension allows the user to run Konveyor AI from VSCode. +The Konveyor AI (Kai) VSCode Extension is a powerful tool for application +modernization and migration analysis. It leverages cutting-edge AI to analyze +code, identify modernization opportunities, and assist in migrating applications +to newer platforms or architectures. -## Features +--- -TODO +## Features -## Requirements +- **Analysis View**: Provides an overview of identified issues and modernization opportunities. +- **Resolutions View**: Displays proposed resolutions and allows easy application or dismissal of changes. +- **Customizability**: Configure analysis settings, rulesets, and incident filters. +- **Integration with Generative AI**: Utilize advanced AI-powered insights with configurable backend support. +- **Seamless Navigation**: Command palette, menus, and activity bar integration for intuitive usage. -TODO +--- -## Extension Settings +## Installation -Include if your extension adds any VS Code settings through the `contributes.configuration` extension point. +1. Install [Visual Studio Code](https://code.visualstudio.com/). +2. Search for `kai-vscode` in the Extensions Marketplace or [download it directly from GitHub Releases](https://github.com/konveyor/editor-extensions/releases). +3. Follow the setup walkthrough to configure your environment. Alternatively, Command Palette, select "Welcome: Open Walkthrough", and select "Konveyor". -For example: +--- -This extension contributes the following settings: +## Getting Started -- `myExtension.enable`: Enable/disable this extension. -- `myExtension.thing`: Set to `blah` to do something. +### Configure Generative AI Key -## Known Issues +Set up your AI backend by providing a Generative AI Key: -TODO +1. Open the Command Palette (`Ctrl+Shift+P` or `Cmd+Shift+P`). +2. Run `Konveyor: Configure GenAI Key`. -## Release Notes +### Run an Analysis -TODO +1. Start the server: `Konveyor: Start Server` and `Konveyor: Run Analysis`. +2. Run an analysis on your code: `Konveyor: Run Analysis`. +3. Open the Analysis View to view issues: `Konveyor: Open Konveyor Analysis View`. -### 1.0.0 +### Get Solutions -Initial release of ... +1. Find an violation or incident you would like to use Generative AI to fix. +2. Run "Get Solution". +3. View the proposed changes and accept/reject/modify them. -### 1.0.1 +--- -Fixed issue #. +## Configuration Options -### 1.1.0 +Customize your setup through the VS Code settings: -Added features X, Y, and Z. +| Setting | Description | Default | +| --------------------------------- | -------------------------------------------- | ---------------- | +| `konveyor.analyzerPath` | Path to a custom analyzer binary. | Bundled Analyzer | +| `konveyor.logLevel` | Log level for the extension (`debug`, etc.). | `debug` | +| `konveyor.analysis.incidentLimit` | Max number of incidents reported. | `10000` | +| `konveyor.analysis.customRules` | Array of paths to custom rulesets. | `[]` | --- -## Following extension guidelines +## Commands + +Access these commands via the Command Palette (`Ctrl+Shift+P` or `Cmd+Shift+P`): -Ensure that you've read through the extensions guidelines and follow the best practices for creating your extension. +| Command | Description | +| ------------------------------- | ---------------------------------------- | +| `Konveyor: Configure GenAI Key` | Configure your Generative AI Key. | +| `Konveyor: Start Server` | Start the backend server. | +| `Konveyor: Run Analysis` | Analyze your codebase for modernization. | +| `Konveyor: Stop Server` | Stop the backend server. | -- [Extension Guidelines](https://code.visualstudio.com/api/references/extension-guidelines) +--- -## Working with Markdown +## Contributing -You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts: +We welcome contributions! Please file issues on [GitHub](https://github.com/konveyor/editor-extensions/issues) or open a pull request. -- Split the editor (`Cmd+\` on macOS or `Ctrl+\` on Windows and Linux). -- Toggle preview (`Shift+Cmd+V` on macOS or `Shift+Ctrl+V` on Windows and Linux). -- Press `Ctrl+Space` (Windows, Linux, macOS) to see a list of Markdown snippets. +--- -## For more information +## License -- [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown) -- [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/) +This extension is licensed under the [Apache License 2.0](LICENSE). diff --git a/vscode/package.json b/vscode/package.json index 5ec305cb..07e5c3fc 100644 --- a/vscode/package.json +++ b/vscode/package.json @@ -1,5 +1,10 @@ { - "name": "editor-extensions-vscode", + "name": "konveyor-ai", + "displayName": "Konveyor AI (kai) Extension for VSCode", + "description": "Generative AI assisted migration and modernization tool", + "author": "Konveyor", + "icon": "resources/konveyor-icon-color.png", + "license": "Apache-2.0", "version": "0.0.4", "main": "./out/extension.js", "publisher": "konveyor", @@ -8,6 +13,7 @@ "url": "https://github.com/konveyor/editor-extensions" }, "bugs": "https://github.com/konveyor/editor-extensions/issues", + "preview": false, "categories": [ "Programming Languages", "Machine Learning",