Рефакторинг коду: зрозуміліше й безпечніше без зміни поведінки
Промпт для ШІ, що пропонує рефакторинг вашого коду: покращує читабельність, називає ризики й зберігає поведінку, з поясненням кожної зміни та тестами.
До чого цей промпт
Рефакторинг — це зміна будови коду без зміни його поведінки. Цей промпт допомагає зробити його безпечно: спершу модель описує, як вона розуміє код, і ви можете виправити її до внесення змін.
Розподіл на кроки (розуміння, проблеми, нова версія, тести, обмеження) схожий на справжнє код-рев’ю. Тому відповідь легше перевірити: ви бачите не лише новий код, а й причини кожної зміни та список того, що слід додатково протестувати.
Промпт
Ти старший інженер, який робить код-рев’ю. Допоможи зробити рефакторинг цього коду мовою [мова програмування].
Контекст: [що робить код, де він запускається, які залежності та обмеження].
Вимога: поведінка має лишитися тією самою. Нічого не змінюй у публічних сигнатурах функцій, якщо я не дозволив.
Зроби по кроках:
1. Коротко опиши, що, на твою думку, робить код. Я підтверджу або виправлю.
2. Назви 3–5 проблем: читабельність, дублювання, обробка помилок, потенційні баги, безпека.
3. Покажи оновлену версію коду. Кожну суттєву зміну коротко поясни в коментарі або списку після коду.
4. Запропонуй тести (або список випадків), якими можна перевірити, що поведінка не змінилась.
5. Окремо познач те, що ти не зміг(ла) перевірити без запуску, і про що мені варто подбати самому.
КОД:
```
[вставте код]
```Текст у квадратних дужках замініть своїми даними.
Як використовувати
Вставте фрагмент коду, який можна розглядати окремо: одну функцію, модуль чи клас. Опишіть контекст: що робить код і чим його не можна ламати. Прочитайте пункт 1: якщо модель неправильно зрозуміла призначення, поправте її до того, як вона перепише код.
Не вставляйте в чат паролі, ключі API, токени й приватні дані: замініть їх заглушками. Отриманий код обов’язково запускайте й проганяйте через ваші тести, перш ніж комітити.
Приклад відповіді
Проблеми: вкладені умови ускладнюють читання; однакова перевірка повторюється тричі; помилка читання файлу ковтається без повідомлення.
Зміни: умови замінено на ранні повернення; повторену перевірку винесено у функцію; додано явну обробку помилки з осмисленим повідомленням.
Це лише орієнтир за структурою: відповідь моделі щоразу трохи інакша.
Поради
- Просіть малі кроки: одна функція за раз зручніше перевіряти, ніж великий переписаний файл.
- Додайте до промпта чинні тести, якщо вони є: модель побачить, що має лишитись незмінним.
- Якщо є стиль-гайд команди, вставте його коротко: «дотримуйся таких правил називання».
- Просіть зберегти старі назви публічних функцій, інакше доведеться правити й місця, де їх викликають.
Часті запитання
Чи можна довіряти коду, який повернула модель?
Як чернетці, так. Але будь-який рефакторинг треба запустити, перевірити тестами й переглянути вручну. Промпт спеціально просить назвати те, що неможливо перевірити без запуску.
Для яких мов підходить цей промпт?
Для будь-якої мови, яку модель добре знає: Python, JavaScript, TypeScript, Java, C# та інших поширених. Для рідкісних мов і вузьких фреймворків результат може бути менш надійним.