Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/php-stubs/wp-cli-stubs

WP-CLI function and class declaration stubs for static analysis.
https://github.com/php-stubs/wp-cli-stubs

Last synced: about 2 months ago
JSON representation

WP-CLI function and class declaration stubs for static analysis.

Host: GitHub
URL: https://github.com/php-stubs/wp-cli-stubs
Owner: php-stubs
License: mit
Created: 2020-08-03T11:50:42.000Z (about 4 years ago)
Default Branch: master
Last Pushed: 2024-07-30T02:38:17.000Z (about 2 months ago)
Last Synced: 2024-07-31T07:00:48.390Z (about 2 months ago)
Language: PHP
Homepage: https://packagist.org/packages/php-stubs/wp-cli-stubs
Size: 708 KB
Stars: 20
Watchers: 4
Forks: 2
Open Issues: 3
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # WP-CLI Stubs

[![Build Status](https://app.travis-ci.com/php-stubs/wp-cli-stubs.svg?branch=master)](https://app.travis-ci.com/php-stubs/wp-cli-stubs)

This package provides stub declarations for [WP-CLI](https://wp-cli.org/) functions, classes and interfaces.

These stubs can help plugin and theme developers leverage static analysis tools like [PHPStan](https://github.com/phpstan/phpstan), which are unable to parse WP-CLI as it is not clean OOP code.

Stubs are generated directly from the [source](https://wp-cli.org/) using [giacocorsiglia/stubs-generator](https://github.com/GiacoCorsiglia/php-stubs-generator).

### Requirements

- PHP >=7.1

### Installation

Require this package as a development dependency with [Composer](https://getcomposer.org).

```bash

composer require --dev php-stubs/wp-cli-stubs

```

Alternatively you may download `wp-cli-stubs.php` directly.

### Usage in PHPStan

Include all stubs in PHPStan configuration file.

```yaml

parameters:

    scanFiles:

        - %rootDir%/../../php-stubs/wordpress-stubs/wordpress-stubs.php

        - %rootDir%/../../php-stubs/wp-cli-stubs/wp-cli-stubs.php

        - %rootDir%/../../php-stubs/wp-cli-stubs/wp-cli-commands-stubs.php

        - %rootDir%/../../php-stubs/wp-cli-stubs/wp-cli-i18n-stubs.php

        - %rootDir%/../../php-stubs/wp-cli-stubs/wp-cli-tools.php

```