r3bl open core

r3bl-núcleo abierto

Bienvenidos a este monorepo. Todas las carpetas de este repositorio son proyectos Rust separados (crates) que probablemente estén publicados en crates.io. Y esto constituye un espacio de trabajo de Rust.

Aquí está el registro de cambios para este monorepo o espacio de trabajo de Rust. Este es un excelente lugar para comenzar a familiarizarse con lo que ha cambiado recientemente en cada uno de los proyectos en este espacio de trabajo de Rust.

Tabla de contenido:

• Este espacio de trabajo contiene muchas cajas TUI, CLI y TTY.
  • TUI asíncrono completo, modo sin procesar, pantalla completa para aplicaciones TUI inmersivas
  • TUI asíncrono parcial, modo sin formato parcial para programas asíncronos REPL y shell
  • Sincronización TUI mínima, bloqueo, modo sin procesar parcial para programas CLI simples con interacción de bloqueo
  • Cajas subyacentes
  • Caja orientada al usuario de nivel superior
• Aprenda cómo se construyen estas cajas, proporcione comentarios
• Creación del espacio de trabajo, CI/CD y pruebas
• Historia de las estrellas
• Archivo

Este espacio de trabajo contiene muchas cajas TUI, CLI y TTY.

La siguiente es una descripción general de alto nivel de cada una de las cajas que constituyen este espacio de trabajo de Rust.

Hay cajas que van desde TUI "completa" hasta TUI "parcial", y todo lo que hay en el medio.

TUI completa (asíncrono, modo sin formato, pantalla completa) para aplicaciones TUI inmersivas

r3bl_tui le brinda compatibilidad con "pantalla alternativa" y "pantalla completa" en modo sin formato, a la vez que es totalmente asíncrono. Un ejemplo de esto es la aplicación edi "Full TUI" en la caja r3bl-cmdr . Puede instalar y ejecutar esto con el siguiente comando:

cargo install r3bl-cmdr
edi

TUI parcial (asíncrono, modo sin formato parcial) para programas REPL y shell asíncronos

r3bl_terminal_async le brinda la posibilidad de crear fácilmente sus propios programas de shell asíncronos utilizando "async readline & stdout".

Aquí hay ejemplos de esto:

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 (sincronización, bloqueo, modo sin procesar parcial) para programas CLI simples con interacción de bloqueo

r3bl_tuify le brinda la posibilidad de crear fácilmente sus propios programas CLI con interacción de bloqueo. Esto es excelente para obtener información del usuario, mientras se bloquea el hilo principal y usar el modo sin formato mientras el hilo principal está bloqueado. Una aplicación de ejemplo de esto es la aplicación giti en la caja r3bl-cmdr . Puede instalar y ejecutar esto con el siguiente comando:

cargo install r3bl-cmdr
giti

Cajas subyacentes

Hay muchas otras cajas subyacentes que se utilizan para construir estas cajas de nivel superior. Aquí hay una breve lista de ellos:

• r3bl_core contiene muchas utilidades de bajo nivel que se utilizan en las otras cajas. Esto incluye cosas como macros declarativas, colores, estilos, compatibilidad con Unicode, etc. Con el tiempo, si algún código se crea en una caja de "nivel superior" y es útil en otras cajas, se mueve a esta caja. Y esto está documentado en el registro de cambios.

• r3bl_test_fixtures contiene muchos accesorios de prueba que se utilizan en las otras cajas. Esto incluye cosas como simulacros para stdio y flujos de eventos (eventos de entrada generados por la interacción del usuario).

• r3bl_ansi_color es una caja que no tiene ninguna relación con las demás en este espacio de trabajo. Proporciona una API limpia que le permite utilizar fácilmente colores ANSI en sus programas de terminal. Si no desea utilizar las cajas más complejas y solo necesita enviar texto con estilo al terminal, entonces esta es la caja para usted.

Caja orientada al usuario de nivel superior

Incluso hay una caja que solo contiene aplicaciones orientadas al usuario que se crean utilizando estas cajas subyacentes. Esta es la caja r3bl-cmdr , que le brinda las aplicaciones giti y edi (descritas anteriormente). Puede instalar y ejecutar esto con el siguiente comando:

cargo install r3bl-cmdr

Aprenda cómo se construyen estas cajas, proporcione comentarios

Para saber cómo construimos esta caja, eche un vistazo a los siguientes recursos.

• Si te gusta consumir contenido de vídeo, aquí tienes nuestro canal de YouTube. Por favor considere suscribirse.
• Si le gusta consumir contenido escrito, aquí está nuestro sitio para desarrolladores. Por favor considere suscribirse a nuestro boletín.
• Si tiene preguntas, únase a nuestro servidor de Discord.

Creación del espacio de trabajo, CI/CD y pruebas

Hay un script nushell que puede usar para ejecutar la canalización de CI/CD para este espacio de trabajo y más (operaciones solo locales). Para obtener una lista de estos, puede ver el script nushell en la raíz de run de este repositorio. Para tener una idea de los comandos que puede ejecutar, intente ejecutar el siguiente comando:

cargo install nu
nu run

Deberías ver un resultado similar a este:

 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 ejemplo:

• El comando nu run all-cicd ejecutará la canalización CI/CD para este espacio de trabajo.
• Sin embargo, puede ejecutar el comando nu run all para ejecutar la canalización de CI/CD y más (operaciones solo locales).

Cada caja contenida en este espacio de trabajo también puede tener su propio script nushell que también se denomina run . Esta es una convención que se utiliza en este espacio de trabajo. Puede ejecutar el script run en cada una de las cajas para obtener una lista de comandos específicos de esa caja.

Historia de las estrellas

Archivo

A medida que este repositorio crece, cambia y madura, es necesaria la poda. El r3bl-open-core-archive es donde se mueven todo el código y los artefactos que ya no son necesarios.

De esta manera no se "pierde" nada y si necesita utilizar parte del código que se eliminó, puede encontrarlo allí.

Además, si desea realizar cambios en este código y mantenerlo usted mismo, háganoslo saber.

1. Puede enviar relaciones públicas y también podemos aceptarlas y publicarlas en crates.io si tiene sentido.
2. O incluso podemos llegar a acuerdos para transferirle la propiedad del código y la caja si desea comprometerse a mantenerlo.