Интеграция с IDE

Koda CLI может интегрироваться с вашей IDE, чтобы обеспечить более плавный и учитывающий контекст опыт. Эта интеграция позволяет CLI лучше понимать ваше рабочее пространство и включает мощные функции, такие как собственное сравнение в редакторе.

В настоящее время поддерживаются IDE Visual Studio Code и другие редакторы, поддерживающие расширения VS Code, а также семейство IDE JetBrains (IntelliJ IDEA, PyCharm, WebStorm, PhpStorm и др.).

Расширения для IDE можно скачать с сайта http://download.kodacode.ru

Возможности

• Контекст рабочего пространства: CLI автоматически получает информацию о вашем рабочем пространстве, чтобы обеспечить более релевантные и точные ответы. Этот контекст включает:

  • 10 наиболее недавно accessed файлов в вашем рабочем пространстве.
  • Позицию вашего активного курсора.
  • Любой выбранный вами текст (до лимита 16 КБ; более длинные выделения будут усечены).

• Собственное сравнение: Когда Koda предлагает изменения кода, вы можете просматривать изменения непосредственно в собственном средстве просмотра diff в вашей IDE. Это позволяет вам просматривать, редактировать и принимать или отклонять предложенные изменения без прерываний.

• Команды VS Code: Вы можете получить доступ к возможностям Koda CLI непосредственно из палитры команд VS Code (Cmd+Shift+P или Ctrl+Shift+P):

  • Koda CLI: Run: Запускает новый сеанс Koda CLI в интегрированном терминале.
  • Koda CLI: Accept Diff: Принимает изменения в активном редакторе diff.
  • Koda CLI: Close Diff Editor: Отклоняет изменения и закрывает активный редактор diff.
  • Koda CLI: View Third-Party Notices: Отображает уведомления о сторонних разработках для расширения.

Установка

Есть три способа настроить интеграцию с IDE:

Для установки вы можете ввести команду

 /ide install

чтобы посетить страницу с загрузкой компаньонов.

Использование

Включение и отключение

Вы можете управлять интеграцией с IDE изнутри CLI:

• Чтобы включить соединение с IDE, запустите:

  /ide enable

• Чтобы отключить соединение, запустите:

  /ide disable

Когда включено, Koda CLI автоматически попытается подключиться к сопутствующему расширению IDE.

Проверка статуса

Чтобы проверить статус соединения и увидеть контекст, полученный CLI от IDE, запустите:

/ide status

Если подключено, эта команда покажет IDE, к которой она подключена, и список недавно открытых файлов, о которых она знает.

(Примечание: Список файлов ограничен 10 недавно accessed файлами в вашем рабочем пространстве и включает только локальные файлы на диске.)

Работа с diff-файлами

Когда вы просите Koda изменить файл, он может открыть представление diff непосредственно в вашем редакторе.

Чтобы принять diff, вы можете выполнить любое из следующих действий:

• Нажмите иконку галочки в заголовке редактора diff.
• Сохраните файл (например, с помощью Cmd+S или Ctrl+S).
• Откройте палитру команд и запустите Koda CLI: Accept Diff.
• Ответьте yes в CLI, когда будет предложено.

Чтобы отклонить diff, вы можете:

• Нажмите иконку 'x' в заголовке редактора diff.
• Закройте вкладку редактора diff.
• Откройте палитру команд и запустите Koda CLI: Close Diff Editor.
• Ответьте no в CLI, когда будет предложено.

Вы также можете изменить предложенные изменения непосредственно в представлении diff перед их принятием.

Если вы выберете 'Да, разрешить всегда' в CLI, изменения больше не будут отображаться в IDE, так как они будут приниматься автоматически.

Устранение неполадок

Если вы сталкиваетесь с проблемами интеграции с IDE, вот несколько общих сообщений об ошибках и способы их устранения.

Ошибки соединения

• Сообщение: 🔴 Отключено: Не удалось подключиться к сопутствующему расширению IDE для [Имя IDE]. Пожалуйста, убедитесь, что расширение запущено, и попробуйте перезапустить терминал. Чтобы установить расширение, запустите /ide install.

  • Причина: Koda CLI не смог найти необходимые переменные окружения для подключения к IDE.
  • Решение:
    1. Убедитесь, что вы установили расширение Koda CLI Companion в вашей IDE и что оно включено.
    2. Для IDE JetBrains убедитесь, что расширение установлено правильно с сайта http://download.kodacode.ru
    3. Откройте новое окно терминала в вашей IDE, чтобы убедиться, что оно получает правильное окружение.

• Сообщение: 🔴 Отключено: Ошибка соединения с IDE. Соединение было потеряно неожиданно. Пожалуйста, попробуйте переподключиться, запустив /ide enable

  • Причина: Соединение с сопутствующим расширением IDE было потеряно.
  • Решение: Запустите /ide enable, чтобы попробовать переподключиться. Если проблема продолжается, откройте новое окно терминала или перезапустите вашу IDE.

Ошибки конфигурации

• Сообщение: 🔴 Отключено: Несоответствие каталогов. Koda CLI запущен в другом месте, чем открытое рабочее пространство в [Имя IDE]. Пожалуйста, запустите CLI из того же каталога, что и корневая папка вашего проекта.

  • Причина: Текущий рабочий каталог CLI находится за пределами папки или рабочего пространства, которое вы открыли в вашей IDE.
  • Решение: Выполните cd в тот же каталог, который открыт в вашей IDE, и перезапустите CLI.

• Сообщение: 🔴 Отключено: Чтобы использовать эту функцию, пожалуйста, откройте одну папку рабочего пространства в [Имя IDE] и попробуйте снова.

  • Причина: У вас открыто несколько папок рабочего пространства в вашей IDE или вообще не открыто ни одной папки. Интеграция с IDE требует одну корневую папку рабочего пространства для правильной работы.
  • Решение: Откройте одну папку проекта в вашей IDE и перезапустите CLI.

Общие ошибки

• Сообщение: Интеграция с IDE не поддерживается в вашей текущей среде. Чтобы использовать эту функцию, запустите Koda CLI в одной из этих поддерживаемых IDE: [Список IDE]
  • Причина: Вы запускаете Koda CLI в терминале или среде, которая не является поддерживаемой IDE.
  • Решение: Запустите Koda CLI из интегрированного терминала поддерживаемой IDE, например, VS Code.