PHPStorm PHPStan 插件使用教程

PHPStorm PHPStan 插件使用教程

phpstorm-phpstan-plugin PHPStan plugin for PhpStorm 项目地址: https://gitcode.com/gh_mirrors/ph/phpstorm-phpstan-plugin

1. 项目目录结构及介绍

phpstorm-phpstan-plugin/
├── resources/
├── src/
├── testData/
├── tests/
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── intellij-phpstan.iml
├── plugin-content.yaml

目录结构说明

• resources/: 存放插件的资源文件。
• src/: 插件的主要源代码目录。
• testData/: 测试数据文件。
• tests/: 测试代码目录。
• CODE_OF_CONDUCT.md: 项目的行为准则。
• CONTRIBUTING.md: 贡献指南。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍和使用说明。
• intellij-phpstan.iml: IntelliJ IDEA 项目文件。
• plugin-content.yaml: 插件配置文件。

2. 项目的启动文件介绍

在 src/ 目录下，主要的启动文件是 PhpStanPlugin.kt，该文件是插件的入口点，负责初始化和加载插件的主要功能。

// src/PhpStanPlugin.kt
package com.jetbrains.php.phpstan

import com.intellij.openapi.project.Project
import com.intellij.openapi.startup.StartupActivity

class PhpStanPlugin : StartupActivity {
    override fun runActivity(project: Project) {
        // 插件启动时执行的初始化代码
    }
}

3. 项目的配置文件介绍

plugin-content.yaml

plugin-content.yaml 是插件的主要配置文件，定义了插件的功能和行为。

# plugin-content.yaml
name: "PHPStan Plugin"
version: "1.0.0"
description: "PHPStan plugin for PhpStorm"
vendor:
  name: "JetBrains"
  url: "https://www.jetbrains.com"
extensions:
  - com.jetbrains.php.phpstan.PhpStanInspection
  - com.jetbrains.php.phpstan.PhpStanSettings

composer.json

虽然 composer.json 不是项目本身的文件，但它是 PHP 项目中常见的配置文件，用于管理项目的依赖和配置。

{
  "name": "jetbrains/phpstorm-phpstan-plugin",
  "description": "PHPStan plugin for PhpStorm",
  "type": "library",
  "license": "Apache-2.0",
  "require": {
    "php": "^7.4 || ^8.0",
    "phpstan/phpstan": "^1.0"
  },
  "autoload": {
    "psr-4": {
      "JetBrains\\PhpStorm\\PhpStan\\": "src/"
    }
  }
}

通过以上配置文件，可以了解插件的基本功能和依赖关系。

phpstorm-phpstan-plugin PHPStan plugin for PhpStorm 项目地址: https://gitcode.com/gh_mirrors/ph/phpstorm-phpstan-plugin