Формат отчета

Используйте этот формат, если хотите создать отчет changAIs вне приложения: из скрипта, CI-задачи или собственного AI-процесса разработки.

Отчет - это JSON-файл. Сохраните его в проекте, как .changais/report.json, затем откройте его в интерфейсе ревью changAIs.

Минимальный пример

{
  "version": "1.0",
  "generatedAt": "2026-06-08T12:00:00Z",
  "notes": [
    {
      "id": "note-auth-guard",
      "file": "src/auth/session.ts",
      "line": 42,
      "endLine": 48,
      "type": "warning",
      "title": "Check unauthenticated behavior",
      "content": "The new guard changes how expired sessions are handled. Confirm redirects and API responses still match the product flow.",
      "checked": false
    }
  ]
}

Поля верхнего уровня

Поле	Обязательно	Тип	Описание
`version`	Да	string	Версия формата отчета. Для текущего формата используйте `1.0`.
`generatedAt`	Рекомендуется	string	ISO 8601 timestamp времени создания отчета.
`notes`	Да	array	Заметки ревью, прикрепленные к файлам или строкам.

Поля заметки

Поле	Обязательно	Тип	Описание
`id`	Да	string	Стабильный уникальный ID заметки внутри отчета.
`file`	Да	string	Путь к файлу относительно проекта, с разделителями `/`.
`line`	Да	number	Номер строки, где начинается заметка. Нумерация с 1.
`endLine`	Нет	number	Номер строки, где заметка заканчивается. Нумерация с 1. Не указывайте для заметки на одну строку.
`type`	Рекомендуется	string	Тип заметки. Используйте `info`, `warning` или `suggestion`.
`title`	Рекомендуется	string	Короткий заголовок заметки.
`content`	Да	string	Текст рекомендации для ревью.
`checked`	Нет	boolean	Была ли заметка уже проверена. Если поле не указано, считается `false`.

JSON Schema

Используйте эту схему, чтобы проверять сгенерированные отчеты перед загрузкой в changAIs.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "changAIs Report",
  "type": "object",
  "required": ["version", "notes"],
  "additionalProperties": true,
  "properties": {
    "version": {
      "type": "string",
      "const": "1.0"
    },
    "generatedAt": {
      "type": "string",
      "format": "date-time"
    },
    "notes": {
      "type": "array",
      "items": {
        "type": "object",
        "required": ["id", "file", "line", "content"],
        "additionalProperties": true,
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "file": {
            "type": "string",
            "minLength": 1
          },
          "line": {
            "type": "integer",
            "minimum": 1
          },
          "endLine": {
            "type": "integer",
            "minimum": 1
          },
          "type": {
            "type": "string",
            "enum": ["info", "warning", "suggestion"]
          },
          "title": {
            "type": "string"
          },
          "content": {
            "type": "string",
            "minLength": 1
          },
          "checked": {
            "type": "boolean"
          }
        }
      }
    }
  }
}

Правила генерации

Используйте пути относительно корня workspace, открытого в VS Code.
Используйте номера строк начиная с 1 из текущего содержимого файла, который нужно проверить.
Сохраняйте стабильные значения id при повторной генерации того же отчета, чтобы состояние ревью можно было сопоставить.
Привязывайте заметки к измененным или важным для ревью строкам.

Если отчет загрузился, но заметки появились не там, где ожидалось, проверьте, что пути файлов и номера строк соответствуют текущему состоянию кода.