mago

Mago: la cadena de herramientas PHP oxidada

Mago (derivado de Mago (púnico:? Mago se inspira en el lenguaje de programación de óxido y su ecosistema, esforzándose por brindar una conveniencia, confiabilidad y una gran experiencia de desarrollador al mundo de PHP.

---

Nota: Este proyecto se llamaba anteriormente "Fennec" antes de ser renombrado debido a un conflicto de nombres.

Descargo de responsabilidad

Advertencia

Mago está en una etapa temprana de desarrollo. Todavía no se implementan muchas características, y la funcionalidad existente puede cambiar, romper o dejar de trabajar sin previo aviso. Si bien no estamos promocionando o anunciando activamente el proyecto, estamos trabajando en público para compartir nuestro progreso con la comunidad.

Instalación

Instalación de una línea (recomendada)

Para instalar rápidamente la última versión de Mago para MacOS o Linux, use el siguiente comando:

Usando curl :

curl --proto ' =https ' --tlsv1.2 -sSf https://carthage.software/mago.sh | bash

Usando wget :

wget -qO- https://carthage.software/mago.sh | bash

Directorio de instalación personalizado

Para especificar un directorio personalizado para el binario, use la opción --install-Dir:

curl --proto ' =https ' --tlsv1.2 -sSf https://carthage.software/mago.sh | bash -s -- --install-dir= " /.bin "

Si el directorio no está en su PATH , el script proporcionará instrucciones para agregarlo.

Instalación con sudo

Si necesita instalar el sistema MAGO en todo el sistema, puede usar sudo con el comando de instalación:

curl --proto ' =https ' --tlsv1.2 -sSf https://carthage.software/mago.sh | sudo bash

Binarios precompilados

Puede encontrar binarios precompilados para varias plataformas en nuestra página de lanzamientos. Simplemente descargue el archivo para su plataforma, extraiga y coloque el binario de Mago en algún lugar de su PATH .

Instalación a través de carga

Si tiene el óxido instalado, puede instalar MAGO con carga:

cargo install mago

Instalación desde la fuente

Para instalar MAGO desde la fuente, puede clonar el repositorio y construir el proyecto con carga:

git clone https://github.com/carthage-software/mago
cd mago
cargo install --path . 

Compatibilidad de la versión PHP

Actualmente, Mago se construye alrededor de PHP 8.3 y también admite PHP 8.4. Si bien el enlace y el formateador pueden funcionar con versiones anteriores de PHP, no podemos garantizar la compatibilidad . Pueden sugerir correcciones o código de escritura que solo sea compatible con PHP 8.3 y posterior.

En esta etapa, no hay opción para seleccionar un objetivo de versión PHP, lo que significa que Mago opera bajo el supuesto de versiones modernas de PHP. En el futuro, planeamos introducir soporte para seleccionar un objetivo de versión PHP. Una vez implementado, esta característica debería permitir una mejor compatibilidad con versiones PHP anteriores, potencialmente a PHP 8.0 o incluso antes.

Si está trabajando con versiones de PHP antes de las 8.3, continúe con precaución y revise las correcciones sugeridas o el código formateado para garantizar la compatibilidad con su versión.

Uso

Para un inicio rápido, puede consultar los archivos de configuración de ejemplo proporcionados:

• Configuración simple: examples/mago.toml
• Configuración completa con todas las opciones posibles: examples/mago-full.toml

Puede probar MAGO navegando al directorio examples y ejecutando el enlace en los archivos PHP de muestra:

 cd examples
mago lint
mago fmt

Esto analizará los archivos PHP ubicados en los examples/src/ y mostrará cualquier error de pelusa.

Cómo puedes ayudar

Mago es un proyecto impulsado por la comunidad, ¡y nos encantaría que te unas a nosotros! Aquí hay algunas formas en que puede contribuir:

• Sugerir ideas : ¿Tiene una idea para Mago? ¡Estamos abiertos a sugerencias que pueden hacer que la cadena de herramientas sea aún mejor!
• Ayuda a escribir documentación : la documentación clara y fácil de usar es clave para que MAGO sea accesible para todos. Si le gusta escribir u organizar documentos, nos encantaría su ayuda.
• Código de contribución : ¡Únase a nosotros en la construcción de Mago! Discuta primero cualquier característica o corrección de errores en los problemas para garantizar que coordinemos de manera efectiva.
• Patrocine el proyecto : si desea apoyar a Mago financieramente, considere patrocinar a @azjezz. ¡Cada contribución ayuda!
• Ayuda con el arte : ¡Mago podría usar un logotipo! Apreciaríamos la ayuda de un artista hábil para crear un logotipo original para Mago. (Tenga en cuenta que el arte generado por IA no será aceptado).

Únete a la comunidad de Mago

¿Tienes preguntas, comentarios o ideas? Únase a la comunidad de Mago en Discord para conectarse con otros desarrolladores y mantenerse actualizado.

Unir aquí

Inspiración

Mago se inspira en varias herramientas y proyectos que han contribuido significativamente a la comunidad de desarrollo:

• Clippy: una colección de pelucas para captar errores comunes y mejorar su código de óxido.
• OXC: una cadena de herramientas JavaScript escrita en óxido.
• PHP-Rust-Tools/Parser: un analizador PHP escrito en Rust, que influyó en nuestro enfoque de análisis.
• Slackhq/Hakana: una herramienta de análisis estático para Hacklang escrita en Rust, por el Creador del Salmo.

Estas herramientas nos han inspirado y ayudaron a dar forma al diseño y la funcionalidad de Mago.

Expresiones de gratitud

Nos gustaría reconocer las siguientes herramientas de PHP que han ayudado enormemente a cientos de miles de desarrolladores de PHP en su viaje, incluidos nosotros mismos:

• PHP CS Fixer: una herramienta para solucionar automáticamente los problemas de estándares de codificación de PHP.
• Salmo: una herramienta de análisis estático para encontrar errores en aplicaciones PHP.
• PHPSTAN: Herramienta de análisis estático PHP.
• PHP_CODESNIFFER: detecta violaciones de un conjunto definido de estándares de codificación.

Si bien Mago está destinado a ser una cadena de herramientas integral que eventualmente puede reemplazar algunas de estas herramientas, apreciamos profundamente sus contribuciones y la base que han creado para la comunidad de PHP.

Licencia

Mago tiene licencia bajo cualquiera de

• Licencia MIT (MIT) - Consulte el archivo de la licencia -MIT para obtener más detalles
• Licencia Apache, versión 2.0 (Apache-2.0)-Consulte el archivo de licencia-apache para más detalles

a tu opción.

Contribución

A menos que declare explícitamente lo contrario, cualquier contribución presentada intencionalmente para su inclusión en MAGO por usted tendrá licencia dual como anteriormente, sin ningún término o condiciones adicionales.

---

Gracias por su interés en Mago. Esperamos compartir nuestro progreso y colaborar con la comunidad a medida que evoluciona el proyecto.