🚀 RocketQA VS Code Extension

Write web E2E tests using natural language

Perfect for:

• 👨‍💼 Manual QA Engineers who want to automate E2E tests
• 🔧 Automation Engineers who want to simplify their job
• 👨‍💻 Developers who want to save time on retesting functionality

This VS Code extension provides intelligent support for RocketQA CLI - a zero-configuration tool that lets you write and run Gherkin tests in any project without setup or dependencies.

✨ Key Benefits

• 🎯 Write tests in natural language - No programming knowledge required
• ⚡ Smart autocompletion - Type $ for page elements, get instant suggestions
• 🔍 Real-time validation - Catch errors as you type
• 🧭 Go-to-definition - Click to jump between scenarios and page elements
• 📝 Syntax highlighting - Beautiful, readable .feature files

🚀 Quick Start

1. Write Your First Test

Feature: Blog
  Scenario: Open Blog Page
    When run scenario {Open Website}
    And click $navbar.blog
    Then $blogPage.firstBlogPostCard is visible

2. Create Page Locators

# locators.yml
navbar:
  blog: "(//a[@href='/blog'])[1]"

blogPage:
  firstBlogPostCard: "(//*[contains(@class,'blog-post-card')])[1]"

3. Run Your Tests

npx rocketqa test

🎯 How It Works

• Type $ → Get page element suggestions from your locators.yml
• Type { → Reference other scenarios for reusable test steps
• Use natural language → click, navigate to, is visible, etc.
• Get instant feedback → Real-time validation and error highlighting

📦 Installation

1. Open VS Code → Extensions (Ctrl+Shift+X)
2. Search for "RocketQA" → Click Install
3. Create a locators.yml file in your project root
4. Start writing .feature files!

💡 Pro Tips

• Ctrl+Click on {scenario names} to jump to their definitions
• Type $ to get smart suggestions for page elements
• Use descriptive scenario names for better reusability
• Organize locators by page/component in locators.yml

🏗️ Project Structure

my-project/
├── features/
│   ├── blog.feature              # Your test scenarios
│   └── shared.feature            # Reusable scenarios
├── locators.yml                  # Page element definitions
└── (No setup needed! Just run: npx rocketqa test)

🔧 Advanced Features

Scenario Reuse

# shared.feature
Scenario: Login as Admin
  When navigate to "/login"
  And fill "admin" into $loginPage.username
  Then click $loginPage.submitButton

# blog.feature  
Scenario: Create Blog Post
  When run scenario {Login as Admin}  # ← Reuse scenarios!
  And click $navbar.blog

Smart Locators

# locators.yml - Organize by page
loginPage:
  username: "#username-input"
  submitButton: "button[type='submit']"

navbar:
  blog: "a[href='/blog']"

🔧 Troubleshooting

Completions not working?

• Check that locators.yml exists and has valid YAML syntax
• Restart VS Code if needed

Need help?

• Use Ctrl+Shift+P → "Show Gherkin Locators Logs" for debugging
• Check the RocketQA CLI docs for step patterns

📄 License

MIT License - see LICENSE.md

Made with ❤️ for QA Engineers, Developers, and Automation Engineers

Write E2E tests in natural language with RocketQA CLI