README

⚗️ 关于 OcStan

为 Laravel 添加静态类型以提高开发效率和代码质量
支持 Laravel 大多数的 美丽魔法
支持 OctoberCMS 大多数的 美丽魔法
不运行代码即可发现代码中的错误

✨ 3 步开始使用

需求

PHP 7.2+
Laravel 6.0+

1：首先，您可以使用 Composer 将 Larastan 作为开发依赖项安装到您的 Laravel 项目中

composer require --dev lemax10/ocstan

使用 Larastan 分析 Laravel 扩展包？您可能需要安装 orchestra/testbench。

2：然后，在应用根目录创建一个 phpstan.neon 或 phpstan.neon.dist 文件。它可能看起来像这样

includes:
    - ./vendor/lemax10/ocstan/extension.neon

parameters:

    paths:
        - app

    # The level 8 is the highest level
    level: 4

    ignoreErrors:
        - '#Unsafe usage of new static#'

    excludePaths:
        - ./*/*/FileToBeExcluded.php

    checkMissingIterableValueType: false

有关所有可用选项，请参阅 PHPStan 文档： https://phpstan.org/config-reference

3：最后，您可以使用 phpstan 控制台命令开始分析您的代码

./vendor/bin/phpstan analyse

如果您遇到错误 Allowed memory size exhausted，则可以使用 --memory-limit 选项解决问题

./vendor/bin/phpstan analyse --memory-limit=2G

规则

有关特定于 Laravel 的可配置规则的列表，请参阅此处。

自定义 PHPDoc 类型

有关特定于 Larastan 的 PHPDoc 类型的列表，请参阅此处。

自定义 PHPStan 配置参数

您可以在 PHPStan 配置文件中使用以下自定义配置参数的列表，请参阅此处。

要忽略的错误

由于 Laravel 的某些部分目前对 Larastan/PHPStan 来说过于神奇，因此我们列出了常见的错误要忽略，根据需要添加。

👊🏻 贡献

感谢您考虑为 Larastan 做出贡献。所有贡献指南都可在此处找到。

您可以通过查看变更日志来了解持续更新和关于更改的详细信息。您还可以关注 Twitter 账户以获取最新的公告或只是打个招呼！：@enunomaduro，@can__vural。

❤️ 支持开发

您喜欢这个项目吗？通过捐赠来支持它

PayPal: 捐赠
Patreon: 捐赠

📖 许可证

OCStan 是一个开源软件，根据 MIT 许可证许可。Larastan 是一个开源软件，根据 MIT 许可证许可。

lemax10 / ocstan

维护者

详细信息