Автор:
    Создание:2024-08-11Последнее обновление:2026-06-17

    Проверка документа

    Команда doc review анализирует файлы документации на качество, согласованность и полноту для разных локалей.

    Ключевые моменты:

    • Разделяет большие markdown-файлы на части, чтобы оставаться в пределах окна контекста модели ИИ.
    • Оптимизирует части для проверки и пропускает части, которые уже переведены и не изменены.
    • Обрабатывает файлы, части и локали параллельно с использованием системы очередей для увеличения скорости.
    bash
    npx intlayer doc review

    Её можно использовать для проверки уже переведённых файлов и для проверки корректности перевода.

    В большинстве случаев,

    • предпочтительно использовать doc translate, когда переведённая версия этого файла недоступна.
    • предпочтительно использовать doc review, когда переведённая версия этого файла уже существует.
    Обратите внимание, что процесс проверки потребляет больше входных токенов, чем процесс перевода, для полной проверки одного и того же файла. Однако процесс проверки оптимизирует количество проверяемых частей и пропускает те, которые не изменились.

    Аргументы:

    Опции списка файлов:

    • --doc-pattern [docPattern...]: Глобальные шаблоны для выбора файлов документации, которые нужно проверить.

      Пример: npx intlayer doc review --doc-pattern "docs/**/*.md" "src/**/*.mdx"
    • --excluded-glob-pattern [excludedGlobPattern...]: Глобальные шаблоны для исключения файлов из проверки.

      Пример: npx intlayer doc review --excluded-glob-pattern "docs/internal/**"
    • --skip-if-modified-before [skipIfModifiedBefore]: Пропустить файл, если он был изменён до указанного времени.

      • Может быть абсолютным временем, например "2025-12-05" (строка или Date)
      • Может быть относительным временем в миллисекундах 1 * 60 * 60 * 1000 (1 час)
      • Эта опция проверяет время обновления файла с помощью метода fs.stat. Поэтому она может быть затронута Git или другими инструментами, которые изменяют файл.
      Пример: npx intlayer doc review --skip-if-modified-before "2025-12-05"
    • --skip-if-modified-after [skipIfModifiedAfter]: Пропустить файл, если он был изменён в течение указанного времени.

      • Может быть абсолютным временем, например "2025-12-05" (строка или Date)
      • Может быть относительным временем в миллисекундах 1 * 60 * 60 * 1000 (1 час)
      • Эта опция проверяет время обновления файла с помощью метода fs.stat. Поэтому она может быть затронута Git или другими инструментами, которые изменяют файл.
      Пример: npx intlayer doc review --skip-if-modified-after "2025-12-05"
    • --skip-if-exists: Пропустить файл, если он уже существует.

      Пример: npx intlayer doc review --skip-if-exists

    Опции режима проверки:

    • --log: Режим только логирования. Не переводить с помощью ИИ; вместо этого логировать блоки, требующие внимания (с номерами строк и содержимым) для базовой и целевой локалей, чтобы помочь другому агенту сгенерировать переводы.

      Пример: npx intlayer doc review --log

    Опции вывода записей:

    • --locales [locales...]: Целевые локали для проверки документации.

      Пример: npx intlayer doc review --locales fr es de
    • --base-locale [baseLocale]: Исходная локаль (базовый документ) для сравнения.

      Пример: npx intlayer doc review --base-locale en

    Опции обработки файлов:

    • --nb-simultaneous-file-processed [nbSimultaneousFileProcessed]: Количество файлов, обрабатываемых одновременно для проверки.

      Пример: npx intlayer doc review --nb-simultaneous-file-processed 5

    Опции ИИ:

    • --model [model]: Модель ИИ, используемая для проверки (например, gpt-3.5-turbo).
    • --provider [provider]: Провайдер ИИ, используемый для проверки.
    • --temperature [temperature]: Параметр температуры для модели ИИ.
    • --api-key [apiKey]: Предоставьте свой собственный API-ключ для сервиса ИИ.
    • --application-context [applicationContext]: Предоставьте дополнительный контекст для проверки ИИ.
    • --data-serialization [dataSerialization]: Формат сериализации данных для использования в функциях ИИ Intlayer. Опции: json (стандартный, надежный), toon (меньше токенов, менее стабильный).
    • --custom-prompt [prompt]: Настройка базового запроса, используемого для проверки. (Примечание: для большинства случаев рекомендуется использовать опцию --custom-instructions, так как она обеспечивает лучший контроль.)

      Пример: npx intlayer doc review --model deepseek-chat --provider deepseek --temperature 0.5 --api-key sk-1234567890 --application-context "Мое приложение, магазин для кошек"

    Опции переменных окружения:

    • --env: Указать окружение (например, development, production).
    • --env-file [envFile]: Указать пользовательский файл окружения для загрузки переменных.
    • --base-dir: Указать базовую директорию проекта.
    • --no-cache: Отключить кэш.

      Пример: npx intlayer doc review --base-dir ./docs --env-file .env.production.local

    Опции логирования:

    • --verbose: Включить подробное логирование для отладки. (по умолчанию включено при использовании CLI)

      Пример: npx intlayer doc review --verbose

    Опции пользовательских инструкций:

    • --custom-instructions [customInstructions]: Пользовательские инструкции, добавляемые в запрос. Полезно для применения специфических правил касательно форматирования, перевода URL и т.д.

      Пример: npx intlayer doc review --custom-instructions "Избегайте перевода URL и сохраняйте формат markdown"
      Пример: npx intlayer doc review --custom-instructions "$(cat ./instructions.md)"

    Опции Git:

    • --git-diff: Запускать только для файлов, которые содержат изменения от базовой ветки (по умолчанию origin/main) до текущей ветки (по умолчанию: HEAD).
    • --git-diff-base: Указать базовую ссылку для git diff (по умолчанию origin/main).
    • --git-diff-current: Указать текущую ссылку для git diff (по умолчанию HEAD).
    • --uncommitted: Включать незафиксированные изменения.
    • --unpushed: Включать изменения, не отправленные в удалённый репозиторий.
    • --untracked: Включать неотслеживаемые файлы.

      Пример: npx intlayer doc review --git-diff --git-diff-base origin/main --git-diff-current HEAD
      Пример: npx intlayer doc review --uncommitted --unpushed --untracked

    Обратите внимание, что путь к выходному файлу будет определяться путем замены следующих шаблонов:

    • /{{baseLocale}}/ на /{{locale}}/ (Unix)
    • {{baseLocale}}` на {{locale}}` (Windows)
    • _{{baseLocale}}. на _{{locale}}.
    • {{baseLocale}}_ на {{locale}}_
    • .{{baseLocaleName}}. на .{{localeName}}.

    Если шаблон не найден, к расширению файла будет добавлено .{{locale}}. Например, ./my/file.md будет проверен и обновлен в ./my/file.fr.md для французской локали.