Как разработчики, мы все знаем, как важно выбирать осмысленные имена для наших переменных, функций и классов. Имена, которые мы выбираем, не только помогают нам понять, что делает код, но и облегчают понимание нашего кода другими. Однако придумать осмысленные имена часто бывает сложной задачей.
Чтобы решить эту проблему, я создал расширение для VS Code — BetterNaming. BetterNaming — это расширение VS Code, призванное помочь разработчикам придумывать более осмысленные и описательные имена для переменных, функций и классов. Он использует API завершения текста OpenAI, чтобы предлагать имена на основе контекста кода, что упрощает для разработчиков написание кода, который легче читать и понимать.
Настройка BetterNaming проста и понятна. После установки расширения пользователям необходимо настроить его с помощью своего ключа API OpenAI, который доступен на веб-сайте OpenAI. Это одноразовая настройка, и ключ API надежно хранится в SecretStorage расширения, поэтому он сохраняется при перезагрузке и не зависит от открытой в данный момент рабочей области.
В настоящее время расширение предлагает три команды, доступ к которым можно получить через палитру команд (Cmd + Shift + P) —
1. предложить имена
Команда SuggestNames используется для предложения имен для выбранных блоков кода. Если выбранный блок кода содержит имя-заполнитель «foo», расширение заменит его выбором пользователя из списка предложений, в противном случае расширение просто отобразит предложения и не применит их.
2. установитьApiKey
Команду setApiKey можно использовать для настройки расширения с использованием пользовательского ключа OpenAI API. Если пользователь запускает команду SuggestNames без настройки ключа API, команда setApiKey будет выполняться автоматически как часть команды SuggestNames.
3. удалитьАпиКей
Команду deleteApiKey можно использовать для удаления пользовательского ключа OpenAI API из SecretStorage расширения.
В целом, BetterNaming — это мощный и удобный инструмент, который помогает разработчикам создавать более качественные имена. Использование API завершения текста OpenAI гарантирует, что предлагаемые имена являются осмысленными и описательными, а его интеграция с VS Code упрощает использование и настройку.
Если вы разработчик, который борется с соглашениями об именовании или просто хочет ускорить процесс именования, попробуйте BetterNaming. Если вы хотите внести свой вклад в проект, ознакомьтесь с репозиторием GitHub ниже —
