Skip to content

Latest commit

 

History

History
176 lines (118 loc) · 8.44 KB

CONTRIBUTING.md

File metadata and controls

176 lines (118 loc) · 8.44 KB
Raw

Contributing to Cody for Visual Studio

Prerequisites

  1. Install chocolatey - Package Manager for Windows
    1. Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://community.chocolatey.org/install.ps1'))
  2. Install node.js, required for building and running Cody Agent
    1. choco install pnpm --version=8.6.7
  3. Install Visual Studio Pro with the required component:
    1. Visual Studio Extension
  4. Install git for Windows
    1. Configure it with git config core.autocrlf false to not change line endings
  5. Install .NET SDK
  6. Clone this repository: git clone [email protected]:sourcegraph/cody-vs.git

For Sourcegraph teammates:

Quick Start

To get started quickly, follow these steps:

Open the Cody Project

  1. In Visual Studio's Get started page, select Open a project or solution
  2. Open the Cody.sln solution file

Debugger

Visual Studio

NOTE: You must build the agent before debugging for the first time.

  1. Run dotnet cake inside the src directory to build the agent.
  2. In your Cody project, click Debug > Start Debugging (or press F5) to start the debugger
  3. In the new window created by the debugger, open an existing project or create a new project
  4. Now you can start setting breakpoints and debugging Cody!

Visual Studio with Agent running in VS Code locally

  1. Download and install VS Code on your machine
  2. Clone the main Cody repository: git clone [email protected]:sourcegraph/cody.git
  3. Makes sure the cody repository is in the same directory as the cody-vs repository
  4. cd into the cody repository and run pnpm install
  5. Open the cody repository in VS Code
  6. After you have set the breakpoints, open the debug panel from selecting View > Run
  7. In the drop down menu next to RUN AND DEBUG, select Launch Agent port 3113 to start the debugger for Agent
  8. To enable Visual Studio listening to the Agent running on Port 3113, set CODY_VS_DEV_PORT with setx CODY_VS_DEV_PORT 3113
  9. After the Agent is built and launched, start the debugger on the Visual Studio side following the steps above

Running VS Integration Tests + Playwright

  1. Open Cody.sln in the Visual Studio
  2. Select Visual Studio menu Test->Test Explorer
  3. Right-click on the Cody.VisualStudio.Tests, select Run

Runtime Requirements

This project uses different runtimes for various components:

Visual Studio Extension

  • Runtime: .NET Framework 4.7.2
  • Platform: Windows only
  • Note: This runtime is typically included with Windows and Visual Studio installations.

Agent

  • Runtime: Node.js
  • Usage: Used for build and run processes only
  • Note: Not required for Visual Studio functionality

Build Scripts

  • Runtime: .NET 8
  • Platform: Cross-platform
  • Usage: Exclusively used by Cake build automation system

Please ensure you have the appropriate runtimes installed for the components you intend to work with.

Cake Build Automation

We use Cake as our build automation system. The build script can be found in the build.cake file. Our building and publishing process includes the following steps:

  1. Downloading the agent repository
  2. Selecting the commit for building the agent
  3. Building the agent
  4. Copying agent files to the VS extension folder
  5. Downloading node binary files (x64 and arm64 versions)
  6. Copying node files to the VS extension folder
  7. Building the VS extension using MSBuild
  8. Publishing to the marketplace

Build Commands

Execute these commands from the directory containing the build.cake file:

Command Description
dotnet cake Download and build agent, download required node files, build extension
dotnet cake --target Build Same as above
dotnet cake --target Tests Run tests from Cody.VisualStudio.Tests
dotnet cake --target Publish Build extension and publish it to the marketplace

Access Token

Create an account and go to https://sourcegraph.com/user/settings/tokens to create a token.

During development, you can use your own Cody access token by setting an environment variable. This eliminates the need to register and create a new token for each session.

To set your access token:

setx SourcegraphCodyToken YOUR_TOKEN

To display your token:

echo $env:SourcegraphCodyToken

Note: After setting an environment variable, you may need to restart Visual Studio and any open command prompts for the changes to take effect.

The token from the environment variable always overrides the value from the user settings and is never saved in the user settings.

Debugging the Agent

To debug the agent:

  1. Start the agent with the debugger enabled: node --inspect --enable-source-maps ../cody-dist/agent/dist/index.js api jsonrpc-stdio
  2. Open Chrome and navigate to chrome://inspect/
  3. Click "Open dedicated DevTools for Node"
  4. Wait for DevTools to detect the new debugging session

Note: Starting to debug the extension in Visual Studio will automatically start the agent with appropriate arguments.

Additional debugging options:

Release Process

See the Releases page for details on how to release a new version of the Cody extension.

Troubleshoting

Files Stuck in the Git Working Tree

This repository is configured to use line endings for Windows machines. If you encounter issues with files stuck in the Git working tree, you can try one of the following solutions:

  1. Configure Git to handle line endings: Follow the instructions in the Configuring Git to handle line endings documentation to resolve the issue. This will help Git automatically handle line ending conversions based on your operating system.
  2. Remove cached files and reset the repository: You can remove all the cached files and reset the repository to the latest state of the main branch by running the following commands in your terminal:
git rm -rf --cached .
git reset --hard origin/main

This will remove all cached files and reset your local repository to match the remote main branch, effectively resolving any line ending-related issues.

Debug instance keeps using the previous version of the extension

The experimental instance in debug mode may keep using the previous version of the extension, which can be resolved by resetting the experimental instance following the instructions in The Experimental Instance docs.

Resources