r3bl open core

r3bl-núcleo aberto

Bem-vindo a este monorepo. Todas as pastas neste repositório são projetos Rust separados (crates) que provavelmente são publicados em crates.io. E isso constitui um espaço de trabalho Rust.

Aqui está o changelog para este espaço de trabalho monorepo ou Rust. Este é um ótimo lugar para começar a se familiarizar com o que mudou recentemente em cada um dos projetos neste espaço de trabalho Rust.

Índice:

• Este espaço de trabalho contém muitas caixas TUI, CLI e TTY
  • TUI assíncrona completa, modo bruto, tela inteira para aplicativos TUI imersivos
  • TUI assíncrono parcial, modo bruto parcial para REPL assíncrono e programas shell
  • Sincronização TUI mínima, bloqueio, modo bruto parcial para programas CLI simples com interação de bloqueio
  • Caixas subjacentes
  • Caixa voltada para o usuário de nível superior
• Aprenda como essas caixas são construídas e forneça feedback
• Construindo o espaço de trabalho, CI/CD e testes
• História das Estrelas
• Arquivo

Este espaço de trabalho contém muitas caixas TUI, CLI e TTY

A seguir está uma visão geral de alto nível de cada uma das caixas que constituem este espaço de trabalho Rust.

Existem caixas que variam de TUI “completa” a TUI “parcial” e tudo mais no meio.

TUI completa (assíncrona, modo bruto, tela inteira) para aplicativos TUI imersivos

r3bl_tui oferece suporte ao modo bruto "tela alternativa" e "tela cheia", sendo totalmente assíncrono. Um exemplo disso é o aplicativo edi "Full TUI" na caixa r3bl-cmdr . Você pode instalar e executar isso com o seguinte comando:

cargo install r3bl-cmdr
edi

TUI parcial (modo bruto assíncrono e parcial) para REPL assíncrono e programas shell

r3bl_terminal_async oferece a capacidade de criar facilmente seus próprios programas shell assíncronos usando "async readline & stdout".

Aqui estão alguns exemplos disso:

1. https://github.com/nazmulidris/rust-scratch/tree/main/tcp-api-server
2. https://github.com/r3bl-org/r3bl-open-core/tree/main/terminal_async/examples

TUI mínima (sincronização, bloqueio, modo bruto parcial) para programas CLI simples com interação de bloqueio

r3bl_tuify oferece a capacidade de criar facilmente seus próprios programas CLI com interação de bloqueio. Isso é ótimo para obter a entrada do usuário, enquanto bloqueia o thread principal e usa o modo bruto enquanto o thread principal está bloqueado. Um exemplo de aplicativo disso é o aplicativo giti na caixa r3bl-cmdr . Você pode instalar e executar isso com o seguinte comando:

cargo install r3bl-cmdr
giti

Caixas subjacentes

Existem muitas outras caixas subjacentes que são usadas para construir essas caixas de nível superior. Aqui está uma pequena lista deles:

• r3bl_core contém muitos utilitários de baixo nível que são usados ​​em outras caixas. Isso inclui coisas como macros declarativas, cores, estilos, suporte Unicode, etc. Com o tempo, se algum código for criado em uma caixa de "nível superior" e for útil em outras caixas, ele será movido para esta caixa. E isso está documentado no changelog.

• r3bl_test_fixtures contém muitos acessórios de teste que são usados ​​em outras caixas. Isso inclui coisas como simulações para stdio e fluxos de eventos (eventos de entrada gerados pela interação do usuário).

• r3bl_ansi_color é uma caixa pouco relacionada às outras nesta área de trabalho. Ele fornece uma API limpa que permite usar facilmente cores ANSI em seus programas de terminal. Se você não quiser usar caixas mais complexas e precisar apenas enviar algum texto estilizado para o terminal, então esta é a caixa para você.

Caixa voltada para o usuário de nível superior

Existe até uma caixa que contém apenas aplicativos voltados para o usuário que são criados usando essas caixas subjacentes. Esta é a caixa r3bl-cmdr , que fornece os aplicativos giti e edi (descritos acima). Você pode instalar e executar isso com o seguinte comando:

cargo install r3bl-cmdr

Aprenda como essas caixas são construídas e forneça feedback

Para saber como construímos esta caixa, dê uma olhada nos seguintes recursos.

• Se você gosta de consumir conteúdo de vídeo, aqui está nosso canal no YT. Por favor, considere se inscrever.
• Se você gosta de consumir conteúdo escrito, aqui está nosso site para desenvolvedores. Por favor, considere assinar nosso boletim informativo.
• Se você tiver dúvidas, entre em nosso servidor discord.

Construindo o espaço de trabalho, CI/CD e testes

Há um script nushell que você pode usar para executar o pipeline de CI/CD para este espaço de trabalho e muito mais (operações somente locais). Para obter uma lista deles, você pode visualizar o script nushell na raiz deste repo run . Para ter uma ideia dos comandos que você pode executar, tente executar o seguinte comando:

cargo install nu
nu run

Você deverá ver uma saída semelhante a esta:

 Usage: run <command> [args]
<command> can be:
    all
    all-cicd
    build
    build-full
    clean
    install-cargo-tools
    test
    docs
    check
    check-watch
    clippy
    clippy-watch
    serve-docs
    upgrade-deps
    rustfmt
    help

Por exemplo:

• O comando nu run all-cicd executará o pipeline de CI/CD para este espaço de trabalho.
• No entanto, você pode executar o comando nu run all para executar o pipeline de CI/CD e muito mais (operações apenas locais).

Cada caixa contida neste espaço de trabalho também pode ter seu próprio script nushell , também denominado run . Esta é uma convenção usada nesta área de trabalho. Você pode executar o script run em cada uma das caixas para obter uma lista de comandos específicos daquela caixa.

História das Estrelas

Arquivo

À medida que este repositório cresce, muda e amadurece, a poda é necessária. O r3bl-open-core-archive é para onde todos os códigos e artefatos que não são mais necessários são movidos.

Dessa forma nada fica “perdido” e se precisar usar algum código que foi removido, você poderá encontrá-lo lá.

Além disso, se você quiser fazer alterações neste código e mantê-lo por conta própria, informe-nos.

1. Você pode enviar PRs e nós também podemos aceitá-los e publicá-los em crates.io se isso fizer sentido.
2. Ou podemos até mesmo chegar a um acordo para transferir a propriedade do código e da caixa para você, se você quiser se comprometer a mantê-lo.