English: If you don’t understand what’s written here, scroll down.

SaveTest TMS Plugin для VS Code

Описание

Расширение VS Code для работы с тест-кейсами в формате SaveTest TMS. Предоставляет удобное создание, редактирование и валидацию YAML‑файлов тест-кейсов с визуальным редактором.

Основные возможности

Создание и редактирование

Инициализация проекта — автоматическое создание базовой структуры проекта
Команды создания — быстрое создание Test Suite и Test Case
Сниппеты — готовые шаблоны для всех структурных элементов
Горячие клавиши — ускоренная работа с часто используемыми командами
Автогенерация UUID — автоматическое создание уникальных идентификаторов

Валидация и подсказки

Валидация JSON Schema — проверка структуры и типов данных в YAML‑файлах
Валидация дубликатов — проверка повторяющихся id сущностей
Автодополнение — подсказки для полей и значений
Hover‑подсказки — описания полей при наведении
Диагностика — отображение ошибок в панели Problems
Quick Fix — автоматическое исправление распространенных ошибок

Визуальный редактор

Три режима отображения — сплит, только дерево, только детали
Создание кейсов — создание кейсов с правильной структурой
Поиск и фильтрация — быстрый поиск по тест-кейсам
Drag & Drop — изменение порядка тест-кейсов
Общие кейсы (common-case) — создание и переиспользование общих кейсов
Параметризация — добавление параметров и итераций с различными значениями
Вложения — прикрепление вспомогательных файлов к тест-кейсу
Проверка орфографии — встроенная проверка орфографии в полях ввода

Шаблоны

Пользовательские шаблоны — настройка шаблонов для любых сущностей через файл конфигурации .save-test

Система знаний

Нативная поддержка — автоматическое создание при инициализации проекта
Классическая разметка — для статей используется Markdown‑разметка

Начало работы

Инициализация проекта

Откройте папку проекта в VS Code.
Откройте палитру команд (Ctrl+Shift+P / Cmd+Shift+P).
Выполните команду SaveTest: Инициализировать проект.

Структура проекта:

tests/
├── attach/               # Папка для вложений
├── test-case/            # Файлы тестовых наборов
│   └── test-suite.yaml
└── common-case/          # Общие кейсы
    └── common-case.yaml

docs/
└── wiki_example/
    └── example.md

.save-test                # Конфигурация проекта

Создание Test Suite

Щелкните правой кнопкой мыши на директории в проводнике.
Выберите команду SaveTest: Создать Test Suite.
Файл test-suite.yaml будет создан автоматически.

Работа с тест-кейсами

Через визуальный редактор:

Откройте файл test-suite.yaml.
Нажмите на иконку визуального редактора в правом верхнем углу редактора.

Через YAML‑редактор:

Используйте сниппеты (начните вводить test-case и нажмите Tab).
Используйте горячие клавиши: Ctrl+Shift+T / Ctrl+Shift+Alt+T / Ctrl+Shift+S.

Команды

Команды будут отображаться на русском при условии, что в IDE установлен русский язык.

Палитра команд (Ctrl+Shift+P / Cmd+Shift+P)

Основные команды:

SaveTest: Инициализировать проект
SaveTest: Создать Test Suite
SaveTest: Валидировать
SaveTest: Обновить дерево
SaveTest: Открыть визуальный редактор
SaveTest: Импортировать из test-it

Контекстное меню директории

SaveTest: Создать Test Suite
SaveTest: Создать Common Case

Контекстное меню редактора (YAML)

SaveTest: Генерировать UUID
SaveTest: Вставить тест-кейс (короткий)
SaveTest: Вставить тест-кейс (полный)
SaveTest: Вставить шаг
SaveTest: Вставить предусловие
SaveTest: Вставить постусловие
SaveTest: Вставить итерацию
SaveTest: Вставить общий кейс
SaveTest: Вставить вложение

Полный список команд см. в разделе Commands в package.json или в UI VS Code.

Структура Test Suite

suite_id: "uuid"                    # Обязательно
suite_name: "Название"              # Обязательно
description: "Описание"             # Опционально
status: "new|in progress|done|archived"
created_at: "2024-01-01T00:00:00Z"  # Формат ISO 8601
created_by: "автор"                 # Опционально
test_cases:                         # Обязательно
  - case_id: "uuid"
    title: "Название"
    description: "Описание"
    estimatedTime: "2m"
    priority: "high|medium|low"
    tags: ["тег1", "тег2"]
    environment:
      - name: "Браузер"
        value: "Chrome"
    pre-conditions:
      - action: "Действие"
        expected_result: "Результат"
    steps:
      - action: "Действие"
        expected_result: "Результат"
    post-conditions:
      - action: "Действие"
        expected_result: "Результат"

Разработано командой SaveLink.
По вопросам и предложениям: info@save-link.ru

SaveTest TMS Plugin for VS Code

Description

VS Code extension for working with test cases in SaveTest TMS format. Provides convenient creation, editing and validation of YAML test case files with a visual editor.

Key Features

Creation and Editing

Project initialization — automatic creation of basic project structure
Creation commands — quick creation of Test Suite and Test Case
Snippets — ready-made templates for all structural elements
Hotkeys — faster work with frequently used commands
UUID auto-generation — automatic creation of unique identifiers

Validation and Hints

JSON Schema validation — validation of structure and data types in YAML files
Duplicate validation — checking for duplicate entity IDs
Autocompletion — hints for fields and values
Hover hints — field descriptions on hover
Diagnostics — error display in the Problems panel
Quick Fix — automatic fixing of common errors

Visual Editor

Three display modes — split, tree only, details only
Case creation — creating cases with correct structure
Search and filtering — quick search through test cases
Drag & Drop — reordering test cases
Common cases — creating and reusing common cases
Parameterization — adding parameters and iterations with different values
Attachments — attaching auxiliary files to test cases
Spell checking — built-in spell checking in input fields

Templates

Custom templates — template configuration for any entities via .save-test config file

Knowledge System

Native support — automatically created on project initialization
Classic markup — Markdown markup for knowledge articles

Getting Started

Project Initialization

Open the project folder in VS Code.
Open Command Palette (Ctrl+Shift+P / Cmd+Shift+P).
Run the command SaveTest: Initialize project.

Project structure:

tests/
├── attach/               # Folder for attachments
├── test-case/            # Test suite files
│   └── test-suite.yaml
└── common-case/          # Common cases
    └── common-case.yaml

docs/
└── wiki_example/
    └── example.md

.save-test                # Project configuration

Creating a Test Suite

Right‑click on a directory in the explorer.
Select SaveTest: Create Test Suite.
The test-suite.yaml file will be created automatically.

Working with Test Cases

Via Visual Editor:

Open the test-suite.yaml file.
Click the visual editor icon in the top right corner of the editor.

Via YAML Editor:

Use snippets (start typing test-case and press Tab).
Use hotkeys: Ctrl+Shift+T / Ctrl+Shift+Alt+T / Ctrl+Shift+S.

Commands

Command Palette (Ctrl+Shift+P / Cmd+Shift+P)

Main commands:

SaveTest: Initialize project
SaveTest: Create Test Suite
SaveTest: Validate
SaveTest: Refresh tree
SaveTest: Open visual editor
SaveTest: Import from test-it

SaveTest: Create Test Suite
SaveTest: Create Common Case

SaveTest: Generate UUID
SaveTest: Insert test case (short)
SaveTest: Insert test case (full)
SaveTest: Insert step
SaveTest: Insert precondition
SaveTest: Insert postcondition
SaveTest: Insert iteration
SaveTest: Insert common case
SaveTest: Insert attachment

See the full list of commands in the Commands section of package.json or in the VS Code UI.

Test Suite Structure

suite_id: "uuid"                    # Required
suite_name: "Name"                  # Required
description: "Description"          # Optional
status: "new|in progress|done|archived"
created_at: "2024-01-01T00:00:00Z"  # ISO 8601
created_by: "author"                # Optional
test_cases:                         # Required
  - case_id: "uuid"
    title: "Title"
    description: "Description"
    estimatedTime: "2m"
    priority: "high|medium|low"
    tags: ["tag1", "tag2"]
    environment:
      - name: "Browser"
        value: "Chrome"
    pre-conditions:
      - action: "Action"
        expected_result: "Result"
    steps:
      - action: "Action"
        expected_result: "Result"
    post-conditions:
      - action: "Action"
        expected_result: "Result"

Developed by the SaveLink team.
Questions and suggestions: info@save-link.ru

SaveTest TMS Plugin

SaveLink