Psalm Plugin for Symfony 安装与使用指南

Psalm Plugin for Symfony 安装与使用指南

psalm-plugin-symfony Psalm Plugin for Symfony 项目地址: https://gitcode.com/gh_mirrors/ps/psalm-plugin-symfony

1. 项目目录结构及介绍

psalm-plugin-symfony/
├── src/
│   ├── Plugin/
│   │   └── SymfonyPsalmPlugin.php
│   ├── Twig/
│   │   └── TemplateFileAnalyzer.php
│   └── ...
├── tests/
│   ├── ...
│   └── ...
├── .editorconfig
├── .gitattributes
├── .gitignore
├── .php-cs-fixer.dist.php
├── LICENSE
├── README.md
├── codeception.yml
├── composer.json
├── phpunit.xml
├── psalm-baseline.xml
├── psalm.xml
└── ...

目录结构说明

• src/: 包含插件的核心代码，包括插件类和Twig模板分析器。
• tests/: 包含插件的测试代码。
• .editorconfig: 配置文件，用于统一代码风格。
• .gitattributes: Git属性配置文件。
• .gitignore: Git忽略文件配置。
• .php-cs-fixer.dist.php: PHP代码风格修复器配置文件。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• codeception.yml: Codeception测试框架配置文件。
• composer.json: Composer依赖管理配置文件。
• phpunit.xml: PHPUnit测试框架配置文件。
• psalm-baseline.xml: Psalm基线配置文件。
• psalm.xml: Psalm静态分析配置文件。

2. 项目启动文件介绍

启动文件

• src/Plugin/SymfonyPsalmPlugin.php: 这是插件的主类文件，负责初始化和配置Psalm插件。

启动流程

1. 安装插件: 使用Composer安装插件。

   composer require --dev psalm/plugin-symfony
   

2. 初始化Psalm: 初始化Psalm配置文件。

   vendor/bin/psalm --init
   

3. 启用插件: 启用Symfony插件。

   vendor/bin/psalm-plugin enable psalm/plugin-symfony
   

3. 项目配置文件介绍

配置文件

• psalm.xml: Psalm静态分析配置文件，包含插件的配置。

配置示例

<psalm errorLevel="1">
    <!-- 项目配置 -->
    <plugins>
        <pluginClass class="Psalm\SymfonyPsalmPlugin\Plugin" />
    </plugins>
</psalm>

详细配置

• containerXml: 配置Symfony容器XML文件路径。

  <pluginClass class="Psalm\SymfonyPsalmPlugin\Plugin">
      <containerXml>var/cache/dev/App_KernelDevDebugContainer.xml</containerXml>
  </pluginClass>
  

• symfonyMajorVersion: 配置Symfony主版本号。

  <pluginClass class="Psalm\SymfonyPsalmPlugin\Plugin">
      <symfonyMajorVersion>6</symfonyMajorVersion>
  </pluginClass>
  

• twigCachePath: 配置Twig缓存路径（用于Twig模板分析）。

  <pluginClass class="Psalm\SymfonyPsalmPlugin\Plugin">
      <twigCachePath>/cache/twig</twigCachePath>
  </pluginClass>
  

通过以上配置，可以确保Psalm插件正确识别Symfony项目的结构和配置，从而提供更准确的静态分析结果。

psalm-plugin-symfony Psalm Plugin for Symfony 项目地址: https://gitcode.com/gh_mirrors/ps/psalm-plugin-symfony