Топ-3 причины, почему вы должны использовать Copilot
В отличие от традиционных инструментов завершения кода, которые полагаются на предопределённые шаблоны и ключевые слова, GitHub Copilot идёт на шаг дальше, понимая цель кода и генерируя контекстуально подходящие предложения. Он основан на обширном репозитории фрагментов кода, библиотек и шаблонов программирования, доступных на GitHub, что делает его ценным ресурсом для разработчиков в различных областях и языках программирования.
Всем привет! Меня зовут Анатолий Барцев, я frontend-разработчик в команде Модерации Циан. Copilot достаточно давно известен, но большинство коллег из моего окружения не работали с ним. На это было некоторые причины: утечка памяти, просто недоверие к AI, а также платная версия. Я решил протестировать Copilot, чтобы оценить, полезен ли он для реальной разработки. После тестирования AI для себя я выделил 3 плюса от использования Copilot:
Улучшение качества кода. Copilot предлагает рекомендации и варианты кода на основе переданного контекста, что помогает предотвратить ошибки и соблюдать практики программирования.
Увеличение продуктивности. С Copilot разработчики могут сосредоточиться на более творческих и стратегических задачах, вместо того чтобы тратить время на рутинную работу.
Обучение и рост. Использование Copilot также может стать отличным инструментом для обучения новичков в области программирования. Путём изучения рекомендаций и генерируемого кода они могут улучшить свои навыки и расширить свой опыт.
Давайте посмотрим, как GitHub Copilot помогает в разработке на примере проекта на React/Typescript.
GitHub Copilot в проекте на React/Typescript
Я использую редактор кода VS Code, в нём и буду показывать рабочие примеры.
После установки расширения GitHub Copilot и подключения аккаунта, на панели в VS отображается иконка, сообщающая, что Copilot подключён и готов к работе. При клике на иконку можно воспользоваться настройками при необходимости.
Иконка Copilot в VS Code.
Создадим мини-проект — форма обратной связи, и на нём протестируем работу AI.
Для начала пойдём от простого — создадим компонент инпут с типом текст. Для этого в файле в виде комментария опишем требования, далее клавишу enter. Copilot начинает предлагать вариант кода на каждой строке, анализируя контекст написанного кода, включая имена переменных, сигнатуры функций и окружающий код, чтобы генерировать точные и актуальные предложения, адаптированные к потребностям разработчика.
Важно не забывать:
Разработчику необходимо понимать, что делает этот код, чтобы проверить его корректность и убедиться, что он соответствует требованиям проекта.
Разработчик должен быть в курсе того, что делает сгенерированный код, чтобы избежать потенциальных уязвимостей или проблем безопасности.
Если код нам подходит — нажимаем tab и т. д.
Создаем компонент input.
Также есть возможность написать код, используя Copilot Chat. В поле ввода описываем, что нам необходимо, после этого код будет полностью сгенерирован AI. При одинаковом описании Copilot предлагает примерно один и тот же код.
Создаем компонент input.
В целом AI легко справляется с простыми компонентами. Немного усложним, создав InputContainer с обработчиком ввода для нашего компонента и проверкой значения на email. Комментарии желательно добавлять перед каждым описанием функции, иначе код будет предлагаться очень рандомный и, скорее всего, от такого вы устанете. Если посмотреть на код ниже, то плюс в быстром написании regex и условий его использования. Код в целом рабочий, но всегда есть «НО» и правила написание кода в вашей команде. Такие комментарии в общем коде, конечно, выглядят некрасиво — их нужно подчистить. Размещение констант в компоненте к тому же лучше вынести в отдельный файл.
// write input container with handler
import React from "react";
import { Input } from "../../components/Input";
export const InputContainer: React.FC = () => {
const [value, setValue] = React.useState("");
const [errorInput, setErrorInput] = React.useState("");
// write a handler that checks the value as email
const handleEmail = (value: string) => {
// write a regex that checks the value as email
const emailRegex = /^[^\s@]+@[^\s@]+\.[^\s@]+$/;
const isEmail = emailRegex.test(value);
// if the value is'nt an email, set the error message
if (!isEmail) {
setErrorInput("This is not an email");
} else {
setErrorInput("");
}
setValue(value);
};
return ;
};На данном этапе мы получаем такой результат: если email некорректные — отображаем ошибку.
Ошибка не корректного email.
Теперь давайте ещё усложним и попросим AI подключить react-query в наш проект. Начнём с корня проекта.
Добавляем react-query.
доПроблем не возникло, Copilot Chat добавлял свой код, изменив наш. Есть погрешности в виде лишней скобки, этого можно избежать, для этого нужно:
Вызывать Copilot Chat в начале файла.
Можно в запросе указывать, что компонент необходимо переписать.
Или прописывать запрос на каждой строке, где необходимо добавить код.
Как же без UI Kit. Давайте воспользуемся библиотекой ant-design и добавим её в проект. Напишем запрос на кириллице. Смотрим, что получилось.
Добавляем ant-design.
Сделаем нашу форму мультиязычной и добавим библиотеку i18next. Проинициализируем её, остаётся только добавить нужный текст.
Добавляем i18next.
Для всего этого нам понадобилось 30 минут. При этом не нужно в голове держать всю инициализацию и добавление библиотек. Если вы не работали с этими библиотеками ранее, конечно, необходимо посмотреть документацию и убедиться, что AI предлагает верный код.
Далее в нашем компоненте формы добавим запрос отправки данных на сервер и кнопку отправить из ant-design, повесим отправку данных на событие onSubmit.
Добавляем событие onSubmit.
Вот в таких моментах нужно расписывать запрос к Copilot частями:
Просим добавить кнопку.
Повесить событие на onSubmit, получить данные из формы и отправить, используя react-query.
Тогда получаем код, который нас устраивает.
export const FormContainer = () => {
const { t } = useTranslation();
// Send form data using react-query mutation
const { mutate } = useMutation(
(data: Record) => {
console.log(data);
return Promise.resolve({ status: "success" });
},
{
onSuccess: (data) => {
console.log(data);
},
}
);
const handleSubmit = async (event: React.FormEvent) => {
event.preventDefault();
// Get form data
const formData = new FormData(event.target as HTMLFormElement);
const data = Object.fromEntries(formData.entries());
mutate(data as Record);
};
return (
{t("formTitle")}
);
};
Последнее, что мы сделаем, это в компоненте — изменим нативную форму на форму из antd. В компоненте есть логика, и, как мы видим, Copilot инициализирует наш компонент и предлагает новый вариант с данными из нашей формы.
Переписываем компонент используя antd
В целом использование Copilot — это как сниппеты, только не одной командой, а небольшими запросами. Время на написание такого кода сильно сокращается, но повторюсь, внимание от разработчика необходимо.
Покрываем тестами, используя Copilot Chat
Теперь давайте покроем unit-тестами наши компоненты. Для этого удобно пользоваться Copilot Chat: копируем наш компонент, вызываем чат, вводим /tests и вставляем скопированный компонент. AI покрыла компонент тремя тест-кейсами.
Наш компонент рендерится с переданным значением.
Обработчик события вызывается при изменении значения в поле.
Если передается ошибка — отображаем её.
Покрытие тестами input.tsx
Такого теста вполне достаточно для глупого компонента без логики. Теперь посмотрим на тестирование нашего контейнера: тут AI предлагает кейс, в котором происходит обработка условия ошибки email.
import { render, fireEvent } from "@testing-library/react";
import { InputContainer } from "../InputContainer";
describe("InputContainer", () => {
it("should render input and show error message", () => {
const { getByTestId, getByText } = render(Есть момент, что комментарий к тесту генерируется на английском. Но это ведь обучаемое AI, нужно протестировать. Сделаем следующее: сначала изменим описание в тесте Input кириллицей и сгенерируем тесты для компонента textarea, также напишем комментарий на кириллице.
Покрытие тестами textarea.tsx
Но нет, чуда не произошло. Если у вас в команде необходимо описание на кириллице, или вы пишите функциональные тесты для Allure, тогда нужно явно прописывать в запросе к AI, что описание должно быть на русском языке.
Если заметили, в тесте есть подсвечивание ошибки. Copilot Chat также в VS Code предлагает исправить это, используя команду /fix. Посмотрим на решение.
Исправление ошибок покрытие тестами команду fix.
Это решило нашу проблему. Но исходя из моего опыта, в случае сложных ошибок, например с несовместимостью типов, это не помогает и зачастую Copilot просто генерирует неподходящий нам код.
Сейчас у нас сделана форма обратной связи, и всё покрыто тестами. Потрачено минимум времени на написание рутинного кода. В сложной логике с большим количеством зависимостей в вашем проекте, Copilot хорошо справляется с предложением назвать метод или переменную и присвоением переменной нужного значения, а также описанием jsDoc. Для этого также можно использовать Copilot Chat с командой /doc.
Форма обратной связи.
Что происходит с CPU при использовании Copilot
Ещё интересно посмотреть, что происходит с памятью и CPU нашей машины. Смотрю на Mac M1. Находим процесс VS Code с плагином Copilot (у меня это 22 тред 83 порт), и попробуем при помощи AI написать компонент-форму, используя наши готовые компоненты input и textarea.
CPU
Memory
Сильной нагрузки на процессор не происходит. Как видно на записи выше, утечки памяти тоже нет, как, например, в первой версии Copilot (там было намного хуже). Всё работает плавно, торможений при разработки нет.
Подведем итог
В работе над проектом Copilot — хороший помощник. Всё в голове держать невозможно, и зачастую для решения своей задачи нам приходиться искать вопрос в интернете, а Copilot позволяет сделать это прямо в вашей idea. Однако, несмотря на его потенциал, важно помнить о таких вызовах, как безопасность и этика, связанных с использованием автоматически сгенерированного кода. Это, конечно, кладётся на плечи разработчика. С развитием технологии и сообщества вокруг Copilot мы можем ожидать ещё больших инноваций и улучшений в будущем. Пусть Copilot будет вдохновением для нас, чтобы мы могли создавать более эффективное и качественное программное обеспечение для всех.
Делитесь вашим опытом и рабочими кейсами в комментариях, как вы используете Copilot в работе.
