Migrate static code analysis from Psalm to PHPStan
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Aptitud para principiantes
- 48/100
Línea de trabajo
Work through the three repositories listed, comparing their dependency files, lockfiles, Psalm configuration, Composer scripts, and GitHub workflows with open-runtimes/executor. Start by reviewing the existing Psalm setup and executor's PHPStan configuration, then raise analysis from level 1 toward level 8. Done means all three repositories use the shared PHPStan settings, expose composer check, and run it from code-analysis.yml on pushes.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Introduction
Static code analysis allows programmers to check their code for bugs ahead of time. There are many ways to do it, but this one specifically understands code without running it, allowing for very fast and reliable checks.
Starting this issue requires an understanding of PHP syntax. Finishing this issue will give you basic understanding about Composer (PHP package manager) and GitHub Actions.
Task summary
Your goal is to implement static code analysis in the following repositories:
1. Remove Psalm code analysis
Remove Psalm from all necessary places in the repository. Make sure those include:
- Removing from dependency manager (and it's lockfile)
- Removing Psalm configuration file
- Removing GitHub action automating Psalm code check
2. Install and configure PHPStan
Install PHPStan by using Composer, a PHP dependency manager.
Make sure the version for this dependency is set to automatically upgrade minor and patch versions, but not the major version.
If those terms seem new to you, check out Semantic Versioning.
To configure PHPStan, you use a specific JSON file. Please refer to the PHPStan documentation to learn more.
Your goal is to configure PHPStan in all repositories to the same settings. Please set it to the same settings as we used in another one of our open-source repositories open-runtimes/executor.
In rare scenarios, PHPStan can have issues seeing typings for PHP extensions such as Swoole or Redis. If this happens to you, you might need to mention their helpers in the scanDirectories of the PHPStan configuration.
3. Add command to run static code analysis
Set up Composer scripts called check. This command should run PHPStan on all directories including PHP files. We usually only store PHP code in directories src, app and tests, but make sure to double check it.
When running the PHPStan check, we strive for level 8 of strictness. We recommend you to start with low level of 1, and work your way up, inspecting new errors with each higher level.
If you face issue you can't find a way to solve, please discuss with us and in rare scenarios we allow ignoring a line of code in code analysis.
If you ever get stuck, you can again refer to open-runtimes/executor, to see how it's been done there.
4. Add GitHub automation
Add GitHub action to run linter (composer check) on each push, so pull requests run linter as check.
Store the new GitHub action in the code-analysis.yml file.
Just like before, if you feel stuck, you can refer to Open Runtimes Executor to validate your approach.
- Lenguaje dominante
- PHP
- Estrellas
- 4
- Forks
- 1
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Preparar el entorno
Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
filamentphp/filament#20630 ·
Los mantenedores suelen responder en 1 día
-
needs-maintainer-review review:approve
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
Ultimate-Multisite/ultimate-ai-connector-compatible-endpoints#163 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 88/100
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100