Cómo manejar en Eclipse PDT errores por dependencias PHP de Composer que son sugeridas pero no instaladas

¿Por qué un proyecto Laravel creado con composer create-project laravel/laravel depende del paquete ably-php pero no se descarga dicho paquete?

Esta pregunta apunta a una característica importante de cómo Composer maneja las dependencias: el concepto de suggest (sugerir) en composer.json.

Cuando creas un proyecto Laravel con composer create-project laravel/laravel, el paquete principal que se instala es laravel/framework, junto con algunas otras dependencias esenciales.

La razón por la que podrías ver que ably-php "depende" (o aparece mencionado) pero no se descarga es la siguiente:

1. No es una dependencia require directa ni transitiva obligatoria:

   ably-php (el cliente PHP para el servicio de mensajería en tiempo real Ably) no es una dependencia obligatoria para que Laravel funcione. Tu aplicación Laravel no lo necesita para arrancar ni para realizar tareas básicas como routing, ORM, etc.

2. Es una dependencia suggest (sugerida):

   El paquete laravel/framework (que es el núcleo de tu aplicación Laravel) tiene una sección en su composer.json llamada suggest. En esta sección, lista paquetes opcionales que podrías querer instalar si vas a usar ciertas funcionalidades de Laravel.

   Por ejemplo, Laravel soporta la funcionalidad de Broadcasting (transmisión de eventos en tiempo real). Para usar Broadcasting, Laravel necesita un driver, y Ably es uno de los drivers soportados.

   Entonces, en el composer.json de laravel/framework (o de algún componente relacionado con broadcasting), verás algo parecido a esto en la sección suggest:

   JSON

   {
       "name": "laravel/framework",
       "type": "library",
       // ... otras configuraciones
       "suggest": {
           "ably/ably-php": "Required to use the Ably broadcast driver.",
           "pusher/pusher-php-server": "Required to use the Pusher broadcast driver.",
           "php-amqplib/php-amqplib": "Required to use the RabbitMQ / AMQP queue driver.",
           // ... otras sugerencias
       },
       // ...
   }
   

¿Qué significa suggest en Composer?

• Cuando un paquete sugiere otro, significa: "Este paquete (ej. laravel/framework) puede funcionar sin el paquete sugerido (ably-php), pero si quieres usar una funcionalidad específica (ej. Broadcasting con Ably), entonces necesitarás instalarlo aparte."
• Composer no instala automáticamente los paquetes listados en suggest. Simplemente los muestra en la salida cuando ejecutas composer install o composer update (a veces con un mensaje como "Package X is suggested by Y for Z functionality"). Es una pista para el desarrollador.

¿Por qué elegir suggest en lugar de require?

Se usa suggest para:

1. Mantener el tamaño del paquete base pequeño: No se fuerza a todos los usuarios de Laravel a descargar dependencias que no usarán si no implementan ciertas funcionalidades.
2. Evitar dependencias innecesarias: Permite a los desarrolladores elegir solo lo que necesitan, reduciendo la "huella" de dependencias del proyecto.
3. Flexibilidad: Laravel puede sugerir múltiples drivers o implementaciones para una misma funcionalidad (como varios drivers de broadcasting o de colas), sin obligar a instalar todos.

En resumen:

Un proyecto Laravel estándar "sugiere" ably-php porque laravel/framework tiene soporte para usar Ably como driver de broadcasting, pero no lo "requiere" directamente. Por lo tanto, Composer te informa de su existencia pero no lo descarga a menos que tú lo pidas explícitamente.

Si en algún momento decides usar Ably para las funcionalidades de tiempo real en tu aplicación Laravel, deberás instalarlo manualmente ejecutando:

Bash

composer require ably/ably-php

Solo entonces el paquete se descargará y se incluirá en tu vendor/ y en tu composer.lock.

---

Aun así Eclipse PDT reporta un problema de "tipo no resuelto" ("unresolved type") por una referencia a Ably\AblyRequest. ¿Se puede hacer que Eclipse ignore errores por tipos no resueltos que provienen de dependencias no instaladas? (Eclipse PDT es Eclipse PHP Development Tools).

Ocurre lo siguiente. Aunque ably-php sea una dependencia "sugerida" por Composer y no se instale automáticamente, tu IDE (Eclipse PDT en este caso) escanea tu código en busca de referencias y tipos. Si encuentra una referencia a Ably\AblyRequest (o cualquier otra clase de ably-php) en tu código, y esa clase no existe en tu carpeta vendor/ (porque no la instalaste), Eclipse la marcará como un "tipo no resuelto" o "unresolved type".

Esto no es un error de ejecución de PHP (porque tu código real no intenta usar esa clase si no la has invocado), sino un error de análisis estático del IDE. El IDE está tratando de ser útil al advertirte sobre código que parece incompleto o incorrecto según lo que puede encontrar en tu proyecto.

¿Se puede hacer que Eclipse ignore errores por tipos no resueltos que provienen de dependencias no instaladas?

En general, no es recomendable ni fácilmente configurable en Eclipse PHP Development Tools (PDT) ignorar específicamente errores de "tipo no resuelto" para clases individuales o paquetes no instalados. El sistema de validación de Eclipse está diseñado para ayudarte a identificar problemas de código, y un tipo no resuelto suele ser un indicador de que falta una dependencia o que hay un error de tipeo.

Intentar configurar Eclipse para ignorar esto podría llevar a:

• Ocultar errores reales: Podrías pasar por alto un "tipo no resuelto" genuino que sí es un problema en tu código.
• Complejidad de configuración: Eclipse no tiene una opción sencilla para "ignorar este paquete si no está instalado". Deberías configurar reglas de validación muy específicas y quizás complicadas.

¿Cuál es la solución más práctica y recomendada?

La solución más limpia y estándar para este tipo de escenarios es no tener referencias directas en tu código a paquetes que no tienes intención de instalar.

Si tienes una referencia a Ably\AblyRequest en tu proyecto Laravel, significa que en algún punto de tu código (quizás en un controlador, un servicio, un custom hook, etc.) estás intentando usar una clase de la librería Ably.

Las causas más probables de esta referencia son:

1. Código copiado/pegado: Has copiado un fragmento de código (quizás de un tutorial o ejemplo) que utiliza Ably, pero no has instalado el paquete.
2. Preparación anticipada: Has empezado a escribir código para la integración con Ably, pero aún no has ejecutado composer require ably/ably-php.
3. Comentarios de código: A veces, las referencias pueden aparecer en comentarios de tipo PHPDoc o en bloques de código comentado que el analizador de Eclipse aún intenta interpretar.

Para solucionar esto, tienes dos opciones principales:

Opción 1: Eliminar o comentar la referencia a Ably\AblyRequest si no vas a usar Ably.

• Busca en tu proyecto dónde se está haciendo referencia a Ably\AblyRequest. Es probable que sea una línea use Ably\AblyRequest; o una instanciación de esa clase.
• Si no tienes la intención de usar Ably en tu aplicación, simplemente elimina esa línea o coméntala. Tu proyecto seguirá funcionando perfectamente sin ella.
• Para encontrarla en VS Code: Puedes usar la búsqueda global (Ctrl+Shift+F en Windows/Linux o Cmd+Shift+F en macOS) y buscar Ably\AblyRequest.

Opción 2: Instalar el paquete ably/ably-php si sí tienes la intención de usar Ably.

• Si estás planeando usar Ably para broadcasting u otra funcionalidad en tu aplicación, entonces la "solución" del IDE es correcta: necesitas instalar esa dependencia.
• Ejecuta en tu terminal, en la raíz del proyecto:
  Bash

  composer require ably/ably-php
  

• Después de ejecutar este comando, Composer descargará el paquete y actualizará el autoloader. Eclipse debería entonces reconocer la clase Ably\AblyRequest y el error de "tipo no resuelto" debería desaparecer. A veces, necesitas hacer un "Project -> Clean" o "Refresh" en tu proyecto de Eclipse después de las instalaciones de Composer para que el IDE actualice su índice.

En resumen:

El error de "tipo no resuelto" en Eclipse por Ably\AblyRequest es una advertencia de que la clase no se encuentra en el classpath de tu proyecto tal como lo ve el IDE. La mejor manera de abordarlo es asegurarte de que tu código solo referencia paquetes que realmente tienes instalados y necesitas, o instalarlos si la referencia es intencional. No se recomienda silenciar estos errores indiscriminadamente.

---

Aun así no quiero ni eliminar las referencias a Ably\AblyRequest ni tampoco instalar dicho paquete. Vale observar que las referencias incompletas a Ably aparecen dentro de la carpeta vendor. La carpeta vendor es donde va la librería de paquetes de terceras partes (third party packages), o sea, dependencias. Hay 2 motivos para no querer ver este tipo de errores en la capeta vendor:

1. Uno confía en que el paquete tiene la inteligencia para que no se invoque en tiempo de ejecución a las referencias incompletas que este tiene.
2. Analizar código de un paquete de terceras partes ya se puede entender como parte de otro objetivo: el desarrollo de dicho paquete. Esto desde el principio estaba fuera de alcance. Que uno o todos los paquetes de terceras partes (carpeta vendor) estén configurados de modo que no se realice análisis estático sobre ellos es razonable. 

Ignorando errores de PHP en Eclipse

Para ignorar problemas de PHP en Eclipse, se puede usar la característica "carpetas de librería" ("library folders"). Marcando ciertas carpetas como "carpertas de librería", se puede deshabilitar la validación y el análisis de código estático para dichos directorios, efectivamente ignorando todo error o advertencia que se genere en ellos.

Hacerlo mediante los siguientes pasos

Carpetas de biblioteca: Haga clic con el botón derecho en la carpeta que contiene el código que desea ignorar y seleccione "Usar como carpeta de biblioteca" ("Use as library folder"). Esta acción deshabilita la validación de esa carpeta, incluido el análisis de código PHP.

Además, puede excluir recursos del proceso de compilación mediante la configuración de la "ruta de compilación" ("build path") de PHP. Este método también suprimirá las advertencias del archivo no válido.

Pasos para excluir recursos mediante la "ruta de compilación" ("Build path") de PHP:

Vaya a Project > Properties > PHP Build Path.

En la pestaña "Código fuente" ("Source"), puede excluir carpetas o archivos específicos del proceso de compilación.

Estas funciones le permiten gestionar qué partes de su proyecto generan advertencias o errores, lo que le permite centrarse en el código que desarrolla activamente.