Uso de los estándares de codificación de PHP en el código de Visual Studio

Así que tenemos los conceptos básicos configurados en Visual Studio Code, pero no tenemos ninguna herramienta práctica instalada que nos ayude con el lado más profesional de escribir código.

Por supuesto, "profesional" se puede definir en función de la empresa, el equipo o el entorno en el que está trabajando. Para esta serie, opté por usar WordPress como base. Pero eso aún deja cosas como:

• estándares de codificación,
• pelusa de JavaScript,
• gestión de paquetes,
• Y así.

Y a lo largo de la serie, cubriré todo lo mencionado anteriormente. Pero para hacerlo, voy a cubrir cada componente uno por uno.

La publicación de hoy se centrará en los estándares de codificación de PHP. He escrito mucho material sobre los estándares de codificación de WordPress, pero en el último año o más, comencé a trabajar más con PSR, y eso es lo que se tratará en esta publicación.

Como nota al margen, sepa que gran parte de lo que se cubre se puede traducir a los estándares de codificación de WordPress si así lo desea, y quedará claro dónde haría los cambios.

Dicho esto, comencemos.

Estándar de codificación PHP en Visual Studio Code

Primero, asegúrese de tener los requisitos previos, todos los cuales están cubiertos en publicaciones anteriores de esta serie. A saber:

1. Un IDE para el desarrollo de WordPress
2. Trabajar con la configuración de usuario en Visual Studio Code

Cada uno de los anteriores explica cómo instalar, configurar y administrar Visual Studio Code y los conceptos básicos para comprender la configuración del usuario (junto con las fuentes preferidas y similares).

Y con eso, es hora de instalar la compatibilidad con el rastreo de código y las reglas para los estilos de codificación PHP basados ​​en PSR-2.

[restringir pagado="verdadero”]

Antes de decirle a Code que desea usar este conjunto particular de reglas, hay algunas cosas que puede agregar a su archivo de configuración.

1 Una actualización de su configuración de usuario

Recuerde, para actualizar su Configuración de usuario, simplemente haga clic en Código y luego vaya a Configuración, o puede usar el acceso directo Cmd+ (o el equivalente en su sistema operativo).

Esto abrirá una ventana familiar:

A continuación, emita el siguiente comando en su terminal:

$ brew install php-code-sniffer

Tenga en cuenta que cuando hago esto, ya lo tengo instalado, pero se me solicita que actualice (así que lo tengo).

Y luego, dentro de él, puede agregar las siguientes líneas a su archivo de configuración de usuario:

{
  // ...

  // PHP Settings.
  "php.suggest.basic": true,
  "php.validate.executablePath": "/usr/local/bin/php",
  "php.validate.run": "onSave",

  // ...
}

Si no está seguro de la ruta a su instalación local de PHP, puede ejecutar el siguiente comando en su terminal:

$ which php

Esto es lo que describe cada línea:

1. php.suggest.basic. Esto controla si el IDE hará sugerencias para el código basado en PHP por sí mismo (lo cual es útil cuando se escribe código). Piense en esto como autocompletar, un vistazo a la API, o como lo llamen sus IDE actuales o anteriores.
2. php.validar.ejecutablePath. Esto simplemente hace referencia al binario de PHP en el disco. Esto es útil para ejecutar la versión de PHP con la que se ejecutan sus proyectos.
3. php.validar.ejecutar. Como es de esperar, esto validará su código cuando guarde su archivo. Puede hacerlo mientras escribe, pero dependiendo de cuánto escriba, qué tan rápido escriba o simplemente la naturaleza de sus hábitos, puede ser más fácil hacerlo en Guardar (por eso lo uso en lugar de la alternativa que es onType ).

Todo esto es bueno y necesario, en mi opinión, pero no nos permite olfatear ningún código. Así que dirijamos nuestra atención a eso ahora.

2 Adición de rastreo de código

Recuerde de la sección anterior, seguí adelante e instalé PHP Code Sniffer a través de Homebrew, pero ¿cómo agregamos soporte a esto a través de Visual Studio Code?

Quiero decir, tiene su propio mercado donde podemos agregarlo, pero ¿hay otras cosas que podamos hacer? Ya que lo instalamos a través de Homebrew, está listo.

Ahora es cuestión de vincularlo a Code. Esto es cuestión de hacer dos cosas:

1. Instalar un complemento en Code,
2. Actualizando su configuración de usuario (una vez más).

Primero, navegue a la pantalla de complementos en Código y luego busque phpcs. Deberías ver algo como lo siguiente:

Haga clic en Instalar y luego en Recargar si se le solicita que lo haga.

A continuación, volvemos a visitar nuestro archivo de configuración y agregamos lo siguiente:

{
  // ...

  // PHP Coding Standards.
  "phpcs.enable": true,
  "phpcs.executablePath": "/usr/local/bin/phpcs",
  "phpcs.standard": "PSR2"

  // ...
}

En este punto, ya ha terminado de configurar los estándares de codificación PHP PSR-2 con Visual Studio Code.

3 Ahora pruébalo

Para ver si todo funciona correctamente, abra cualquier archivo PHP, ya sea uno de un proyecto en el que esté trabajando o uno del núcleo de WordPress. Abra el terminal integrado. Dado que el núcleo de WordPress no sigue a PSR-2, es probable que vea muchos errores.

Consulte la pestaña Problemas en la terminal y observe:

Por supuesto, esto no pretende castigar a WordPress. En su lugar, está destinado a mostrar que cuando ve un problema proveniente de PHP Code Sniffer, puede solucionarlo antes de guardar el archivo, completarlo o enviarlo al repositorio.

¿Qué pasa con el trabajo de front-end?

Tan importante como es asegurarse de que nuestro código tenga la calidad adecuada del trabajo del lado del servidor, ¿qué pasa con CSS (o Sass o LESS) o JavaScript?

También hay herramientas específicas para eso, y vamos a continuar cubriendo ese material en la próxima publicación.

Por ahora, concéntrese en configurar los estándares de codificación de PHP en el código, compruebe lo que puede hacer mejor para mejorar sus estilos y partiremos de ahí.