Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tomlin7/biscuit
lightweight code editor for any language
https://github.com/tomlin7/biscuit
autocomplete code-editor command-palette debugger extensions goto-definition hacktoberfest python terminal text-editor tkinter vscode
Last synced: 1 day ago
JSON representation
lightweight code editor for any language
- Host: GitHub
- URL: https://github.com/tomlin7/biscuit
- Owner: tomlin7
- License: mit
- Created: 2021-10-04T18:45:57.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-22T06:30:43.000Z (8 months ago)
- Last Synced: 2024-05-22T13:47:50.295Z (8 months ago)
- Topics: autocomplete, code-editor, command-palette, debugger, extensions, goto-definition, hacktoberfest, python, terminal, text-editor, tkinter, vscode
- Language: Python
- Homepage: https://tomlin7.github.io/biscuit
- Size: 5.2 MB
- Stars: 140
- Watchers: 2
- Forks: 18
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
Aesthetic, lightweight code editor with extension support. Draws inspiration from mainstream editors like VSC, Zed, and Vim. Hobby project.
> - - - - Check all extensions and their authors [`~extension repository`](https://tomlin7.github.io/biscuit-extensions/)
> - - - - Contributing/User guides, API reference [`~documentation`](https://tomlin7.github.io/biscuit)
> - - - - Scroll down to see list of all supported [`~features`](https://github.com/tomlin7/biscuit?tab=readme-ov-file#features)
> Theme inspired by [`morhetz/gruvbox`](https://github.com/morhetz/gruvbox)
## `Installing`
Install the latest release from PyPI by running:
```bash
> pip install biscuit-editor
```
Quickly open up a project using **`biscuit path/to/src`** and start editing. See other [installation methods](https://tomlin7.github.io/biscuit/getting-started/installation/).
## `Contributing`
- - - Please check the [docs](https://tomlin7.github.io/biscuit/getting-started/quick-start/) and [contributing guide](https://github.com/tomlin7/Biscuit/blob/main/CONTRIBUTING.md) for a quick tour of the project structure and to set up the environment.
- - - To make a new extension, read the [extension docs](https://github.com/tomlin7/biscuit-extensions)
## `Features`
### Language Server Support
- code completions
- hover
- symbol outline (palette `Ctrl + J`)
- symbol references
- goto-definition/declaration
More language servers are registered through extensions, see the [Rust](https://github.com/tomlin7/biscuit-extensions/blob/main/extensions/rust.py), [Typescript](https://github.com/tomlin7/biscuit-extensions/blob/main/extensions/javascript_typescript.py) extensions
for reference. Feel free to open issues/discussions for help!
### Breakpoint-based Code Debugging
- breakpoints in multiple files
- variable inspection
- modify variables at runtime
- call stack
Built-in Python debugger is available right now, more debuggers can be registered through extensions.
- TODO: Debugger Adapter Protocol support, [DAP client](https://github.com/tomlin7/debug-adapter-client) integration
### Git Support
- Diff viewer
- Git operations GUI-fied (push, pull, commit, stage, unstage, switch branches)
- Clone repositories within editor, and open them up
- View GitHub issues/pr within editor (NOTE: will be converted to an extension)
### Assistant
- Attach files for context in chat
- Generate terminal commands within integrated terminal (use `# prompt` in terminal, then accept/decline response)
- Run local LLMs with Ollama extension
- Google Gemini built-in support (key)
More providers can be added with extensions, see [ollama extension](https://github.com/tomlin7/biscuit-extensions/blob/main/extensions/ollama.py) for reference.
### Workspace Search
- regex support
- file preview, occurrence count, etc
- search within editors with find-replace widget
### More features
- **Integrated Terminals**
- Set up and store run command for each editor for ease
- Use `# prompt here...` commands to generate commands with assistant (key)
- Multiple terminals can be opened (Built in support for powershell, bash, cmd, python REPL, etc.)
- **Extension center**
- Install and manage all available extensions
- Filter all installed extensions
- Search for extensions
- Split-pane **Markdown** editor, HTML renderer
- Split-pane editing
- Syntax highlighting support
- TODO: CSS support for HTML editor
- Rich Command palette (commands added to [commands.py](https://github.com/tomlin7/biscuit/blob/main/src/biscuit/commands.py) are automatically made available)
- **Drag and drop** to open files or folders in Biscuit
- Built-in [editorconfig](https://editorconfig.org/) support
- Toggle relative line numbering
- Formatter extensions support
- See [black](https://github.com/tomlin7/biscuit-extensions/blob/main/extensions/black.py), [Ruff](https://github.com/tomlin7/biscuit-extensions/blob/main/extensions/ruff.py), [YAPF](https://github.com/tomlin7/biscuit-extensions/blob/main/extensions/yapf.py), [autopep8](https://github.com/tomlin7/biscuit-extensions/blob/main/extensions/autopep8.py) for reference.
## `License`
Biscuit uses the MIT License. For more information, see [LICENSE.md](https://github.com/tomlin7/Biscuit/blob/main/LICENSE.md).
