RSLib VSCode Extension Template

A minimal template for creating VSCode extensions using RSLib framework.

Features

• 🚀 Modern TypeScript setup
• ⚡️ RSLib for efficient development
• 📦 Built-in build and watch scripts
• 🧪 Jest testing configuration
• 🎨 Biome for code formatting

Prerequisites

• Node.js (v22 or higher)
• VSCode
• Yarn

Getting Started

1. Clone this template:

   git clone https://github.com/XavierLeTohic/rslib-vscode-extension.git
   cd rslib-vscode-extension

2. Install dependencies:

   yarn install

3. Start development:

   yarn dev

4. Press F5 in VSCode to launch the extension in debug mode

Available Commands

• npm run build: Build the extension
• npm run dev: Build and watch for changes
• npm run test: Run Jest tests
• npm run vscode:prepublish: Prepare extension for publishing

Project Structure

├── src/
│ └── extension.ts # Main extension code
├── images/
│ └── logo.png # Extension icon
├── dist/ # Compiled output
└── package.json # Extension manifest

Development

1. Modify src/extension.ts to add your extension logic

2. Update package.json contributes section to add:

   • Commands
   • Configuration
   • Views
   • Other VSCode extension points

3. Test your changes:

   • Write tests in __tests__ directory
   • Run npm run test to execute tests

Publishing

1. Update the following in package.json:

   • publisher
   • displayName
   • description
   • repository
   • version

2. Package and publish:

   vsce package
   vsce publish

License

MIT