CI&T Flow VSCode Extension

CI&T Flow is a Visual Studio Code extension designed to assist developers with code reviews and code fixes using AI. This extension leverages an external API to provide feedback and suggestions on selected code snippets.

Table of Contents

• Features
• Installation
• How to Get the Client ID, Client Secret, and Tenant
• Usage
• Keyboard Shortcuts
• Requirements
• License

Features

• Code Review: Get feedback on your code's quality, potential issues, and suggestions for improvement.
• Fix Code: Automatically identify and fix errors or issues in your code.
• Generate Unit Tests: Automatically generate unit tests for your code.
• Chat with Flow: Ask questions and get responses from Flow.
• Inline Completions: Generate inline code suggestions based on an instruction in the editor.
• Generate Commit Message: Generate commit message from staged file changes.

Installation

1. Install the extension from the VS Code Marketplace.
2. Configure Client Secret, Client ID, and Tenant in the extension settings.

How to Get the Client ID, Client Secret, and Tenant

1. Access the Flow platform
2. Log in with your credentials.
3. Click on your username at the bottom left of the screen.
4. Go to Settings.
5. Go to Your Profile > API Keys.
6. Enter a name for the API key, select the llm-api under apps and click Create.
7. Copy the Client ID, Client Secret and Tenant values.

Usage

1. Code Review:

   • Select the code you want to review.
   • Right-click and choose CI&T Flow > Code Review.
   • The response will be displayed in a new tab.

2. Fix Code:

   • Select the code you want to fix.
   • Right-click and choose CI&T Flow > Fix Code.
   • The response will be displayed in a new tab.

3. Generate Unit Tests:

   • Select the code you want to generate unit tests for.
   • Right-click and choose CI&T Flow > Generate Unit Tests.
   • The response will be displayed in a new tab.

4. Chat with Flow:

   • Click on the extension icon in the left sidebar.
   • A chat window will open where you can ask questions and get responses from Flow.

5. Inline Completions:

   • Write a comment expressing what you want.
   • Press the Trigger Inline Completion shortcut (default to Alt + \ or Option + \ on Mac) to generate a code suggestion.
   • Press tab to accept the ghost text completion.
   • Customize the shortcut: Access File > Preferences > Keyboard Shortcuts, search for "Trigger Inline Completion" and replace the default keybinding with your preferred one.

6. Generate Commit Message:

   • Go to the Source Control view.
   • Stage the file changes you want to commit.
   • Click on the Flow icon to generate the commit message.
   • You can define a prefix for the commit message in the presented dialog or leave it blank for no prefix.

Keyboard Shortcuts

• Alt + F Alt + U (Unit Tests)
• Alt + F Alt + R (Code Review)
• Alt + F Alt + X (Fix Code)
• Alt + F Alt + S (Generate User Stories)

Proxy Configuration

If you are behind a proxy, you can configure the extension to use it by setting the related settings in the VS Code settings.

Requirements

• Visual Studio Code version 1.95.0 or higher.

License

This project is licensed under the MIT License.

Enjoy coding with the official Flow extension for VS Code!