Giter Club home page Giter Club logo

better-naming's Introduction

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

--

better-naming's People

Contributors

pranit-harekar avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

muratoner f4enn

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.