Skip to content

Pranit-Harekar/better-naming

Repository files navigation

PRs Welcome

BetterNaming - VS Code Extension

A genie in a bottle, ready to grant developers' wishes for well-named variables

This extension suggests meaningful names for variables, functions and classes using OpenAI's text completions API.

Extension Link

Screen.Recording.2023-02-19.at.6.49.19.PM.mov

Requirements

This extension uses OpenAI's Node.js library to access their Text Completion API therefore it needs to be configured with your account's secret key, which is available on the website. Once you obtain it, you can either run setApiKey command explicitly or suggestNames directly to set the API key. This is a one time setup as your API key will be stored in a SecretStorage. Therefore the key is persisted across reloads and is independent of the current opened workspace.

Features

Extension currently offers following commands, which can be access via Command Palette (Cmd+Shift+P) -

  • suggestNames: Suggests names. Select a code block and run the command to view suggestions. Additionally, if your code has "foo" as the placeholder name, it will be renamed with your selection from the suggestion list otherwise extension will not rename it.

  • setApiKey: Sets secret API key. As mentioned above, this command can be skipped if you run suggestNames, in which case this command will be run as a part of suggestNames command if the API key is missing.

  • deleteApiKey: Deletes secret API key

Release Notes

1.0.1

Improved error handling so API & other errors are now visible

1.0.0

Initial release

--