Configuración recomendada para curso PHP. Visual Studio Code. PHP. Bartolomé Sintes Marco. www.mclibre.org

Esta es la configuración de Visual Studio Code que se recomienda para seguir este curso.

La forma más sencilla de configurar Visual Studio Code de acuerdo con esta configuración recomendada es importar un perfil ya preparado, como se comenta en la lección Perfil recomendado.

Esta lección detalla la configuración recomendada, pero no explica los pasos para realizar esa configuración. En caso necesario, puede consultar la lección Personalización de VSC de los apuntes de Informática general, en la que se explica detalladamente cómo se personaliza Visual Studio Code. En dichos apuntes también puede consultar lecciones dedicadas a Visual Studio Code, como Presentación general, Instalación, Uso y otras, que le pueden ser de ayuda si no conoce Visual Studio Code.

Extensiones recomendadas para el curso de PHP

Estas son las extensiones que se aconseja instalar para seguir el curso Iniciación a la programación de páginas web en PHP de mclibre.org:

mclibre.org Snippets
PHP CS Fixer

mclibre.org Snippets

Autor: Bartolomé Sintes

Marketplace: mclibre Snippets

Repositorio GitHub: mclibre Snippets

Estos snippets permiten pegar código HTML en fragmentos PHP. Para ejecutarlos, se pueden utilizar estos enlaces de teclado:

Ctrl+Alt+v Ctrl+Alt+l: Pega el contenido del portapapeles (por ejemplo, código html), añadiendo una instrucción print para cada línea.
Ctrl+Alt+v Ctrl+Alt+b: Pega el contenido del portapapeles (por ejemplo, código html), añadiendo una única instrucción print.
Ctrl+Alt+v Ctrl+Alt+q: Pega el contenido del portapapeles (por ejemplo, código html), sustituyendo las comillas dobles (") por el carácter especial \".

PHP CS Fixer

Autor: junstyle

Marketplace: PHP CS Fixer

Repositorio GitHub: PHP CS Fixer

PHP Coding Standards Fixer (PHP CS-Fixer) es una herramienta creada por los autores del framework PHP Symfony. Esta extensión permite utilizarla en Visual Studio Code.

Una vez instalada, aplique la herramienta mediante el atajo de teclado habitual para formatear código Alt+Mayús+f.

La herramienta CS Fixer no está diseñada para formatear archivos con fragmentos HTML y fragmentos PHP, por ello al formatear estos archivos únicamente se formateará el código PHP, no el HTML.

Notas:

Realmente, esta extensión puede formatear también los fragmentos HTML (estableciendo la configuración "php-cs-fixer.formatHtml" con el valor true), pero el resultado no me termina de gustar y por eso no recomiendo activarlo.
Existe una extensión para facilitar el formateo de fragmentos HTML, Format HTML in PHP, pero el resultado tampoco me termina de gustar y por eso no recomiendo instalarla.
La issue #27 es una de la que me gustaría ver resuelta antes de recomendar esta extensión.

Preferencias globales recomendadas para PHP CS Fixer:

Nota: En el apartado siguiente, Preferencias de configuración recomendadas, se han incluido las configuraciones de esta extensión, por lo que no hace falta incluirlas, pero sí que debe crearse el archivo de configuración de PHP CS Fixer que se comenta a continuación de estas preferencias globales.

  // Extensión PHP CS Fixer
  //
  // Ubicación del ejecutable de php-cs-fixer
  "php-cs-fixer.executablePath": "${extensionPath}/php-cs-fixer.phar",
  "php-cs-fixer.executablePathWindows": "${extensionPath}/php-cs-fixer.phar",
  // Configuraciones de php-cs-fixer
  "php-cs-fixer.onsave": false,
  "php-cs-fixer.rules": "@PSR2",
  "php-cs-fixer.config": "php-cs-fixer-config.php",
  "php-cs-fixer.allowRisky": false,
  "php-cs-fixer.pathMode": "override",
  "php-cs-fixer.exclude": [],
  "php-cs-fixer.autoFixByBracket": true,
  "php-cs-fixer.autoFixBySemicolon": false,
  "php-cs-fixer.formatHtml": false,
  "php-cs-fixer.documentFormattingProvider": true,
  //
  //

Archivo de configuración de PHP CS Fixer

Cree un fichero php-cs-fixer-config.php en la carpeta .vscode y copie en él la configuración recomendada para PHP CS Fixer que se muestra a continuación. Tenga en cuenta que el nombre del fichero se establece con la opción de configuración "php-cs-fixer.config" y el archivo de configuración puede estar fuera de la carpeta .vscode.

Las reglas disponibles en PHP CS Fixer se pueden consultar de forma individual en la documentación de PHP CS Fixer.

<?php

// Apuntes del curso Programación web en PHP
// https://www.mclibre.org/consultar/php/
//
// Archivo de configuración para PHP CS Fixer
// 2022-12-05

return (new PhpCsFixer\Config())
    ->setRules([
        '@PER'                                        => true,
        'align_multiline_comment'                     => ['comment_type' => 'all_multiline'],
        'array_indentation'                           => true,
        'array_syntax'                                => ['syntax' => 'short'],
        'binary_operator_spaces'                      => ['default' => 'align_single_space_minimal', 'operators' => [], ],
        'cast_spaces'                                 => ['space' => 'none'],
        'combine_consecutive_issets'                  => true,
        'concat_space'                                => ['spacing' => 'one'],
        'explicit_indirect_variable'                  => true,
        'function_typehint_space'                     => true,
        'include'                                     => true,
        'linebreak_after_opening_tag'                 => true,
        'list_syntax'                                 => ['syntax' => 'short'],
        'magic_constant_casing'                       => true,
        'magic_method_casing'                         => true,
        'multiline_comment_opening_closing'           => true,
        'multiline_whitespace_before_semicolons'      => true,
        'native_function_casing'                      => true,
        'native_function_type_declaration_casing'     => true,
        'no_alias_language_construct_call'            => true,
        'no_alternative_syntax'                       => true,
        'no_empty_statement'                          => true,
        'no_extra_blank_lines'                        => true,
        'no_mixed_echo_print'                         => ['use' => 'print'],
        'no_multiline_whitespace_around_double_arrow' => true,
        'no_short_bool_cast'                          => true,
        'no_singleline_whitespace_before_semicolons'  => true,
        'no_spaces_around_offset'                     => true,
        'no_superfluous_elseif'                       => true,
        'no_unneeded_control_parentheses'             => true,
        'no_unneeded_curly_braces'                    => true,
        'no_unset_cast'                               => true,
        'no_unused_imports'                           => true,
        'no_useless_concat_operator'                  => true,
        'no_useless_else'                             => true,
        'no_useless_return'                           => true,
        'no_whitespace_before_comma_in_array'         => true,
        'normalize_index_brace'                       => true,
        'object_operator_without_whitespace'          => true,
        'semicolon_after_instruction'                 => true,
        'single_line_comment_style'                   => true,
        'space_after_semicolon'                       => true,
        'standardize_not_equals'                      => true,
        'ternary_to_null_coalescing'                  => true,
        'trailing_comma_in_multiline'                 => true,
        'trim_array_spaces'                           => true,
        'unary_operator_spaces'                       => true,
        'whitespace_after_comma_in_array'             => true,
    ])
    ->setIndent("    ")
    ->setLineEnding("\n");

Preferencias de configuración recomendadas para el curso de PHP

Estas son las preferencias de configuración que se aconseja establecer para seguir el curso Iniciación a la programación de páginas web en PHP de mclibre.org.

Preferencias globales (Usuario)

En primer lugar, establezca las preferencias globales recomendadas en el curso de Páginas web HTML y hojas de estilo CSS de mclibre.org.

A continuación, añada las preferencias globales que se muestran a continuación, que son específicas para el curso de PHP.

Tenga en cuenta que estas preferencias deben añadirse dentro de las llaves inicial ({) y final (}).

Tenga en cuenta que puede ser necesario modificar las preferencias resaltadas del ejemplo siguiente:

"php.validate.executablePath" y "php.executablePath": deben indicar la ruta hasta el ejecutable de PHP. El valor incluido en el ejemplo es el predeterminado de XAMPP en Windows.
Las rutas pueden escribirse con barras (/, como en el ejemplo) o con contrabarras dobles (\\), pero no con contrabarras simples (\).

  // Configuraciones recomendadas para el curso Programación web en PHP de www.mclibre.org
  //
  // PHP
  // Establece los valores de configuración que se reemplazarán para el lenguaje PHP
  "[php]": {
    "editor.tabSize": 4,
    "editor.defaultFormatter": "junstyle.php-cs-fixer",
  },
  //
  // PHP: Validate: Executable path
  // Ubicación del intérprete de PHP.
  "php.validate.executablePath": "C:/xampp/php/php.exe",
  //
  // PHP: Validate: Run
  // Indica la validación se ejecuta al guardar o al escribir.
  "php.validate.run": "onType",
  //
  //
  // Configuraciones de extensiones recomendadas para el curso Programación web en PHP de www.mclibre.org
  //
  // Extensión PHP CS Fixer
  //
  // Ubicación del ejecutable de php-cs-fixer
  "php-cs-fixer.executablePath": "${extensionPath}/php-cs-fixer.phar",
  "php-cs-fixer.executablePathWindows": "${extensionPath}/php-cs-fixer.phar",
  // Configuraciones de php-cs-fixer
  "php-cs-fixer.onsave": false,
  "php-cs-fixer.rules": "@PSR2",
  "php-cs-fixer.config": "php-cs-fixer-config.php",
  "php-cs-fixer.allowRisky": false,
  "php-cs-fixer.pathMode": "override",
  "php-cs-fixer.exclude": [],
  "php-cs-fixer.autoFixByBracket": true,
  "php-cs-fixer.autoFixBySemicolon": false,
  "php-cs-fixer.formatHtml": false,
  "php-cs-fixer.documentFormattingProvider": true,
  //
  //

Tareas recomendadas para el curso de PHP

Estas son las tareas que se aconseja crear para seguir el curso Iniciación a la programación de páginas web en PHP de mclibre.org.

Estas tareas se deben añadir a las tareas recomendadas en el curso de Páginas web HTML y hojas de estilo CSS de mclibre.org. Cree dichas tareas y después añada las tareas definidas a continuación. Tenga en cuenta que estas tareas deben añadirse dentro de la clave "tasks" (entre los corchetes inicial ([) y final (]) que definen la clave).

Una vez definidas las tareas, se recomienda definir los atajos de teclado que ejecuten estas tareas, tal y como se comenta en el apartado sobre Atajos de teclado recomendados.

Abrir páginas en el navegador (en el servidor local)

Las siguientes tareas permiten abrir en los navegadores Firefox y Chrome las páginas que se están editando en Visual Studio Code, pero no como ficheros sino a través del servidor web.

Tenga en cuenta que para que las páginas se muestren en el navegador es necesario crear un alias en Apache, como se comenta en la lección Configuración de Apache y PHP.

Compruebe los campos enmarcados del ejemplo siguiente, por si necesita modificarlas:

"command": debe indicar la ruta hasta el ejecutable de Firefox o Chrome. El valor incluido en el ejemplo es el predeterminado en Windows 10.
En particular, compruebe la ubicación del ejecutable de Chrome, ya que desde Chrome 85 (publicado en agosto de 2020) Chrome se instala en "C:\Archivos de programa\" y no en "C:\Archivos de programa (x86)" como hacía antes, pero las actualizaciones no cambian la ubicación del programa, por lo que si tiene Chrome instalado desde antes de 2020 la ruta seguramente será "C:/Program Files (x86)/Google/Chrome/Application/chrome.exe".
"args": debe indicar el alias definido en Apache para acceder a la carpeta abierta en Visual Studio Code como área de trabajo (el del ejemplo corresponde a lo propuesto en el ejercicio Apache (1) 5).
Las rutas pueden escribirse con barras (/, como en el ejemplo) o con contrabarras dobles (\\), pero no con contrabarras simples (\).

    //
    // Tareas recomendadas para el curso Programación web en PHP de www.mclibre.org
    {
      "label": "Abrir en localhost (Firefox)",
      "command": "explorer",
      "windows": {
        "command": "C:/Program Files/Mozilla Firefox/firefox.exe"
      },
      "args": [
        "localhost/iaw/php/${relativeFile}"
      ],
      "presentation": {
        "reveal": "never"
      },
      "problemMatcher": []
    },
    {
      "label": "Abrir en localhost (Chrome)",
      "command": "explorer",
      "windows": {
        "command": "C:/Program Files/Google/Chrome/Application/chrome.exe"
      },
      "args": [
        "localhost/iaw/php/${relativeFile}"
      ],
      "presentation": {
        "reveal": "never"
      },
      "problemMatcher": []
    },
    //

En las tareas, en los valores de "args" pueden utilizarse las variables que se comentan en la página Listado de variables de la documentación oficial de Visual Studio Code.

Atajos de teclado recomendados para el curso de PHP

Estos son los atajos de teclado que se aconseja definir para seguir el curso Iniciación a la programación de páginas web en PHP de mclibre.org.

Estas atajos se deben añadir a las atajos de teclado recomendados en el curso de Páginas web HTML y hojas de estilo CSS de mclibre.org. Cree dichos atajos de teclado y después añada los atajos de teclado definidos a continuación. Tenga en cuenta que estos atajos de teclado deben añadirse entre los corchetes inicial ([) y final (]).

Tenga en cuenta que la clave "args" del atajo debe coincidir con la clave "label" de la tarea correspondiente o con el nombre del snippet correspondiente.

    //
    // Atajos de teclado recomendados para el curso Programación web en PHP de www.mclibre.org
    {
        // Tarea: Abrir en localhost (Firefox)
        "key": "ctrl+alt+l ctrl+alt+f",
        "command": "workbench.action.tasks.runTask",
        "args": "Abrir en localhost (Firefox)"
    },
    {
        // Tarea: Abrir en localhost (Chrome)
        "key": "ctrl+alt+l ctrl+alt+c",
        "command": "workbench.action.tasks.runTask",
        "args": "Abrir en localhost (Chrome)"
    },
    //

Visual Studio Code. Configuración recomendada para el curso Programación web en PHP

Tema de color recomendado para el curso de PHP

Área de trabajo