https://github.com/legobeat/l7-devenv

Secure terminal-based IDE for local JS development
https://github.com/legobeat/l7-devenv

neovim neovim-dotfiles nodejs rootless-containers

Last synced: about 1 month ago
JSON representation

Secure terminal-based IDE for local JS development

• Host: GitHub
• URL: https://github.com/legobeat/l7-devenv
• Owner: legobeat
• License: agpl-3.0
• Created: 2024-06-03T05:18:22.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-10-14T12:33:35.000Z (about 2 months ago)
• Last Synced: 2024-10-23T06:21:57.453Z (about 2 months ago)
• Topics: neovim, neovim-dotfiles, nodejs, rootless-containers
• Language: JavaScript
• Homepage:
• Size: 8.52 MB
• Stars: 19
• Watchers: 1
• Forks: 0
• Open Issues: 19
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

• awesome-neovim - legobeat/l7-devenv - Security-focused IDE with a hackable (in the right way) framework based on Neovim and shell. (Preconfigured Configuration / Competitive Programming)

README

        
# `l7ide`

Containerized neovim development environment. Primarily intended for contributors on [MetaMask](https://github.com/MetaMask) repositories.

For a guided tutorial, see [`docs/1-getting-started.md`](docs/1-getting-started.md).

## Goals

- Ease-of-use

  - Quick and easy to set up with minimal configuration and sane defaults

  - Easy to maintain and update at your leisure

  - Easily extensible, configurable and customizable

  - Adapted for contribution to MetaMask and LavaMoat codebases

  - Familiar setup for vscode/vim users

- Secure

  - Principle-of-least privilege applied

    - Text editor and plugins shouldn't need access to secrets like GitHub tokens

    - Keep development scripts and code-scanning tools away from each other and your home directory

  - Sandbox from rest of host system

    - Paste raw logs without exposing information about your user and host

  - Ephemeral file system

    - Everything beyond your sources and configuration are a clean slate after a restart

  - Auditable

- Fast and efficient

  - Low performance overhead - save your memory and CPU for more interesting work

- Productivity-enhanching

  - Code-analysis and refactoring features familiar for IDE users

## Dependencies

- OCI Container runtime

  - We will be using rootless podman to minimize privileges but Docker or any other compatible engine should work.

- An SSH agent socket

  - Typically provided by running `ssh-agent`

- (Optional) [Nerd Fonts](https://github.com/ryanoasis/nerd-fonts?tab=readme-ov-file#font-installation) enabled in your [terminal](docs/terminals.md)

  - For proper display of icons and font rendering

- (Optional) [Sixel](https://www.arewesixelyet.com/) support in your terminal

  - For rendering of images

- (Optional) A GPG agent socket

  - For signing git commits. Typically provided by running `gpg-agent` on the host.

## Screenshots

![screenshot: TypeScript LSP integration](docs/assets/devenv-mm-extension-1.png "LSP")

![screenshot: Forge issue and PR integration](docs/assets/devenv-mm-core-prs.png "PRs")

## Contribution Notes

> ⚠️ This is under early development and things might still shift around a bit. Open an [issue](issues/new) if you have any!

PRs with bugfixes, compatibility improvements, documentation and testing are especially welcome. New features may be considered but if they conflict with goals, you are also encouraged to run your own fork.