Ecosyste.ms: Awesome

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

https://github.com/tomzx/php-semver-checker

Compares two source sets and determines the appropriate semantic versioning to apply.
https://github.com/tomzx/php-semver-checker

analyzer inspection php ruleset semver

Last synced: 18 days ago
JSON representation

Compares two source sets and determines the appropriate semantic versioning to apply.

Host: GitHub
URL: https://github.com/tomzx/php-semver-checker
Owner: tomzx
License: mit
Created: 2015-01-09T14:10:36.000Z (over 9 years ago)
Default Branch: master
Last Pushed: 2023-09-18T09:16:00.000Z (8 months ago)
Last Synced: 2024-04-03T04:24:00.111Z (about 2 months ago)
Topics: analyzer, inspection, php, ruleset, semver
Language: PHP
Homepage:
Size: 437 KB
Stars: 424
Watchers: 15
Forks: 28
Open Issues: 41
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Lists

awesome-php - PHP Semantic Versioning Checker - A command line utility that compares two source sets and determines the appropriate semantic versioning to apply. (Table of Contents / Code Analysis)
awesome-projects - PHP Semantic Versioning Checker - A command line utility that compares two source sets and determines the appropriate semantic versioning to apply. (PHP / Code Analysis)
awesome-php-zh_CN - PHP Semantic Versioning Checker - 一个比较两个源集和确定适当的应用语义版本的命令行实用程序 (代码分析 Code Analysis)
static-analysis - PHP Semantic Versioning Checker
awesome-php-cn - PHP Semantic Versioning Checker - 一个命令行实用程序,比较两组源,并确定适当的语义版本控制应用. (目录 / 代码分析 Code Analysis)
awesome-php - php-semver-checker - 一个版本对比的命令行工具 (代码分析( Code Analysis ))
awesome-php - PHP Semantic Versioning Checker - A command line utility that compares two source sets and determines the appropriate semantic versioning to apply. (Code Analysis)
awesome-php - PHP Semantic Versioning Checker - A command line utility that compares two source sets and determines the appropriate semantic versioning to apply. (Table of Contents / Code Analysis)
awesome-php - php-semver-checker - 一个版本对比的命令行工具 (URL)
awesome-php-new - PHP Semantic Versioning Checker - A command line utility that compares two source sets and determines the appropriate semantic versioning to apply. (Table of Contents / Code Analysis)
awesome-php - PHP Semantic Versioning Checker - A command line utility that compares two source sets and determines the appropriate semantic versioning to apply. (Code Analysis)
awesome-php - PHP Semantic Versioning Checker - A command line utility that compares two source sets and determines the appropriate semantic versioning to apply. (Table of Contents / Code Analysis)
awesome-php - PHP Semantic Versioning Checker - A command line utility that compares two source sets and determines the appropriate semantic versioning to apply. (Table of Contents / Code Analysis)
awesome-php - php-semver-checker - 一个版本对比的命令行工具 (代码分析( Code Analysis ))
PHP_awesome-directus-duh-REKT-iss- - PHP Semantic Versioning Checker - A command line utility that compares two source sets and determines the appropriate semantic versioning to apply. (Table of Contents / Code Analysis)
awesome-php-static-analysis - PHP Semantic Versioning Checker
awesome-stripe - PHP Semantic Versioning Checker - A command line utility that compares two source sets and determines the appropriate semantic versioning to apply. (Table of Contents / Code Analysis)
awesome-php - PHP Semantic Versioning Checker - A command line utility that compares two source sets and determines the appropriate semantic versioning to apply. (Table of Contents / Code Analysis)
awesome-stars - php-semver-checker
awesome-php - PHP Semantic Versioning Checker - A command line utility that compares two source sets and determines the appropriate semantic versioning to apply. (Table of Contents / Code Analysis)
awesome-php - PHP Semantic Versioning Checker - A command line utility that compares two source sets and determines the appropriate semantic versioning to apply. (Table of Contents / Code Analysis)

README

        # PHP Semantic Versioning Checker

[![License](https://poser.pugx.org/tomzx/php-semver-checker/license.svg)](https://packagist.org/packages/tomzx/php-semver-checker)

[![Latest Stable Version](https://poser.pugx.org/tomzx/php-semver-checker/v/stable.svg)](https://packagist.org/packages/tomzx/php-semver-checker)

[![Latest Unstable Version](https://poser.pugx.org/tomzx/php-semver-checker/v/unstable.svg)](https://packagist.org/packages/tomzx/php-semver-checker)

[![Build Status](https://img.shields.io/github/workflow/status/tomzx/php-semver-checker/Continuous%20integration.svg)](https://github.com/tomzx/php-semver-checker/actions?query=workflow%3A%22Continuous+integration%22)

[![Code Coverage](https://img.shields.io/codecov/c/github/tomzx/php-semver-checker)](https://app.codecov.io/gh/tomzx/php-semver-checker/)

[![Total Downloads](https://img.shields.io/packagist/dt/tomzx/php-semver-checker.svg)](https://packagist.org/packages/tomzx/php-semver-checker)

PHP Semantic Versioning Checker is a console/library which allows you to inspect a set of before and after source code.

After the inspection is completed, you are given a list of changes that have occurred between the two changesets following [Semantic Versioning 2.0.0](https://semver.org/). For each of these changes, the level of the change (MAJOR, MINOR, PATCH) will be given, as well as the location of the change (file and line number) and a reason as to why this level change is suggested.

## For continuous integration

If you'd like to use `php-semver-checker` in your CI pipeline, we recommend you look at

[`php-semver-checker-git`](https://github.com/tomzx/php-semver-checker-git) which integrates with Git and will compare

your latest changes with the latest Git tag of your repository.

## Semantic Versioning 2.0.0 Overview

Given a version number MAJOR.MINOR.PATCH, increment the:

* MAJOR version when you make incompatible API changes,

* MINOR version when you add functionality in a backwards-compatible manner, and

* PATCH version when you make backwards-compatible bug fixes.

## Getting started

As this is still an alpha package, it is not suggested to include `php-semver-checker` directly in your composer.json. There are however a couple ways to use the tool:

1. **Preferred method** Download the [latest .phar build](http://psvc.coreteks.org/php-semver-checker.phar). Note that the .phar build is generally less bleeding edge than the following methods.

2. `php composer.phar create-project tomzx/php-semver-checker --stability=dev` will clone to a new php-semver-checker folder in your current working directory

3. `git clone https://github.com/tomzx/php-semver-checker.git` and `php composer.phar install` in the newly cloned directory.

See the example section for examples of how to use the tool.

### Building `php-semver-checker.phar`

First, make sure you have [box](https://github.com/box-project/box2) installed. Then, in the base directory, you can run the following command which will generate the `php-semver-checker.phar` file.

```

box build

```

## Current ruleset & verification codes

See [`docs/Ruleset.md`](docs/Ruleset.md) for an exhaustive list of currently supported (and to come) ruleset.

Verification codes are a mean to uniquely identify a semantic versioning trigger (a condition which upon detection, requires your code changes to be versioned).

## Example

```bash

php bin/php-semver-checker compare tests/fixtures/before tests/fixtures/after

Suggested semantic versioning change: MAJOR

Class (MAJOR) 
+-------+------------------------------------------------ 
| Level | Location 
+-------+------------------------------------------------ 
| MAJOR | tests\fixtures\before\ClassRemoved.php:5 
| MAJOR | tests\fixtures\after\ClassMethodAdded.php:7 
| MAJOR | tests\fixtures\after\ClassMethodAdded.php:12 
| MAJOR | tests\fixtures\after\ClassMethodParameterChanged.php:7 
| MAJOR | tests\fixtures\after\ClassMethodParameterChanged.php:12 
| MAJOR | tests\fixtures\before\ClassMethodRemoved.php:7 
| MAJOR | tests\fixtures\before\ClassMethodRemoved.php:12 
| MAJOR | tests\fixtures\after\ClassPropertyAdded.php:7 
| MAJOR | tests\fixtures\after\ClassPropertyAdded.php:9 
| MAJOR | tests\fixtures\before\ClassPropertyRemoved.php:7 
| MAJOR | tests\fixtures\before\ClassPropertyRemoved.php:9 
| MINOR | tests\fixtures\after\ClassAdded.php:5 
| PATCH | tests\fixtures\after\ClassMethodAdded.php:17 
| PATCH | tests\fixtures\after\ClassMethodImplementationChanged.php:7 
| PATCH | tests\fixtures\after\ClassMethodImplementationChanged.php:12 
| PATCH | tests\fixtures\after\ClassMethodImplementationChanged.php:17 
| PATCH | tests\fixtures\after\ClassMethodParameterChanged.php:17 
| PATCH | tests\fixtures\after\ClassMethodParameterNameChanged.php:7 
| PATCH | tests\fixtures\after\ClassMethodParameterNameChanged.php:12 
| PATCH | tests\fixtures\after\ClassMethodParameterNameChanged.php:17 
| PATCH | tests\fixtures\before\ClassMethodRemoved.php:17 
| PATCH | tests\fixtures\after\ClassPropertyAdded.php:11 
| PATCH | tests\fixtures\before\ClassPropertyRemoved.php:11 
+-------+------------------------------------------------

--------------+------------------------------------------------------------+--------------------------------------------+------+ | Target                                                     | Reason                                     | Code | --------------+------------------------------------------------------------+--------------------------------------------+------+ | fixtures\ClassRemoved                                      | Class was removed.                         | V005 | | fixtures\ClassMethodAdded::publicMethod                    | [public] Method has been added.            | V015 | | fixtures\ClassMethodAdded::protectedMethod                 | [protected] Method has been added.         | V016 | | fixtures\ClassMethodParameterChanged::publicMethod         | [public] Method parameter changed.         | V010 | | fixtures\ClassMethodParameterChanged::protectedMethod      | [protected] Method parameter changed.      | V011 | | fixtures\ClassMethodRemoved::publicMethod                  | [public] Method has been removed.          | V006 | | fixtures\ClassMethodRemoved::protectedMethod               | [protected] Method has been removed.       | V007 | | fixtures\ClassPropertyAdded::$a                            | [public] Property has been added.          | V019 | | fixtures\ClassPropertyAdded::$b                            | [protected] Property has been added.       | V020 | | fixtures\ClassPropertyRemoved::$a                          | [public] Property has been removed.        | V008 | | fixtures\ClassPropertyRemoved::$b                          | [protected] Property has been removed.     | V009 | | fixtures\ClassAdded                                        | Class was added.                           | V014 | | fixtures\ClassMethodAdded::privateMethod                   | [private] Method has been added.           | V028 | | fixtures\ClassMethodImplementationChanged::publicMethod    | [public] Method implementation changed.    | V023 | | fixtures\ClassMethodImplementationChanged::protectedMethod | [protected] Method implementation changed. | V024 | | fixtures\ClassMethodImplementationChanged::privateMethod   | [private] Method implementation changed.   | V025 | | fixtures\ClassMethodParameterChanged::privateMethod        | [private] Method parameter changed.        | V031 | | fixtures\ClassMethodParameterNameChanged::publicMethod     | [public] Method parameter name changed.    | V060 | | fixtures\ClassMethodParameterNameChanged::protectedMethod  | [protected] Method parameter name changed. | V061 | | fixtures\ClassMethodParameterNameChanged::privateMethod    | [private] Method parameter name changed.   | V062 | | fixtures\ClassMethodRemoved::privateMethod                 | [private] Method has been removed.         | V029 | | fixtures\ClassPropertyAdded::$c                            | [private] Property has been added.         | V026 | | fixtures\ClassPropertyRemoved::$c                          | [private] Property has been removed.       | V027 | --------------+------------------------------------------------------------+--------------------------------------------+------+

Function (MAJOR)

+-------+----------------------------------------------------------+-----------------------------------------------------------------------+----------------------------------+------+

| Level | Location                                                 | Target                                                                | Reason                           | Code |

+-------+----------------------------------------------------------+-----------------------------------------------------------------------+----------------------------------+------+

| MAJOR | tests\fixtures\before\FunctionRemoved.php:5              | fixtures\functionRemoved::functionRemoved                             | Function has been removed.       | V001 |

| MAJOR | tests\fixtures\before\FunctionParameterChanged.php:5     | fixtures\functionParameterChanged::functionParameterChanged           | Function parameter changed.      | V002 |

| MINOR | tests\fixtures\after\FunctionAdded.php:5                 | fixtures\functionAdded::functionAdded                                 | Function has been added.         | V003 |

| PATCH | tests\fixtures\after\FunctionImplementationChanged.php:5 | fixtures\functionImplementationChanged::functionImplementationChanged | Function implementation changed. | V004 |

| PATCH | tests\fixtures\before\FunctionParameterNameChanged.php:5 | fixtures\functionParameterNameChanged::functionParameterNameChanged   | Function parameter name changed. | V067 |

+-------+----------------------------------------------------------+-----------------------------------------------------------------------+----------------------------------+------+

Interface (MAJOR)

+-------+---------------------------------------------------------------+------------------------------------------------------------+-----------------------------------------+------+

| Level | Location                                                      | Target                                                     | Reason                                  | Code |

+-------+---------------------------------------------------------------+------------------------------------------------------------+-----------------------------------------+------+

| MAJOR | tests\fixtures\before\InterfaceRemoved.php:5                  | fixtures\InterfaceRemoved                                  | Interface was removed.                  | V033 |

| MAJOR | tests\fixtures\after\InterfaceMethodAdded.php:7               | fixtures\InterfaceMethodAdded::newMethod                   | [public] Method has been added.         | V034 |

| MAJOR | tests\fixtures\after\InterfaceMethodParameterChaged.php:7     | fixtures\InterfaceMethodParameterChanged::newMethod        | [public] Method parameter changed.      | V036 |

| MAJOR | tests\fixtures\before\InterfaceMethodRemoved.php:7            | fixtures\InterfaceMethodRemoved::newMethod                 | [public] Method has been removed.       | V035 |

| MINOR | tests\fixtures\after\InterfaceAdded.php:5                     | fixtures\InterfaceAdded                                    | Interface was added.                    | V032 |

| PATCH | tests\fixtures\after\InterfaceMethodParameterNameChaged.php:7 | fixtures\InterfaceMethodParameterNameChanged::publicMethod | [public] Method parameter name changed. | V063 |

+-------+---------------------------------------------------------------+------------------------------------------------------------+-----------------------------------------+------+

Trait (MAJOR)

+-------+--------------------------------------------------------------+------------------------------------------------------------+--------------------------------------------+------+

| Level | Location                                                     | Target                                                     | Reason                                     | Code |

+-------+--------------------------------------------------------------+------------------------------------------------------------+--------------------------------------------+------+

| MAJOR | tests\fixtures\before\TraitRemoved.php:5                     | fixtures\TraitRemoved                                      | Trait was removed.                         | V037 |

| MAJOR | tests\fixtures\after\TraitMethodAdded.php:7                  | fixtures\TraitMethodAdded::publicMethod                    | [public] Method has been added.            | V047 |

| MAJOR | tests\fixtures\after\TraitMethodAdded.php:12                 | fixtures\TraitMethodAdded::protectedMethod                 | [protected] Method has been added.         | V048 |

| MAJOR | tests\fixtures\after\TraitMethodAdded.php:17                 | fixtures\TraitMethodAdded::privateMethod                   | [private] Method has been added.           | V057 |

| MAJOR | tests\fixtures\after\TraitMethodParameterChanged.php:7       | fixtures\TraitMethodParameterChanged::publicMethod         | [public] Method parameter changed.         | V042 |

| MAJOR | tests\fixtures\after\TraitMethodParameterChanged.php:12      | fixtures\TraitMethodParameterChanged::protectedMethod      | [protected] Method parameter changed.      | V043 |

| MAJOR | tests\fixtures\after\TraitMethodParameterChanged.php:17      | fixtures\TraitMethodParameterChanged::privateMethod        | [private] Method parameter changed.        | V059 |

| MAJOR | tests\fixtures\before\TraitMethodRemoved.php:7               | fixtures\TraitMethodRemoved::publicMethod                  | [public] Method has been removed.          | V038 |

| MAJOR | tests\fixtures\before\TraitMethodRemoved.php:12              | fixtures\TraitMethodRemoved::protectedMethod               | [protected] Method has been removed.       | V039 |

| MAJOR | tests\fixtures\before\TraitMethodRemoved.php:17              | fixtures\TraitMethodRemoved::privateMethod                 | [private] Method has been removed.         | V058 |

| MAJOR | tests\fixtures\after\TraitPropertyAdded.php:7                | fixtures\TraitPropertyAdded::$a                            | [public] Property has been added.          | V049 |

| MAJOR | tests\fixtures\after\TraitPropertyAdded.php:9                | fixtures\TraitPropertyAdded::$b                            | [protected] Property has been added.       | V050 |

| MAJOR | tests\fixtures\after\TraitPropertyAdded.php:11               | fixtures\TraitPropertyAdded::$c                            | [private] Property has been added.         | V055 |

| MAJOR | tests\fixtures\before\TraitPropertyRemoved.php:7             | fixtures\TraitPropertyRemoved::$a                          | [public] Property has been removed.        | V040 |

| MAJOR | tests\fixtures\before\TraitPropertyRemoved.php:9             | fixtures\TraitPropertyRemoved::$b                          | [protected] Property has been removed.     | V041 |

| MAJOR | tests\fixtures\before\TraitPropertyRemoved.php:11            | fixtures\TraitPropertyRemoved::$c                          | [private] Property has been removed.       | V056 |

| MINOR | tests\fixtures\after\TraitAdded.php:5                        | fixtures\TraitAdded                                        | Trait was added.                           | V046 |

| PATCH | tests\fixtures\after\TraitMethodImplementationChanged.php:7  | fixtures\TraitMethodImplementationChanged::publicMethod    | [public] Method implementation changed.    | V052 |

| PATCH | tests\fixtures\after\TraitMethodImplementationChanged.php:12 | fixtures\TraitMethodImplementationChanged::protectedMethod | [protected] Method implementation changed. | V053 |

| PATCH | tests\fixtures\after\TraitMethodImplementationChanged.php:17 | fixtures\TraitMethodImplementationChanged::privateMethod   | [private] Method implementation changed.   | V054 |

| PATCH | tests\fixtures\after\TraitMethodParameterNameChanged.php:7   | fixtures\TraitMethodParameterNameChanged::publicMethod     | [public] Method parameter name changed.    | V064 |

| PATCH | tests\fixtures\after\TraitMethodParameterNameChanged.php:12  | fixtures\TraitMethodParameterNameChanged::protectedMethod  | [protected] Method parameter name changed. | V065 |

| PATCH | tests\fixtures\after\TraitMethodParameterNameChanged.php:17  | fixtures\TraitMethodParameterNameChanged::privateMethod    | [private] Method parameter name changed.   | V066 |

+-------+--------------------------------------------------------------+------------------------------------------------------------+--------------------------------------------+------+

[Scanned files] Before: 26, After: 27, Identical: 0

Time: 1.43 seconds, Memory: 5.123 MB

```

## Contributing

### Adding new rules

* Add the rules to the `docs/Ruleset.md` document

* Run `php scripts/extract-rules-from-ruleset.php` to generate an up to date array to paste in the `Configuration/LevelMapping.php` file

* Update the documentation @ https://github.com/tomzx/php-semver-checker-docs

## License

The code is licensed under the [MIT license](http://choosealicense.com/licenses/mit/). See [LICENSE](LICENSE).