Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/mralaminahamed/phpstan-freemius-stubs

Freemius (WordPress SDK) function and class declaration stubs for static analysis
https://github.com/mralaminahamed/phpstan-freemius-stubs

freemius freemius-library phpstan phpstan-extension wordpress-development

Last synced: 7 days ago
JSON representation

Freemius (WordPress SDK) function and class declaration stubs for static analysis

Host: GitHub
URL: https://github.com/mralaminahamed/phpstan-freemius-stubs
Owner: mralaminahamed
License: mit
Created: 2024-05-11T13:47:23.000Z (5 months ago)
Default Branch: main
Last Pushed: 2024-09-10T15:42:11.000Z (23 days ago)
Last Synced: 2024-09-17T23:04:13.569Z (16 days ago)
Topics: freemius, freemius-library, phpstan, phpstan-extension, wordpress-development
Language: PHP
Homepage: https://github.com/mralaminahamed/phpstan-freemius-stubs
Size: 511 KB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # Freemius (WordPress SDK) Stubs

[![Packagist stats](https://img.shields.io/packagist/dt/mralaminahamed/freemius-stubs.svg)](https://packagist.org/packages/mralaminahamed/freemius-stubs/stats)

[![Packagist](https://img.shields.io/packagist/v/mralaminahamed/freemius-stubs.svg?color=4CC61E&style=popout)](https://packagist.org/packages/mralaminahamed/freemius-stubs)

[![Tweet](https://img.shields.io/badge/Tweet-share-d5d5d5?style=social&logo=twitter)](https://twitter.com/intent/tweet?text=https%3A%2F%2Fgithub.com%2Fmralaminahamed%2Fphpstan-freemius-stubs&url=I%20use%20mralaminahamed%2Fphpstan-freemius-stubs%20for%20IDE%20completion%20and%20static%20analysis)

This package provides stub declarations for the [Freemius WordPress SDK plugin](https://github.com/freemius/wordpress-sdk)

functions, classes and interfaces.

These stubs can help plugin and theme developers leverage IDE completion

and static analysis tools like [PHPStan](https://github.com/phpstan/phpstan).

The stubs are generated directly from the [source](https://github.com/freemius/wordpress-sdk)

using [php-stubs/generator](https://github.com/php-stubs/generator).

## Requirements

- PHP >=7.1

## Installation

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

```bash

composer require --dev mralaminahamed/freemius-stubs

```

Alternatively you may download `freemius-stubs.php` directly.

## Usage in PHPStan

Include stubs in PHPStan configuration file.

```yaml

parameters:

    bootstrapFiles:

        - vendor/mralaminahamed/freemius-stubs/freemius-constants-stubs.php

        - vendor/mralaminahamed/freemius-stubs/freemius-stubs.php

```