Extensión para Visual Studio Code que sugiere buenas prácticas en PHP utilizando PHP_CodeSniffer. Esta herramienta permite a los desarrolladores escribir código PHP de calidad, alineado con los estándares de codificación, mostrando advertencias y sugerencias directamente en el editor.
Características ✨
- Análisis en tiempo real: Al abrir o guardar archivos PHP, la extensión analiza el código y sugiere mejoras.
- Mensajes en español: Muestra advertencias y sugerencias en español basadas en los estándares PSR.
- Personalizable: Configura la extensión según el estándar de codificación de tu elección (por defecto, PSR12) y ajusta el nivel de advertencias.
- Compatibilidad con PHP_CodeSniffer: Integrado con PHP_CodeSniffer para un análisis de calidad.
Estándares de Codificación Disponibles
- PSR-1: Estándar básico de codificación.
- PSR-2: Guía de estilo de codificación.
- PSR-12: Guía de estilo de codificación extendida.
- Squiz: Estándar de codificación desarrollado por Squiz Labs.
- PEAR: Estándar de codificación del repositorio de aplicaciones y extensiones de PHP.
- Zend: Estándar de codificación del framework Zend.
Colores e Iconos de Mensajes
La extensión muestra diferentes colores e iconos para cada categoría de mensaje:
- 🟦 PSR: Mensajes relacionados con estándares básicos y guías de estilo.
- 🟩 Squiz: Reglas y estándares específicos de Squiz Labs.
- 🟪 PEAR: Estándares de estilo y convenciones del repositorio PEAR.
- 🟧 Zend: Reglas y estilos específicos del framework Zend.
- 🟥 Generic: Advertencias y errores críticos, como problemas de estructura y lógica.
Cómo Personalizar los Iconos
Abre la Configuración de Usuario: Ve a Archivo > Preferencias > Configuración en VS Code.
Busca la Configuración de la Extensión: En el cuadro de búsqueda de la configuración, escribe phpBestPractices para filtrar las opciones disponibles.
Agrega la Configuración de Iconos: Añade la siguiente configuración en tu archivo settings.json:
"phpBestPractices.icons": {
"PSR": "🔵",
"Squiz": "🟢",
"PEAR": "🟣",
"Zend": "🟠",
"Generic": "🔴"
}
Ejemplo de Configuración Personalizada
Si deseas utilizar diferentes iconos, puedes hacerlo modificando los valores. Por ejemplo:
"phpBestPractices.icons": {
"PSR": "✔️",
"Squiz": "⚠️",
"PEAR": "❗",
"Zend": "❓",
"Generic": "ℹ️"
}
Capturas de Pantalla 📸
Aquí tienes algunos ejemplos de cómo la extensión mejora tu código PHP en tiempo real:
Sugerencias en Malas Prácticas
Requisitos 📋
PHP: Debe estar instalado y ser accesible desde la línea de comandos.
PHP_CodeSniffer: Instala PHP_CodeSniffer globalmente usando Composer:
composer global require "squizlabs/php_codesniffer=*"
Asegúrate de que la carpeta donde Composer instala binarios globales esté en tu variable de entorno PATH. Para verificar la ubicación, ejecuta:
composer global config bin-dir --absolute
Configurar PHP_CodeSniffer en VS Code: Una vez instalado, la extensión encontrará automáticamente PHP_CodeSniffer si está en el PATH. Si no, puedes especificar la ruta en las configuraciones de la extensión.
Instalación 🚀
- Instala la extensión desde el Marketplace de Visual Studio Code
- Asegúrate de tener configurado PHP_CodeSniffer.
- Reinicia Visual Studio Code y abre cualquier archivo PHP para comenzar a recibir sugerencias.
Configuración ⚙️
Puedes personalizar la extensión desde los ajustes de usuario de Visual Studio Code. Busca "PHP Best Practices" en la configuración para ver todas las opciones.
Opciones de Configuración
- phpBestPractices.standard: Especifica el estándar de codificación (por defecto, PSR12).
- phpBestPractices.executablePath: Ruta al ejecutable de PHP_CodeSniffer. Si PHP_CodeSniffer no está en el
PATH, especifica aquí la ruta completa.
Dependencias y Desarrollo 🔧
Si deseas contribuir o mejorar la extensión, sigue estos pasos para clonar y configurar el proyecto:
Clonar el Repositorio
git clone https://github.com/Ubyquit/php-best-practices-extension-vsc.git
cd php-best-practices-extension-vsc
Instalar Dependencias
Ejecuta el siguiente comando para instalar las dependencias de desarrollo:
npm install
Compilar el Proyecto
Para compilar la extensión, usa el siguiente comando:
npm run compile
Este comando compilará el proyecto y generará los archivos necesarios en la carpeta dist.
Ejecutar en Modo Observación
Para recompilar automáticamente cada vez que hagas un cambio en el código:
npm run watch
Pruebas
Si deseas ejecutar pruebas (asegúrate de tener instalado vscode-test):
npm run test
Contribuir 👥
¡Las contribuciones son bienvenidas! Si tienes sugerencias, mejoras o encuentras algún problema, no dudes en abrir un issue o enviar un pull request. Sigue estos pasos para contribuir:
- Haz un fork del proyecto.
- Crea una nueva rama (
git checkout -b feature/tu-feature).
- Realiza los cambios y commitea (
git commit -am 'Añadir nueva característica').
- Haz un push a la rama (
git push origin feature/tu-feature).
- Abre un pull request.
Créditos y Licencia 📝
Desarrollado por OpSET México. Publicado bajo la licencia MIT.
