Skip to content

A Visual Studio Code extension for enhancing the development and testing of Maestro YAML files, providing IntelliSense, syntax highlighting, formatting, test execution, and output visualization.

License

Notifications You must be signed in to change notification settings

Mastersam07/maestro-workbench

Repository files navigation

Maestro logo

Maestro Workbench

Version Downloads


Maestro Workbench is a Visual Studio Code extension designed to enhance the development and testing of Maestro YAML files. It offers features such as IntelliSense, syntax highlighting, formatting, test execution, and output visualization to streamline your workflow.

Features

  • IntelliSense and Syntax Highlighting: Provides code completions and highlights syntax for Maestro YAML files, reducing errors and improving readability. For a table of supported commands, see here.

  • Schema Validation: Ensure the correctness of your Maestro YAML files with integrated schema validation, highlighting errors and enforcing best practices.

    syntax.mp4
  • Test Execution with Feedback: Run your Maestro tests directly from the test explorer, receive real-time feedback on their status—running, passed, or failed and view outputs.

    tests1.mp4
    test2.mp4
  • Snippets: Utilize predefined code snippets to quickly scaffold Maestro commands and flows, enhancing productivity.

    snippets.1.mp4
  • Customizable File Patterns: Configure the extension to detect Maestro YAML files based on your project's structure by setting custom file patterns.

    filePatterns.1.mp4
  • Integrated Tree View: Visualize and manage your Maestro test files within a dedicated tree view, providing quick access and organization as well as viewing flow dependencies.

    dependencies.mp4
  • Maestro Studio Integration: Launch Maestro Studio directly from the extension.

Requirements

Ensure that you have Maestro installed on your system to utilize the testing features of this extension. You can download and install Maestro from the official repository.

Extension Settings

Maestro Workbench allows customization of file patterns to detect Maestro YAML files in your workspace. You can configure this in your workspace or user settings.

Default File Patterns:

"maestroWorkbench.filePatterns": [
    "maestro/**/*.yaml",
    "maestro/**/*.yml",
    "**/.maestro/**/*.yaml",
    "**/.maestro/**/*.yml"
]

To modify these patterns, navigate to your VS Code settings and update the maestroWorkbench.filePatterns configuration.

Contributing

Contributions are welcome! Please fork the repository and submit pull requests for any enhancements or bug fixes. For detailed guidelines, refer to our CONTRIBUTING.md.

Star Our Repository

If you find Maestro Workbench useful, please consider starring our repository on GitHub! Your support helps us continue to improve the extension.

GitHub stars

License

This extension is licensed under the MIT License.


For detailed documentation and contribution guidelines, please visit the GitHub repository.

About

A Visual Studio Code extension for enhancing the development and testing of Maestro YAML files, providing IntelliSense, syntax highlighting, formatting, test execution, and output visualization.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published