SaveTest TMS Plugin для VS Code / for VS Code

Описание / Description

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

EN: 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

RU:

• Инициализация проекта — Автоматическое создание базовой структуры проекта
• Команды создания — Быстрое создание test suite и test case
• Сниппеты — Готовые шаблоны для всех структурных элементов
• Горячие клавиши — Ускоренная работа с часто используемыми командами
• Автогенерация UUID — Автоматическое создание уникальных идентификаторов

EN:

• 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

RU:

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

EN:

• JSON Schema validation — Validation of structure and data types in YAML files
• Autocompletion — Hints for fields and values
• Hover hints — Field descriptions on hover
• Diagnostics — Error display in Problems panel
• Quick Fix — Automatic fixing of common errors

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

RU:

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

EN:

• 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 support — Creating and applying common cases
• Parameterization — Adding parameters with different values
• Attachments — Attaching auxiliary files to test cases
• Spell checking — Built-in spell checking in input fields

Шаблоны / Templates

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

EN: Custom templates — Template configuration for any entities via .save-test config file

Система знаний / Knowledge System

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

EN: Native support — Automatically created on project initialization. Classic markup — Markdown markup for articles

Начало работы / Getting Started

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

RU:

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

EN:

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

Структура / Structure:

tests/
├── attach/               # RU: Папка для вложений / EN: Folder for attachments
├── test-case/            # RU: Файлы тестовых наборов / EN: Test suite files
|   └── test-suite.yaml
└── common-case/          # RU: Общие кейсы / EN: Common cases
    └── common-case.yaml

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

.save-test                # RU: Конфигурация проекта / EN: Project configuration

Создание Test Suite / Creating Test Suite

RU:

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

EN:

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

Работа с тест-кейсами / Working with Test Cases

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

1. Откройте файл test-suite.yaml
2. Нажмите на иконку редактора (сплит с лупой) в правом верхнем углу

RU — Через YAML редактор:

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

EN — Via Visual Editor:

1. Open test-suite.yaml file
2. Click the editor icon (split with magnifier) in the top right corner

EN — Via YAML Editor:

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

Команды / Commands

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

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

EN: SaveTest: Initialize project | Create Test Suite | Validate | Refresh tree | Open visual editor

Контекстное меню директории / Directory Context Menu

RU/EN: SaveTest: Создать Test Suite / SaveTest: Create Test Suite

Контекстное меню редактора (YAML) / Editor Context Menu (YAML)

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

EN: Generate UUID | Insert test case (short/full) | Insert step | Precondition | Postcondition | Iteration | Common case | Attachment

Полный список / Full list: FEATURES → Commands

Структура Test Suite / Test Suite Structure

suite_id: "uuid"                          # RU: Обязательно / EN: Required
suite_name: "Название"                    # RU: Обязательно / EN: Required
description: "Описание"                   # RU: Опционально / EN: Optional
status: "new|in progress|done|archived"   # RU: Опционально / EN: Optional
created_at: "2024-01-01T00:00:00Z"        # ISO 8601
created_by: "автор"                       # RU: Опционально / EN: Optional
test_cases:                               # RU: Обязательно / EN: Required
  - 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 / Developed by SaveLink team
По вопросам и предложениям / Questions and suggestions: info@save-link.ru