Cómo revisar código con linters en WordPress

Introducción

Revisar el código es una práctica esencial para mantener la calidad, consistencia y seguridad de los proyectos en WordPress. Los linters automatizan la detección de errores de sintaxis, estilo y convenciones, asegurando que todos los desarrolladores sigan los mismos standards. En este artículo detallado explicaremos cómo configurar y usar linters en un entorno WordPress, cubriendo desde la instalación hasta la integración en flujos de trabajo profesionales.

¿Qué es un Linter

Un linter es una herramienta que analiza el código fuente para detectar errores, inconsistencias o violaciones a un conjunto de reglas predefinidas. En PHP y JavaScript, los linters más populares son PHP_CodeSniffer (PHPCS) y ESLint respectivamente.

Importancia de los linters en WordPress

• Calidad de código: Identifican errores antes de ejecutar el código.
• Consistencia: Garantizan un estilo unificado en todos los archivos.
• Mantenibilidad: Facilitan la lectura y futuras actualizaciones.
• Seguridad: Pueden descubrir patrones vulnerables.

Estándares de codificación de WordPress

El manual oficial define reglas para:

PHP

Indentación con espacios, nombres en snake_case, documentación con PHPDoc.

JavaScript

Uso de ES5/ES6 según el contexto, comillas simples, cierre de sentencias.

CSS

Convenciones de nomenclatura BEM, orden de propiedades, uso de tabuladores o espacios.

Herramientas necesarias

• Composer: Gestor de dependencias PHP.
• PHP_CodeSniffer (PHPCS): Analizador de estilo.
• WordPress Coding Standards (WPCS): Conjunto de reglas para PHPCS.
• Editor de código: VSCode, PHPStorm o similar con integración de linters.

Instalación y configuración

1. Instalar Composer

Si no lo tienes:

curl -sS https://getcomposer.org/installer  php
mv composer.phar /usr/local/bin/composer

2. Añadir PHPCS y WPCS

Dependencia	Comando
PHP_CodeSniffer	composer require --dev squizlabs/php_codesniffer
WordPress Coding Standards	composer require --dev wp-coding-standards/wpcs

Registra el estándar en PHPCS:

vendor/bin/phpcs --config-set installed_paths vendor/wp-coding-standards/wpcs

Uso básico del linter

Para analizar un archivo o directorio:

vendor/bin/phpcs --standard=WordPress path/to/file-or-folder

Para autocorregir ciertos problemas:

vendor/bin/phpcbf --standard=WordPress path/to/file-or-folder

Integración en editores

• VSCode: Instala las extensiones “phpcs” y configura el path a vendor/bin/phpcs. Sitio oficial
• PHPStorm: En Settings gt Languages Frameworks gt PHP gt Quality Tools gt PHP_CodeSniffer. Apunta al ejecutable de Composer.

Integración en CI/CD

Automatiza la revisión en cada push o pull request:

• CircleCI: Añade un job que ejecute vendor/bin/phpcs. Documentación
• GitHub Actions: Usa un action para Composer y luego lanza PHPCS.

Personalización de reglas

Crea un archivo phpcs.xml en la raíz del proyecto:

ltxml version=1.0gt
ltruleset name=MiProyectogt
  ltrule ref=WordPress/gt
  ltrule ref=WordPress.PHP.Strict severity=5/gt
  ltexclude name=WordPress.DB.ExtraPlaceholders/gt
lt/rulesetgt

Con esto ajustas la severidad, añades o excluyes reglas según tus necesidades.

Buenas prácticas y consejos

1. Incluye la ejecución de linters en tu pre-commit hook usando husky o pre-commit.
2. Revisa periódicamente las actualizaciones de WPCS para nuevas reglas.
3. Combina linters con pruebas unitarias para garantizar la calidad completa.
4. Documenta las convenciones personalizadas en el README de tu proyecto.

Errores comunes y soluciones

• ‘installed_paths’ no configurado: Asegúrate de ejecutar el comando de registro tras instalar WPCS.
• Rendimiento lento: Excluye directorios grandes como node_modules o vendor.
• Conflicto de versiones: Bloquea la versión de PHPCS/WPCS en el composer.json.

Recursos adicionales

• Manual oficial de Coding Standards de WordPress
• Repositorio de WordPress Coding Standards
• PHP_CodeSniffer en GitHub