Senior

Are all senior engineers busy? Ask senior instead!

How to install

Requires: - openssl - a openAI api token - rust

cargo install senior

or

brew install brurucy/homebrew-senior/senior

Intro

Senior uses LLMs(at the moment only openAI ones however) and an advance source code parsing library, tree-sitter, to, from the comfort of your terminal, suggest improvements to your code.

As an argument to the cli, you can give:

1. A path to a file
2. A path to a file alongside a function name
3. A path to a file with a class/struct/parent element and a function name

In return, you will be prompted with an improved version. If you accept it, by pressing y, then the original file will be overwritten with the suggestion.

The only requirement is that you must have an environment variable named OPENAI_API_KEY with your very own token.

Language support

| Language | Whole File | Function | Method | Limitations | |------------|------------|----------|--------|-----------------------------------------------------------------------------------------------------------------------------------------| | Rust | X | X | X | | | Go | X | X | X | Untested with Generics. Most likely works. | | Javascript | X | X | X | Does not work with functions inside object literals
nor anonymous functions declared inside classes (you shouldn't do that anyways) | | Typescript | X | X | X | Does not work with functions inside object literals
nor anonymous functions declared inside classes (you shouldn't do that anyways) |

Contributing

In case you would like to either improve support for a language, or add one altogether, do not worry, as I've written senior in such a way that it should be pretty easy to do so. First, fork it, then, add a new language under supported_languages and follow what has been done for the other languages.

Roadmap

1. Leverage tree-sitter's capabilities to create a code context. For instance, if method A of class X is to be optimised, and there are other function or method calls inside A, then provide class X, and all constituent functions inside A as a context.
2. Java and Python support