mago

Mago: a cadeia de ferramentas PHP oxidada

Mago (derivado de Mago (púnico: ???, MGN), uma figura de renomada cartangina) é uma cadeia de ferramentas para o PHP que visa fornecer um conjunto de ferramentas para ajudar os desenvolvedores a escrever um código melhor. Mago se inspira na linguagem de programação de ferrugem e seu ecossistema, esforçando -se para trazer conveniência, confiabilidade e uma grande experiência de desenvolvedor para o mundo do PHP.

---

Nota: Este projeto foi nomeado anteriormente "Fennec" antes de ser renomeado devido a um conflito de nomenclatura.

Isenção de responsabilidade

Aviso

Mago está em um estágio inicial de desenvolvimento. Muitos recursos ainda não foram implementados e a funcionalidade existente pode mudar, quebrar ou parar de funcionar sem aviso prévio. Embora não estejamos promovendo ou anunciando ativamente o projeto, estamos trabalhando em público para compartilhar nosso progresso com a comunidade.

Instalação

Instalação de uma linha (recomendada)

Para instalar rapidamente o lançamento mais recente do Mago para MacOS ou Linux, use o seguinte 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

Diretório de instalação personalizado

Para especificar um diretório personalizado para o binário, use a opção--Install-Dir:

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

Se o diretório não estiver no seu PATH , o script fornecerá instruções para adicioná -lo.

Instalando com sudo

Se você precisar instalar o Mago em todo o sistema, poderá usar sudo com o comando de instalação:

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

Binários pré-compilados

Você pode encontrar binários pré -compilados para várias plataformas em nossa página de lançamentos. Basta baixar o arquivo para sua plataforma, extraí -lo e colocar o Mago Binário em algum lugar do seu PATH .

Instalação via carga

Se você estiver instalado, pode instalar Mago usando carga:

cargo install mago

Instalação da fonte

Para instalar o Mago a partir da fonte, você pode clonar o repositório e construir o projeto usando carga:

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

Compatibilidade da versão PHP

Atualmente, o Mago é construído em torno do Php 8.3 e também suporta o PHP 8.4. Embora o Linter e o Formatter possam funcionar com versões anteriores do PHP, não podemos garantir a compatibilidade . Eles podem sugerir correções ou gravar código que é compatível apenas com o PHP 8.3 e posterior.

Nesta fase, não há opção para selecionar um destino de versão PHP, o que significa que Mago opera sob a suposição das versões modernas do PHP. No futuro, planejamos introduzir suporte para selecionar um destino de versão PHP. Uma vez implementado, esse recurso deve permitir uma melhor compatibilidade com as versões anteriores do PHP, potencialmente até o PHP 8.0 ou até mais cedo.

Se você estiver trabalhando com versões PHP antes de 8.3, prossiga com cautela e revise as correções sugeridas ou o código formatado para garantir a compatibilidade com sua versão.

Uso

Para um início rápido, você pode consultar os arquivos de configuração de exemplo fornecidos:

• Configuração simples: examples/mago.toml
• Configuração completa com todas as opções possíveis: examples/mago-full.toml

Você pode experimentar o Mago navegando para o diretório examples e executando o linhador nos arquivos de php de amostra:

 cd examples
mago lint
mago fmt

Isso analisará os arquivos PHP localizados nos examples/src/ Diretório e exibirá quaisquer erros de linha.

Como você pode ajudar

Mago é um projeto orientado à comunidade, e adoraríamos que você se juntasse a nós! Aqui estão algumas maneiras de contribuir:

• Sugerir idéias : tem uma ideia para Mago? Estamos abertos a sugestões que podem tornar a cadeia de ferramentas ainda melhor!
• Ajude a documentação de escrever : documentação clara e fácil de usar é essencial para tornar o Mago acessível a todos. Se você gosta de escrever ou organizar documentos, adoraríamos sua ajuda.
• Contribua com código : junte -se a nós na construção de Mago! Discuta qualquer recurso ou correção de bugs nos problemas primeiro para garantir que coordenamos efetivamente.
• Patrocine o projeto : se você quiser apoiar o Mago financeiramente, considere patrocinar @azjezz. Toda contribuição ajuda!
• Ajuda com a arte : Mago poderia usar um logotipo! Agradecemos a ajuda de um artista qualificado para criar um logotipo original para Mago. (Observe que a arte gerada pela IA não será aceita.)

Junte -se à comunidade Mago

Tem perguntas, feedback ou idéias? Junte-se à comunidade Mago na Discord para se conectar com outros desenvolvedores e manter-se atualizado.

Junte -se aqui

Inspiração

Mago é inspirado por várias ferramentas e projetos que contribuíram significativamente para a comunidade de desenvolvimento:

• Clippy: Uma coleção de fianos para capturar erros comuns e melhorar seu código de ferrugem.
• OXC: Uma cadeia de ferramentas JavaScript escrita em ferrugem.
• Php-Rust Tools/Parser: um analisador PHP escrito em Rust, que influenciou nossa abordagem de análise.
• Slackhq/Hakana: Uma ferramenta de análise estática para Hacklang escrita em Rust, pelo criador do Salmo.

Essas ferramentas nos inspiraram e ajudaram a moldar o design e a funcionalidade de Mago.

Agradecimentos

Gostaríamos de reconhecer as seguintes ferramentas PHP que ajudaram muito centenas de milhares de desenvolvedores de PHP em sua jornada, incluindo:

• Fixer PHP CS: Uma ferramenta para corrigir automaticamente problemas de padrões de codificação PHP.
• Salmo: uma ferramenta de análise estática para encontrar erros em aplicativos PHP.
• Phpstan: Ferramenta de análise estática do PHP.
• Php_codesniffer: detecta violações de um conjunto definido de padrões de codificação.

Embora Mago pretenda ser uma cadeia de ferramentas abrangente que pode eventualmente substituir algumas dessas ferramentas, apreciamos profundamente suas contribuições e a base que eles construíram para a comunidade PHP.

Licença

Mago está licenciado sob qualquer um dos

• MIT Licença (MIT) - Consulte o arquivo de licença -mit para obter detalhes
• Licença Apache, versão 2.0 (Apache-2.0)-Consulte o arquivo de licença-apache para obter detalhes

por sua opção.

Contribuição

A menos que você declare explicitamente o contrário, qualquer contribuição intencionalmente enviada para inclusão em Mago por você será licenciada como acima, sem termos ou condições adicionais.

---

Obrigado pelo seu interesse em Mago. Estamos ansiosos para compartilhar nosso progresso e colaborar com a comunidade à medida que o projeto evolui.